Check jitsi-videobridge-stats¶

Overview¶

Monitors Jitsi Videobridge performance via the COLIBRI REST API. Reports conference count, participant count, video channels, bitrates, packet rates, and other bridge metrics.

Important Notes:

Jitsi Videobridge v2.1+
This check always returns OK. It is designed purely as a metrics collector for graphing dashboards.
DTLS = Datagram Transport Layer Security, MUC = Multi-User Channel
For a discussion on how many users Jitsi supports, see here and here

Data Collection:

Queries the /colibri/stats endpoint on the Jitsi Videobridge private REST interface
The private REST interface must be activated first
All total_* values are reported as continuous counters (uom c) so that graphing tools like Grafana can display rates over time correctly
For details on the statistics, see the Jitsi Videobridge statistics documentation

Fact Sheet¶

Fact	Value
Check Plugin Download	https://github.com/Linuxfabrik/monitoring-plugins/tree/main/check-plugins/jitsi-videobridge-stats
Nagios/Icinga Check Name	`check_jitsi_videobridge_stats`
Check Interval Recommendation	Every minute
Can be called without parameters	Yes
Runs on	Cross-platform
Compiled for Windows	No (runs with Python interpreter)
Uses State File	`$TEMP/linuxfabrik-monitoring-plugins-jitsi-videobridge-stats.db`

Help¶

usage: jitsi-videobridge-stats [-h] [-V] [--always-ok] [--insecure]
                               [--no-perfdata] [--no-proxy] [-p PASSWORD]
                               [--proxy PROXY] [--timeout TIMEOUT] [--url URL]
                               [--username USERNAME]

Monitors Jitsi Videobridge performance via the COLIBRI REST API. Reports
conference count, participant count, video channels, bitrates, packet rates,
and other bridge metrics. The figures are reported for trending and never
alert on their own.

options:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  --always-ok           Always returns OK.
  --insecure            This option explicitly allows insecure SSL
                        connections.
  --no-perfdata         Suppress the performance data section from the output.
                        The status message and the exit code are unaffected,
                        so alerting keeps working while trending data is
                        dropped.
  --no-proxy            Do not use a proxy, not even one the environment
                        names. Overrides `--proxy`.
  -p, --password PASSWORD
                        Jitsi API password.
  --proxy PROXY         Proxy to reach the target through. The scheme defaults
                        to `http` when omitted. Overrides the proxy the
                        environment names (`http_proxy`, `https_proxy`,
                        `all_proxy`) together with the exceptions it lists in
                        `no_proxy`, and is itself overridden by `--no-proxy`.
                        Without either parameter the environment applies.
                        Credentials belong into the environment variable
                        rather than here, because a command-line argument is
                        visible to every user on the host. Example:
                        `--proxy=http://proxy.example.com:3128`.
  --timeout TIMEOUT     Network timeout in seconds. Default: 3 (seconds)
  --url URL             Jitsi API URL. Default: http://localhost:8080
  --username USERNAME   Jitsi API username. Default: None

Documentation:
https://linuxfabrik.github.io/monitoring-plugins/check-plugins/jitsi-videobridge-stats/

Usage Examples¶

./jitsi-videobridge-stats

Output:

2 total participants, 1 conference, Stress Level 0.00848, 75 JVM threads, 1.4Mbps download, 961.3Kbps upload

States¶

Always returns OK.
--always-ok has no additional effect since the check never alerts.

Perfdata / Metrics¶

For details see the Jitsi Videobridge statistics documentation.

