Mercurial > prosody-hg
annotate plugins/mod_private.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 | e2e2aa76ea31 |
| children | 74b9e05af71e |
| rev | line source |
|---|---|
|
1523
841d61be198f
Remove version number from copyright headers
Matthew Wild <mwild1@gmail.com>
parents:
896
diff
changeset
|
1 -- Prosody IM |
|
2923
b7049746bd29
Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents:
1523
diff
changeset
|
2 -- Copyright (C) 2008-2010 Matthew Wild |
|
b7049746bd29
Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents:
1523
diff
changeset
|
3 -- Copyright (C) 2008-2010 Waqas Hussain |
|
5776
bd0ff8ae98a8
Remove all trailing whitespace
Florian Zeitz <florob@babelmonkeys.de>
parents:
5500
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 |
|
cccd610a0ef9
Insert copyright/license headers
Matthew Wild <mwild1@gmail.com>
parents:
438
diff
changeset
|
9 |
|
185
a67c88ce1c6a
Added support for XEP-0049: Private XML Storage (mod_private)
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
10 local st = require "util.stanza" |
|
a67c88ce1c6a
Added support for XEP-0049: Private XML Storage (mod_private)
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
11 |
| 6343 | 12 local private_storage = module:open_store("private", "map"); |
|
185
a67c88ce1c6a
Added support for XEP-0049: Private XML Storage (mod_private)
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
13 |
|
541
3521e0851c9e
Change modules to use the new add_feature module API method.
Waqas Hussain <waqas20@gmail.com>
parents:
519
diff
changeset
|
14 module:add_feature("jabber:iq:private"); |
|
421
63be85693710
Modules now sending disco replies
Waqas Hussain <waqas20@gmail.com>
parents:
310
diff
changeset
|
15 |
|
3522
4646b5b039ca
mod_private: Updated to use the new events API. Smaller, more robust.
Waqas Hussain <waqas20@gmail.com>
parents:
3114
diff
changeset
|
16 module:hook("iq/self/jabber:iq:private:query", function(event) |
|
4646b5b039ca
mod_private: Updated to use the new events API. Smaller, more robust.
Waqas Hussain <waqas20@gmail.com>
parents:
3114
diff
changeset
|
17 local origin, stanza = event.origin, event.stanza; |
|
4646b5b039ca
mod_private: Updated to use the new events API. Smaller, more robust.
Waqas Hussain <waqas20@gmail.com>
parents:
3114
diff
changeset
|
18 local query = stanza.tags[1]; |
|
6341
ab9a1af80632
mod_private: Cleanup and more tailcalls
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
19 if #query.tags ~= 1 then |
|
6841
be87ab2d611c
plugins: Explicitly return to halt event propagation (session.send sometimes does not return true)
Kim Alvefur <zash@zash.se>
parents:
6353
diff
changeset
|
20 origin.send(st.error_reply(stanza, "modify", "bad-format")); |
|
be87ab2d611c
plugins: Explicitly return to halt event propagation (session.send sometimes does not return true)
Kim Alvefur <zash@zash.se>
parents:
6353
diff
changeset
|
21 return true; |
|
6341
ab9a1af80632
mod_private: Cleanup and more tailcalls
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
22 end |
|
ab9a1af80632
mod_private: Cleanup and more tailcalls
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
23 local tag = query.tags[1]; |
|
ab9a1af80632
mod_private: Cleanup and more tailcalls
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
24 local key = tag.name..":"..tag.attr.xmlns; |
|
ab9a1af80632
mod_private: Cleanup and more tailcalls
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
25 if stanza.attr.type == "get" then |
| 6343 | 26 local data, err = private_storage:get(origin.username, key); |
| 27 if data then | |
| 6843 | 28 origin.send(st.reply(stanza):query("jabber:iq:private"):add_child(st.deserialize(data))); |
| 6343 | 29 elseif err then |
| 6843 | 30 origin.send(st.error_reply(stanza, "wait", "internal-server-error", err)); |
|
6341
ab9a1af80632
mod_private: Cleanup and more tailcalls
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
31 else |
|
6841
be87ab2d611c
plugins: Explicitly return to halt event propagation (session.send sometimes does not return true)
Kim Alvefur <zash@zash.se>
parents:
6353
diff
changeset
|
32 origin.send(st.reply(stanza):add_child(query)); |
|
3522
4646b5b039ca
mod_private: Updated to use the new events API. Smaller, more robust.
Waqas Hussain <waqas20@gmail.com>
parents:
3114
diff
changeset
|
33 end |
| 6843 | 34 return true; |
|
9228
e2e2aa76ea31
mod_private, mod_vcard: Use the usual comment on non-get received iqs.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
6843
diff
changeset
|
35 else -- stanza.attr.type == "set" |
| 6343 | 36 local data; |
| 37 if #tag ~= 0 then | |
| 38 data = st.preserialize(tag); | |
|
185
a67c88ce1c6a
Added support for XEP-0049: Private XML Storage (mod_private)
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
39 end |
|
6341
ab9a1af80632
mod_private: Cleanup and more tailcalls
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
40 -- TODO delete datastore if empty |
| 6343 | 41 local ok, err = private_storage:set(origin.username, key, data); |
|
6341
ab9a1af80632
mod_private: Cleanup and more tailcalls
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
42 if not ok then |
|
6841
be87ab2d611c
plugins: Explicitly return to halt event propagation (session.send sometimes does not return true)
Kim Alvefur <zash@zash.se>
parents:
6353
diff
changeset
|
43 origin.send(st.error_reply(stanza, "wait", "internal-server-error", err)); |
|
be87ab2d611c
plugins: Explicitly return to halt event propagation (session.send sometimes does not return true)
Kim Alvefur <zash@zash.se>
parents:
6353
diff
changeset
|
44 return true; |
|
6341
ab9a1af80632
mod_private: Cleanup and more tailcalls
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
45 end |
|
6841
be87ab2d611c
plugins: Explicitly return to halt event propagation (session.send sometimes does not return true)
Kim Alvefur <zash@zash.se>
parents:
6353
diff
changeset
|
46 origin.send(st.reply(stanza)); |
|
be87ab2d611c
plugins: Explicitly return to halt event propagation (session.send sometimes does not return true)
Kim Alvefur <zash@zash.se>
parents:
6353
diff
changeset
|
47 return true; |
|
3522
4646b5b039ca
mod_private: Updated to use the new events API. Smaller, more robust.
Waqas Hussain <waqas20@gmail.com>
parents:
3114
diff
changeset
|
48 end |
|
4646b5b039ca
mod_private: Updated to use the new events API. Smaller, more robust.
Waqas Hussain <waqas20@gmail.com>
parents:
3114
diff
changeset
|
49 end); |
