File

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

(This file was created from
https://prosody.im/doc/installing_from_source on 2013-03-31)

====== Installing from source ======
==== Dependencies ====
There are a couple of libraries which Prosody needs installed before 
you can build it. These are:

  * lua5.1: The Lua 5.1 interpreter
  * liblua5.1: Lua 5.1 library
  * libssl 0.9.8: OpenSSL
  * libidn11: GNU libidn library, version 1.1

These can be installed on Debian/Ubuntu with the packages: lua5.1 
liblua5.1-dev libidn11-dev libssl-dev

On Mandriva try: urpmi lua liblua-devel libidn-devel libopenssl-devel

On other systems... good luck, but please let me know of the best way 
of getting the dependencies for your system and I can add it here.

==== configure ====
The first step of building is to run the configure script. This 
creates a file called 'config.unix' which is used by the next step to 
control aspects of the build process.

All options to configure can be seen by running ./configure --help. 
Sometimes you won't need to pass any parameters to configure, but on 
most systems you shall.

To make this a little easier, there are a few presets which configure 
accepts. You can load a preset using:

   ./configure --ostype=PRESET

Where PRESET can currently be one of: 'debian', 'macosx' or (in 0.8 
and later) 'freebsd'

==== make ====
Once you have run configure successfully, then you can simply run:

   make

Simple? :-)

If you do happen to have problems at this stage, it is most likely 
due to the build process not finding the dependencies. Ensure you 
have them installed, and in the standard library paths for your 
system.

For more help, just ask ;-)

==== install ====
At this stage you should be able to run Prosody simply with:

   ./prosody

There is no problem with this, it is actually the easiest way to do 
development, as it doesn't spread parts around your system, and you 
can keep multiple versions around in their own directories without 
conflict.

Should you wish to install it system-wide however, simply run:

   sudo make install

...it will install into /usr/local/ by default. To change this you 
can pass to the initial ./configure using the 'prefix' option, or 
edit config.unix directly. If the new path doesn't require root 
permission to write to, you also won't need (or want) to use 'sudo' 
in front of the 'make install'.

Have fun, and see you on Jabber!