Name	Type	Description
bit_rate_download	Bits per Second	Current incoming bitrate (RTP) in kilobits per second.
bit_rate_upload	Bits per Second	Current outgoing bitrate (RTP) in kilobits per second.
conferences	Number	Current number of conferences.
current_timestamp	Number	UTC time at which the report was generated.
dtls_failed_endpoints_per_second	Number	Endpoints which failed to establish a DTLS connection per second.
endpoints	Number	Current number of endpoints, including octo endpoints.
endpoints_sending_audio	Number	Current number of endpoints sending (non-silence) audio.
endpoints_sending_video	Number	Current number of endpoints sending video.
endpoints_with_spurious_remb	Number	Current number of endpoints which sent an RTCP REMB packet when REMB was not signaled (gauge, not a counter).
graceful_shutdown	Number	Whether the bridge is in graceful shutdown mode (1 = yes).
inactive_conferences	Number	Current number of conferences with no endpoints sending audio or video.
inactive_endpoints	Number	Current number of endpoints in inactive conferences.
largest_conference	Number	Size of the current largest conference (all endpoints including octo).
local_active_endpoints	Number	Current number of local endpoints in an active conference.
local_endpoints	Number	Current number of local (non-octo) endpoints.
num_eps_oversending	Number	Current number of endpoints to which the bridge is oversending.
octo_conferences	Number	Current number of conferences with octo enabled.
octo_endpoints	Number	Current number of octo endpoints (connected to remote bridges).
octo_receive_bitrate	Number	Current incoming bitrate on the octo channel in bits per second.
octo_receive_packet_rate	Number	Current incoming packet rate on the octo channel in packets per second.
octo_send_bitrate	Number	Current outgoing bitrate on the octo channel in bits per second.
octo_send_packet_rate	Number	Current outgoing packet rate on the octo channel in packets per second.
p2p_conferences	Number	Current number of peer-to-peer conferences.
packet_rate_download	Number	Current RTP incoming packet rate in packets per second.
packet_rate_upload	Number	Current RTP outgoing packet rate in packets per second.
preemptive_kfr_sent_per_second	Number	Preemptive keyframe requests sent per second.
receive_only_endpoints	Number	Current number of endpoints not sending audio or video.
rtt_aggregate	Milliseconds	Round-trip time averaged over all local endpoints with a valid RTT measurement.
stress_level	Number	Current stress level on the bridge (0 = no load, 1 = full capacity, values > 1 permitted).
threads	Number	Current number of JVM threads.
total_bytes_received_per_second	Bytes	Bytes received in RTP per second.
total_bytes_received_octo_per_second	Bytes	Bytes received on the octo channel per second.
total_bytes_sent_per_second	Bytes	Bytes sent in RTP per second.
total_bytes_sent_octo_per_second	Bytes	Bytes sent on the octo channel per second.
total_colibri_web_socket_messages_received_per_second	Number	Colibri bridge channel messages received on a WebSocket per second.
total_colibri_web_socket_messages_sent_per_second	Number	Colibri bridge channel messages sent over a WebSocket per second.
total_conference_seconds_per_second	Number	Conference-seconds served (updates once a conference expires) per second.
total_conferences_completed_per_second	Number	Conferences completed per second.
total_conferences_created_per_second	Number	Conferences created per second.
total_data_channel_messages_received_per_second	Number	Colibri bridge channel messages received on SCTP data channels per second.
total_data_channel_messages_sent_per_second	Number	Colibri bridge channel messages sent over SCTP data channels per second.
total_dominant_speaker_changes_per_second	Number	Times the dominant speaker changed in a conference per second.
total_failed_conferences_per_second	Number	Conferences in which no endpoint established an ICE connection per second.
total_ice_failed_per_second	Number	Endpoints which failed to establish an ICE connection per second.
total_ice_succeeded_per_second	Number	Endpoints which successfully established an ICE connection per second.
total_ice_succeeded_relayed_per_second	Number	Endpoints which connected through a TURN relay per second.
total_packets_dropped_octo_per_second	Number	Packets dropped on the octo channel per second.
total_packets_received_per_second	Number	RTP packets received per second.
total_packets_received_octo_per_second	Number	Packets received on the octo channel per second.
total_packets_sent_per_second	Number	RTP packets sent per second.
total_packets_sent_octo_per_second	Number	Packets sent over the octo channel per second.
total_partially_failed_conferences_per_second	Number	Conferences in which at least one endpoint failed an ICE connection per second.
total_participants_per_second	Number	Endpoints created per second.
version	Number	The version of jitsi-videobridge as float.

Credits, License¶

Authors: Linuxfabrik GmbH, Zurich
License: The Unlicense, see LICENSE file.