Mercurial > prosody-modules
annotate mod_reminders/README.md @ 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 | a938df1f60de |
children |
rev | line source |
---|---|
3917
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
1 --- |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
2 labels: |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
3 - 'Stage-alpha' |
4736
a938df1f60de
mod_reminders: Fix README metadata syntax
Kim Alvefur <zash@zash.se>
parents:
3917
diff
changeset
|
4 summary: 'Enable ProtoXEP: Reminders support' |
3917
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
5 ... |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
6 |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
7 |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
8 Introduction |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
9 ============ |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
10 |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
11 `mod_reminders` implements ProtoXEP: Reminders. |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
12 |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
13 Usage |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
14 ===== |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
15 |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
16 Place the sibling `mod_reminders.lua` somewhere under your |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
17 `plugins_path`. |
3e19c25ff93e
mod_reminders: Initial commit for supporting Reminders ProtoXEP
marc0s <marcos.devera@quobis.com>
parents:
diff
changeset
|
18 |