feat(prosody): openmetrics module support #1832

24kushang · 2024-06-24T17:19:12Z

Enable Prosody Metrics Module in Jitsi Meet

Summary:
This PR enhances the Jitsi Meet Docker setup by adding support for metrics scraping for the Prosody service. This allows for improved monitoring and observability of the Prosody service within the Jitsi Meet deployment.

Changes:

Prosody Configuration Update:
- Modified prosody.cfg.lua to enable the http_openmetrics module. This activates the /metrics endpoint to serve metrics.
- Added statistics provider and interval configuration to generate basic statistics for the Prosody service.
Network Configuration:
- Updated the configuration to include the CIDR block of the Docker subnet, allowing access to the metrics endpoint within the internal Docker network.
- Created an environment variable PROSODY_METRICS_ALLOWED_CIDR with default subnet 172.16.0.0/12 which can be changed as per requirement.
Environment Variable:
- Introduced PROSODY_ENABLE_METRICS environment variable to control the metrics feature. It is set to false by default but can be changed to true to enable metrics collection.

How to Use:

Update Environment Configuration:

Add the following environment variable to your .env file:

PROSODY_ENABLE_METRICS=true
PROSODY_METRICS_ALLOWED_CIDR=IP_RANGE_OF_YOUR_CHOICE   # optional

Rebuild and Deploy:
- Rebuild your Docker containers to apply the new configuration:
```
docker-compose down
docker-compose up -d
```
Verify Metrics Collection:
- Access the /metrics endpoint of the Prosody service to ensure that metrics are being served. You can verify this by navigating to http://<prosody-service-ip>:5280/metrics in your browser or using a tool like curl.

Notes:

Make sure the IP addresses and network configurations match your existing setup.
Adjust the statistics_interval as per your monitoring needs.

Contributor:

@24kushang

aaronkvanmeerten

The name of the PR should be something like the below in order to follow the guidelines of the repo:

feat(prosody): openmetrics module support

aaronkvanmeerten · 2024-06-24T17:20:43Z

prosody/rootfs/defaults/prosody.cfg.lua

@@ -28,6 +28,7 @@
 {{ $XMPP_GUEST_DOMAIN := .Env.XMPP_GUEST_DOMAIN | default "guest.meet.jitsi" -}}
 {{ $XMPP_MUC_DOMAIN := .Env.XMPP_MUC_DOMAIN | default "muc.meet.jitsi" -}}
 {{ $XMPP_PORT := .Env.XMPP_PORT | default "5222" -}}
+{{ $PROSODY_ENABLE_METRICS := .Env.PROSODY_ENABLE_METRICS | default "false" | toBool -}}


This should be sorted alphabetically with the other variables

prosody/rootfs/defaults/prosody.cfg.lua

aaronkvanmeerten · 2024-06-24T17:23:31Z

prosody/rootfs/defaults/prosody.cfg.lua

+{{ if $PROSODY_ENABLE_METRICS }}
+statistics = "internal"
+statistics_interval = "manual"
+openmetrics_allow_cidr = "172.18.0.0/16"


This should be a configurable CIDR via env variable and default to 172.16.0.0/12

I am a bit confused in cidr block. /12 or /16 should be the default one?

This should be a variable, and the default value can be 172.16.0.0/12 which is the full CIDR for the reserved IP space that docker is default configured to use. The smaller CIDR you list above 172.18.0.0/16 will only work for 172.18.0.0 - 172.18.0.256, but some docker setups use 172.16.x.x or 172.17.x.x by default, and many people override their docker to use other reserved IP spaces such as 192.168.x.x or 10.x.x.x, so it's important to have a sensible default but allow for overrides as needed.

Co-authored-by: Aaron van Meerten <[email protected]>

Changed according to the PR review - added the PROSODY_METRICS_ALLOWED_CIDR variable - arranged the variable in alphabetic order

Added 2 environment variable for prosody metrics collection - PROSODY_ENABLE_METRICS - PROSODY_METRICS_ALLOWED_CIDR

24kushang · 2024-06-26T13:28:29Z

Updated the changes as per discussion. The PR is ready for review

aaronkvanmeerten · 2024-06-26T14:24:21Z

prosody/rootfs/defaults/prosody.cfg.lua

@@ -12,7 +12,9 @@
 {{ $GC_GEN_MAX_TH := .Env.GC_GEN_MAX_TH | default 100 -}}
 {{ $LOG_LEVEL := .Env.LOG_LEVEL | default "info" }}
 {{ $PROSODY_C2S_LIMIT := .Env.PROSODY_C2S_LIMIT | default "10kb/s" -}}
+{{ $PROSODY_METRICS_ALLOWED_CIDR := .Env.PROSODY_METRICS_ALLOWED_CIDR | default "172.16.0.0/12" | toString -}}


Suggested change

{{ $PROSODY_METRICS_ALLOWED_CIDR := .Env.PROSODY_METRICS_ALLOWED_CIDR | default "172.16.0.0/12" | toString -}}

{{ $PROSODY_METRICS_ALLOWED_CIDR := .Env.PROSODY_METRICS_ALLOWED_CIDR | default "172.16.0.0/12" -}}

No need for toString here I don't believe, since the default is already a string.

