http://hg.omfa.de/prosody-hg/ en-us core/statsmanager.lua revision history http://hg.omfa.de/prosody-hg/log/ead41e25ebc0/core/statsmanager.lua Kim Alvefur <zash@zash.se> Fri, 17 Mar 2023 16:23:07 +0100 http://hg.omfa.de/prosody-hg/log/76d32b2ca5eb/core/statsmanager.lua
This was a leftover from when we (or rather I) thought that the
old (now called "high-level") API would be removed. We deemed it
useful though, so let's remove that "legacy" language and make
the description more friendly.]]> Jonas Schäfer <jonas@wielicki.name> Thu, 20 May 2021 14:03:01 +0200 http://hg.omfa.de/prosody-hg/log/5f15ab7c6ae5/core/statsmanager.lua
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]]> Jonas Schäfer <jonas@wielicki.name> Sun, 18 Apr 2021 11:47:41 +0200 http://hg.omfa.de/prosody-hg/log/10d13e0554f9/core/statsmanager.lua
When set, no periodic statistics collection is done by
core.statsmanager, instead some module is expected to call collect()
when it suits. Obviously only one such module should be enabled.

Quoth jonas’
> correct way is to scrape the internal sources on each call to /metrics
> in the context of Prometheus

"manual" as opposed to "automatic", from the point of view of
statsmanager.]]> Kim Alvefur <zash@zash.se> Tue, 06 Apr 2021 23:25:15 +0200 http://hg.omfa.de/prosody-hg/log/9a3ebdd65f9c/core/statsmanager.lua
Zash> Btw, this conditional and loop, shouldn't it be covered by the timing measurement?
Zash> Isn't that where all the util.statistics work is done?
MattJ> Yeah, it should
Zash> ("the", but there's two ... which one‽)
MattJ> Yeah... not sure :)
MattJ> Processing I guess]]> Kim Alvefur <zash@zash.se> Tue, 06 Apr 2021 23:23:28 +0200 http://hg.omfa.de/prosody-hg/log/6992c4be1a19/core/statsmanager.lua Kim Alvefur <zash@zash.se> Fri, 04 Jan 2019 07:00:44 +0100 http://hg.omfa.de/prosody-hg/log/25f80afb1631/core/statsmanager.lua Kim Alvefur <zash@zash.se> Mon, 23 Dec 2019 21:27:34 +0100 http://hg.omfa.de/prosody-hg/log/7929e0fe0577/core/statsmanager.lua Kim Alvefur <zash@zash.se> Tue, 22 Jan 2019 09:21:23 +0100 http://hg.omfa.de/prosody-hg/log/4f145a9f1477/core/statsmanager.lua Kim Alvefur <zash@zash.se> Mon, 12 Sep 2016 16:08:34 +0200 http://hg.omfa.de/prosody-hg/log/4ef37ac69562/core/statsmanager.lua Matthew Wild <mwild1@gmail.com> Fri, 29 Jul 2016 13:20:02 +0100 http://hg.omfa.de/prosody-hg/log/b6f32bb3b584/core/statsmanager.lua Matthew Wild <mwild1@gmail.com> Wed, 27 Jul 2016 15:01:28 +0100 http://hg.omfa.de/prosody-hg/log/ebf2e77ac8a7/core/statsmanager.lua Matthew Wild <mwild1@gmail.com> Wed, 27 Jul 2016 14:06:10 +0100 http://hg.omfa.de/prosody-hg/log/1c8b63fe6472/core/statsmanager.lua Matthew Wild <mwild1@gmail.com> Wed, 27 Jul 2016 14:04:36 +0100 http://hg.omfa.de/prosody-hg/log/82765a4ec799/core/statsmanager.lua Matthew Wild <mwild1@gmail.com> Sun, 18 Oct 2015 21:35:21 +0100 http://hg.omfa.de/prosody-hg/log/71b5de1d830b/core/statsmanager.lua Kim Alvefur <zash@zash.se> Tue, 10 Mar 2015 16:26:25 +0100 http://hg.omfa.de/prosody-hg/log/1e749832ed3b/core/statsmanager.lua Kim Alvefur <zash@zash.se> Sun, 22 Feb 2015 18:44:48 +0100 http://hg.omfa.de/prosody-hg/log/7b2d16c14659/core/statsmanager.lua Matthew Wild <mwild1@gmail.com> Wed, 21 Jan 2015 01:26:06 +0000 http://hg.omfa.de/prosody-hg/log/6c22bec3e8d0/core/statsmanager.lua Matthew Wild <mwild1@gmail.com> Tue, 20 Jan 2015 12:33:20 +0000