Exporter that grabs various metrics from Jitsi, especially form the video bridges, and publishes them as Prometheus metrics. The basic idea is to enter the jvbbrewery MUC room and listen to the presence broadcasts from the JVBs.
There is a documentation of the published statistics by the video bridges.
There are multiple ways to run the exporter. Once it is running, it will publish the collected metrics on :8080/metrics
.
You will have to create a XMPP user in Prosody, do this with:
prosodyctl --config <abs path to jitsi-meet.cfg.lua> register <user> <auth-domain> <password>
If you are creating this user on the default domain, make sure you add it to auth domain @auth.jitsi.meet
and not @jitsi.meet
. Since the domain @jitsi.meet
defaults to anonymous
auth, this addition will not be successful.
Copy the exporter
directory into your $GOPATH/src/
directory. In the newly created exporter
directroy run go get ./...
, then go build ./...
, then go install ./...
which then creates the exporter
binary in $GOPTAH/bin/
. You can run this binary, it will still pull its configuration (see below) from the environment.
There is an image available on docker hub karrieretutor/jitsi:prom-exporter-latest
. Alternatively build it yourself with the provided dockerfile. The configuration is provided via environment (see below). By running it as a docker container you gain the advantage of choosing the port which is used for publishing the metrics, see docker cli reference.
env | description | default value |
---|---|---|
XMPP_USER |
xmpp user for authentication | |
XMPP_PW |
xmpp password for authentication | |
XMPP_AUTH_DOMAIN |
xmpp domain to authenticate against | |
XMPP_SERVER |
xmpp server host name | |
XMPP_PORT |
xmpp port to use | 5222 |
JVB_BREWERY_MUC |
name of jvbbrewery MUC room to join; it will join with prom-exporter as nickname -> JVB_BREWERY_MUC@INTERNAL_MUC_DOMAIN/prom-exporter |
jvbbrewery |
XMPP_INTERNAL_MUC_DOMAIN |
internal muc domain (this is where the jvbbrewery muc resides) | |
JVB_METRIC_SUBSYSTEM |
Allows you to customize the metric names: [<subsystem>_][<namespace>_]metricname ; both are optional |
|
JVB_METRIC_NAMESPACE |
see JVB_METRIC_SUBSYSTEM |
XMPP_USER
and XMPP_AUTH_DOMAIN
are used to construct the JID XMPP_USER@XMPP_AUTH_DOMAIN