Jitsi Prometheus exporter

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. Metrics are available for jvb2 version 2.1-607-g153f7e4e-1 from 17-Jan-2022.

There is a documentation of the published statistics by the video bridges, but is not much updated and list of availabled metrics is outdated. To get current metrics query running exporter or look in code.

Run

There are multiple ways to run the exporter. Once it is running, it will publish the collected metrics on :PROMEXP_PORT/metrics, or when run as containerized app, PROMEXP_PORT can be mapped to specific value.

Register user in prosody

You will have to create a XMPP user in Prosody, do this with:

prosodyctl --config <abs path to jitsi-meet.cfg.lua> register PROMEXP_AUTH_USER XMPP_AUTH_DOMAIN PROMEXP_AUTH_PASSWORD

Also, ensure, that tls module is enabled in prosody, without tls module enabled exporter woun't authorize to prosody.

Configure JVB

Ensure, that streaming statistics via colibri is enabled in jvb, sip-communicator.properties should contain configuration like this:

org.jitsi.videobridge.ENABLE_STATISTICS=true
org.jitsi.videobridge.STATISTICS_TRANSPORT=muc,colibri
org.jitsi.videobridge.STATISTICS_INTERVAL=1000

Binary

Clone this repo into your $GOPATH/src/ directory. In the exporter directroy run go get ./... which creates the exporter binary in $GOPTAH/bin/. You can run this binary, it will still pull its configuration (see below) from the environment.

Docker container

There is no image available on docker hub, you have to build it yourself with the provided dockerfile. The configuration is provided via environment variables (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.

Configuration

Only available configuration is via environment variables.

env	description	default value
PROMEXP_PORT	port on which prometheus exporter will listen for scraping ('/metrics' endpoint)	8080
PROMEXP_AUTH_USER	xmpp user for authentication
PROMEXP_AUTH_PASSWORD	xmpp password for authentication
XMPP_SERVER	xmpp server host name
XMPP_PORT	xmpp port to use	5222
XMPP_AUTH_DOMAIN	xmpp domain to authenticate against
XMPP_INTERNAL_MUC_DOMAIN	internal muc domain (this is where the jvbbrewery muc resides)
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
JVB_METRIC_SUBSYSTEM	Allows you to customize the metric names: [<subsystem>_][<namespace>_]metricname; both are optional
JVB_METRIC_NAMESPACE	Allows you to customize the metric names: [<subsystem>_][<namespace>_]metricname; both are optional
JVB_METRIC_LABELS	Allows to set additional custom metrics labels, values are written as key pairs separated with comma, ie key1=value1,key2=value2	app=jitsi

PROMEXP_AUTH_USER and XMPP_AUTH_DOMAIN are used to construct the JID PROMEXP_AUTH_USER@XMPP_AUTH_DOMAIN