Mercurial > prosody-hg
annotate plugins/mod_uptime.lua @ 11523:5f15ab7c6ae5
Statistics: Rewrite statistics backends to use OpenMetrics
The metric subsystem of Prosody has had some shortcomings from
the perspective of the current state-of-the-art in metric
observability.
The OpenMetrics standard [0] is a formalization of the data
model (and serialization format) of the well-known and
widely-used Prometheus [1] software stack.
The previous stats subsystem of Prosody did not map well to that
format (see e.g. [2] and [3]); the key reason is that it was
trying to do too much math on its own ([2]) while lacking
first-class support for "families" of metrics ([3]) and
structured metric metadata (despite the `extra` argument to
metrics, there was no standard way of representing common things
like "tags" or "labels").
Even though OpenMetrics has grown from the Prometheus world of
monitoring, it maps well to other popular monitoring stacks
such as:
- InfluxDB (labels can be mapped to tags and fields as necessary)
- Carbon/Graphite (labels can be attached to the metric name with
dot-separation)
- StatsD (see graphite when assuming that graphite is used as
backend, which is the default)
The util.statsd module has been ported to use the OpenMetrics
model as a proof of concept. An implementation which exposes
the util.statistics backend data as Prometheus metrics is
ready for publishing in prosody-modules (most likely as
mod_openmetrics_prometheus to avoid breaking existing 0.11
deployments).
At the same time, the previous measure()-based API had one major
advantage: It is really simple and easy to use without requiring
lots of knowledge about OpenMetrics or similar concepts. For that
reason as well as compatibility with existing code, it is preserved
and may even be extended in the future.
However, code relying on the `stats-updated` event as well as
`get_stats` from `statsmanager` will break because the data
model has changed completely; in case of `stats-updated`, the
code will simply not run (as the event was renamed in order
to avoid conflicts); the `get_stats` function has been removed
completely (so it will cause a traceback when it is attempted
to be used).
Note that the measure_*_event methods have been removed from
the module API. I was unable to find any uses or documentation
and thus deemed they should not be ported. Re-implementation is
possible when necessary.
[0]: https://openmetrics.io/
[1]: https://prometheus.io/
[2]: #959
[3]: #960
| author | Jonas Schäfer <jonas@wielicki.name> |
|---|---|
| date | Sun, 18 Apr 2021 11:47:41 +0200 |
| parents | abbdf72b0710 |
| children | 74b9e05af71e |
| rev | line source |
|---|---|
|
1523
841d61be198f
Remove version number from copyright headers
Matthew Wild <mwild1@gmail.com>
parents:
1495
diff
changeset
|
1 -- Prosody IM |
|
2923
b7049746bd29
Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents:
2017
diff
changeset
|
2 -- Copyright (C) 2008-2010 Matthew Wild |
|
b7049746bd29
Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents:
2017
diff
changeset
|
3 -- Copyright (C) 2008-2010 Waqas Hussain |
|
5776
bd0ff8ae98a8
Remove all trailing whitespace
Florian Zeitz <florob@babelmonkeys.de>
parents:
4345
diff
changeset
|
4 -- |
| 758 | 5 -- This project is MIT/X11 licensed. Please see the |
| 6 -- COPYING file in the source package for more information. | |
|
519
cccd610a0ef9
Insert copyright/license headers
Matthew Wild <mwild1@gmail.com>
parents:
438
diff
changeset
|
7 -- |
|
cccd610a0ef9
Insert copyright/license headers
Matthew Wild <mwild1@gmail.com>
parents:
438
diff
changeset
|
8 |
|
2016
5d47cfa4b2a0
mod_uptime: Removed unused variables.
Waqas Hussain <waqas20@gmail.com>
parents:
2015
diff
changeset
|
9 local st = require "util.stanza"; |
|
1494
bdfa5274e111
mod_uptime: Convert to unix line endings
Matthew Wild <mwild1@gmail.com>
parents:
896
diff
changeset
|
10 |
|
1495
6c745a108e68
mod_uptime: Use time of server start rather than module load
Matthew Wild <mwild1@gmail.com>
parents:
1494
diff
changeset
|
11 local start_time = prosody.start_time; |
|
4345
f6d694b1cdb3
mod_uptime: Use module:hook_global()
Matthew Wild <mwild1@gmail.com>
parents:
3540
diff
changeset
|
12 module:hook_global("server-started", function() start_time = prosody.start_time end); |
|
1524
a89fec6d76d2
mod_uptime: Fix bad uptime if module is loaded at startup
Matthew Wild <mwild1@gmail.com>
parents:
1523
diff
changeset
|
13 |
|
3232
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
14 -- XEP-0012: Last activity |
|
1494
bdfa5274e111
mod_uptime: Convert to unix line endings
Matthew Wild <mwild1@gmail.com>
parents:
896
diff
changeset
|
15 module:add_feature("jabber:iq:last"); |
|
bdfa5274e111
mod_uptime: Convert to unix line endings
Matthew Wild <mwild1@gmail.com>
parents:
896
diff
changeset
|
16 |
|
9226
affd84be3fc3
mod_uptime: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
8962
diff
changeset
|
17 module:hook("iq-get/host/jabber:iq:last:query", function(event) |
|
2015
2140c994671e
mod_uptime: Updated to use events (which also fixes a few minor issues).
Waqas Hussain <waqas20@gmail.com>
parents:
1524
diff
changeset
|
18 local origin, stanza = event.origin, event.stanza; |
|
10749
abbdf72b0710
mod_uptime: Encode uptime as decimal, fix #1536 (thanks Martin)
Kim Alvefur <zash@zash.se>
parents:
10565
diff
changeset
|
19 origin.send(st.reply(stanza):tag("query", {xmlns = "jabber:iq:last", seconds = tostring(("%d"):format(os.difftime(os.time(), start_time)))})); |
|
9226
affd84be3fc3
mod_uptime: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
8962
diff
changeset
|
20 return true; |
|
2015
2140c994671e
mod_uptime: Updated to use events (which also fixes a few minor issues).
Waqas Hussain <waqas20@gmail.com>
parents:
1524
diff
changeset
|
21 end); |
|
3232
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
22 |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
23 -- Ad-hoc command |
|
8962
6c06bd455bbf
mod_uptime: Depend on mod_adhoc
Kim Alvefur <zash@zash.se>
parents:
8344
diff
changeset
|
24 module:depends "adhoc"; |
|
3232
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
25 local adhoc_new = module:require "adhoc".new; |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
26 |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
27 function uptime_text() |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
28 local t = os.time()-prosody.start_time; |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
29 local seconds = t%60; |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
30 t = (t - seconds)/60; |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
31 local minutes = t%60; |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
32 t = (t - minutes)/60; |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
33 local hours = t%24; |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
34 t = (t - hours)/24; |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
35 local days = t; |
|
3540
bc139431830b
Monster whitespace commit (beware the whitespace monster).
Waqas Hussain <waqas20@gmail.com>
parents:
3232
diff
changeset
|
36 return string.format("This server has been running for %d day%s, %d hour%s and %d minute%s (since %s)", |
|
bc139431830b
Monster whitespace commit (beware the whitespace monster).
Waqas Hussain <waqas20@gmail.com>
parents:
3232
diff
changeset
|
37 days, (days ~= 1 and "s") or "", hours, (hours ~= 1 and "s") or "", |
|
3232
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
38 minutes, (minutes ~= 1 and "s") or "", os.date("%c", prosody.start_time)); |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
39 end |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
40 |
|
8344
071c0523c4cb
mod_uptime: Remove unused arguments [luacheck]
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
41 function uptime_command_handler () |
|
3232
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
42 return { info = uptime_text(), status = "completed" }; |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
43 end |
|
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
44 |
|
10565
421b2f8369fd
mod_adhoc: Improve permission setting (fix #1482) BC
Kim Alvefur <zash@zash.se>
parents:
9572
diff
changeset
|
45 local descriptor = adhoc_new("Get uptime", "uptime", uptime_command_handler, "any"); |
|
3232
c47bfd62701c
mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents:
2923
diff
changeset
|
46 |
|
9572
867e40b82409
mod_ping, mod_uptime: Use module:provides
Kim Alvefur <zash@zash.se>
parents:
9226
diff
changeset
|
47 module:provides("adhoc", descriptor); |
