view mod_lastlog/README.markdown @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents dd6313ddd3e0
children
line wrap: on
line source

---
labels:
- 'Stage-Beta'
summary: Log last login time
...

Introduction
============

Simple module that stores the timestamp of when a user logs in.

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
  "lastlog",
}
```

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?
  lastlog\_stamp\_offline   boolean false   Add timestamp to offline presence?

Usage
=====

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

    prosodyctl mod_lastlog username@example.com

Compatibility
=============

  ----- -------
  0.9   Works
  ----- -------