Mercurial > prosody-modules

comparison mod_measure_active_users/README.md @ 4774:1132f2888cd2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_measure_active_users: Calculate active user counts over fixed time periods
author Matthew Wild <mwild1@gmail.com>
date Wed, 17 Nov 2021 13:35:00 +0000
parents
children
comparison
equal deleted inserted replaced
4773:eb63890ae8fc 4774:1132f2888cd2
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: 'Measure number of daily, weekly and monthly active users'
5 ...
6
7 Introduction
8 ============
9
10 This module calculates the number of daily, weekly and monthly active users -
11 often abbreviated as DAU, WAU and MAU.
12
13 These metrics are more accurate for determining how many people are actually
14 using a service. For example simply counting registered accounts will typically
15 include many dormant accounts that aren't really being used. Many servers also
16 track the number of connected users. This is a useful metric for many purposes,
17 but it is generally lower than the actual number of users - because some users
18 may only connect at certain times of day.
19
20 The module defines "activity" as any login/logout event during the time period,
21 and for this it depends on mod_lastlog2 being loaded (it reads the data stored
22 by mod_lastlog2). Each individual user is only counted once.
23
24 "Daily" means any event within the past 24 hours, "weekly" means within the
25 past 7 days, and "monthly" means within the past 30 days.
26
27 Details
28 =======
29
30 The user count is calculated shortly after startup, and then recalculated
31 hourly after that.
32
33 Metrics are exported using Prosody's built-in statistics API.
34
35 There is no configuration for this module.
36
37 Compatibility
38 =============
39
40 Requires Prosody 0.11 or later with mod_lastlog2 enabled.