view mod_lastlog2/README.markdown @ 4776:13e913471b75

mod_http_admin_api: Ensure freshness of metrics when in manual mode When in manual collection mode, as recommended for Prometheus, collection needs to be triggered manually, or they would be stale, possibly dating from the start of the server. This might vary per metric depending on how and when the metrics are gathered.
author Kim Alvefur <zash@zash.se>
date Thu, 18 Nov 2021 19:26:07 +0100
parents fd582067c732
children c5df6d53f17f
line wrap: on
line source

---
labels:
- 'Stage-Beta'
summary: Record last timestamp of events
---

# Introduction

Similar to [mod_lastlog], this module records the last timestamp of
various events, but keeps the last timestamp per type of event, instead
of the last event.

# Usage

As with all modules, copy it to your plugins directory and then add it
to the modules\_enabled list:

``` {.lua}
modules_enabled = {
  -- other modules
  "lastlog2",
}
```

# Configuration

There are some options you can add to your config file:

  Name                   Type      Default   Description
  ---------------------- --------- --------- ---------------------------------
  lastlog\_ip\_address   boolean   false     Log the IP address of the user?

# Usage

You can check a user's last activity by running:

    prosodyctl mod_lastlog username@example.com

# Compatibility

  Version   State
  --------- -------
  Any       *TBD*