aaronkvanmeerten · 2024-06-26T14:24:54Z

prosody/rootfs/defaults/prosody.cfg.lua

@@ -108,6 +110,12 @@ modules_enabled = {
 		"s2sout_override";
 		"s2s_whitelist";
 		{{ end -}}
+
+		-- metrics collection functionality


This should be inside the if statement, as otherwise it will be rendered in the final document no matter whether metrics are enabled or not.

aaronkvanmeerten · 2024-06-26T14:25:08Z

prosody/rootfs/defaults/prosody.cfg.lua

@@ -287,6 +295,13 @@ log = {
 {{ end }}
 }

+-- Statistics Provider and 


Same here, this should be inside the if statement

aaronkvanmeerten · 2024-06-26T14:25:19Z

prosody/rootfs/defaults/prosody.cfg.lua

@@ -287,6 +295,13 @@ log = {
 {{ end }}
 }

+-- Statistics Provider and 


Suggested change

-- Statistics Provider and

-- Statistics Provider configuration

* b4604f3 feat(whiteboard) add builtin whiteboard integration * 49bd165 feat(jibri) update Chrome to 126 * 980703b fix(jibri): display modes in xorg config * c65d2bd feat(jigasi,jicofo,jvb,jibri,prosody): add healthcheck.sh scripts and prosody http_health mod * d2ac43d feat(jigasi): Add new environment variables for jigasi configuration (#1841) * fbc250e feat(prosody): openmetrics module support (#1832) * 2adac72 feat(prosody): Drop non existing config. * e22b4f3 feat(jibri): Adds more fonts. * 982e577 feat(jicofo,jvb,web) default to using SCTP based datachannels * 55c975f fix(jicofo): use integer for port value to fix addition (#1826) * 7c8763f base: update tpl to version 1.3.0 * 1d3c0f1 jibri: fail to start if the SYS_ADMIN cap is missing (#1816) * cacee4e jvb: adds autoscaler sidecar hook to signal final shutdown (#1809) * 726b0f0 jibri: adds autoscaler sidecar hook to signal final shutdown (#1810) * f2b2cc4 etherpad: update image version and settings * 731d6d1 base: update tpl to make toBool more resilient * 59c4eb2 jvb: add fallback WS server ID * 9a54843 jvb: add ability to configure the TLS option for colibri WS * 79a4635 jvb: add ability to disable XMPP * 77ce86a jvb: add ability to enable SCTP datachannels * 76ffaa7 jicofo, jvb: fix OCTO + SCTP behaviour * 0298a30 misc: working on unstable

Metrics enabled in Prosody Service

9afec28

aaronkvanmeerten reviewed Jun 24, 2024

View reviewed changes

24kushang changed the title ~~Metrics enabled in Prosody Service~~ feat(prosody): openmetrics module support Jun 25, 2024

24kushang and others added 3 commits June 25, 2024 18:46

Update prosody/rootfs/defaults/prosody.cfg.lua

2f8fc62

Co-authored-by: Aaron van Meerten <[email protected]>

Updated the CIDR variable in prosody.cfg.lua

957f28e

Changed according to the PR review - added the PROSODY_METRICS_ALLOWED_CIDR variable - arranged the variable in alphabetic order

Update docker-compose.yml with new environment variables

a646691

Added 2 environment variable for prosody metrics collection - PROSODY_ENABLE_METRICS - PROSODY_METRICS_ALLOWED_CIDR

aaronkvanmeerten requested changes Jun 26, 2024

View reviewed changes

Minor changes in prosody.cfg.lua

2ce2a7f

aaronkvanmeerten approved these changes Jun 26, 2024

View reviewed changes

bgrozev approved these changes Jun 26, 2024

View reviewed changes

aaronkvanmeerten merged commit fbc250e into jitsi:master Jun 26, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(prosody): openmetrics module support #1832

feat(prosody): openmetrics module support #1832

24kushang commented Jun 24, 2024 •

edited

Loading

aaronkvanmeerten left a comment

aaronkvanmeerten Jun 24, 2024

aaronkvanmeerten Jun 24, 2024

24kushang Jun 25, 2024

aaronkvanmeerten Jun 25, 2024

24kushang commented Jun 26, 2024

aaronkvanmeerten Jun 26, 2024

aaronkvanmeerten Jun 26, 2024

aaronkvanmeerten Jun 26, 2024

aaronkvanmeerten Jun 26, 2024

	{{ $PROSODY_METRICS_ALLOWED_CIDR := .Env.PROSODY_METRICS_ALLOWED_CIDR \| default "172.16.0.0/12" \| toString -}}
	{{ $PROSODY_METRICS_ALLOWED_CIDR := .Env.PROSODY_METRICS_ALLOWED_CIDR \| default "172.16.0.0/12" -}}

	-- Statistics Provider and
	-- Statistics Provider configuration

feat(prosody): openmetrics module support #1832

feat(prosody): openmetrics module support #1832

Conversation

24kushang commented Jun 24, 2024 • edited Loading

Enable Prosody Metrics Module in Jitsi Meet

aaronkvanmeerten left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

24kushang commented Jun 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

24kushang commented Jun 24, 2024 •

edited

Loading