view mod_measure_active_users/README.md @ 4974:807007913f67

mod_log_json: Prefer native Lua table.pack over Prosody util.table one Prosody is removing support for Lua 5.1, which was the reason for util.table.pack to exist in the first place, since Lua 5.2+ provides table.pack. In prosody rev 5eaf77114fdb everything was switched over to use table.pack, opening the door for removing util.table.pack at some point. This change here is to prepare for that future eventuality.
author Kim Alvefur <zash@zash.se>
date Mon, 11 Jul 2022 20:08:41 +0200
parents 1132f2888cd2
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: 'Measure number of daily, weekly and monthly active users'
...

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

This module calculates the number of daily, weekly and monthly active users -
often abbreviated as DAU, WAU and MAU.

These metrics are more accurate for determining how many people are actually
using a service. For example simply counting registered accounts will typically
include many dormant accounts that aren't really being used. Many servers also
track the number of connected users. This is a useful metric for many purposes,
but it is generally lower than the actual number of users - because some users
may only connect at certain times of day.

The module defines "activity" as any login/logout event during the time period,
and for this it depends on mod_lastlog2 being loaded (it reads the data stored
by mod_lastlog2). Each individual user is only counted once.

"Daily" means any event within the past 24 hours, "weekly" means within the
past 7 days, and "monthly" means within the past 30 days.

Details
=======

The user count is calculated shortly after startup, and then recalculated
hourly after that.

Metrics are exported using Prosody's built-in statistics API.

There is no configuration for this module.

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

Requires Prosody 0.11 or later with mod_lastlog2 enabled.