added warnings for prometheus apt unavailability (#1184)

added some warnings that the prometheus implementation is unavailable
when installing through apt
coturn/coturn#1133
This commit is contained in:
czephyr 2023-08-20 22:17:37 +02:00 committed by GitHub
parent c0cb48d4a2
commit 19744a4a39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 6 deletions

View File

@ -111,7 +111,7 @@ Management interfaces:
Monitoring:
* Redis can be used for status and statistics storage and notification
* [prometheus](https://prometheus.io/) interface
* [prometheus](https://prometheus.io/) interface (unavailable on apt package)
Message integrity digest algorithms:

View File

@ -287,11 +287,13 @@ Flags:
--prometheus Enable prometheus metrics. By default it is
disabled. Would listen on port 9641 under the path /metrics
also the path / on this port can be used as a health check
--prometheus-username-labels Enable labeling prometheus traffic
metrics with client usernames. Labeling with client usernames is
disabled by default, because this may cause memory leaks when using
authentication with ephemeral usernames (e.g. TURN REST API).
also the path / on this port can be used as a health check.
Unavailable on apt installations.
--prometheus-username-labels Enable labeling prometheus traffic
metrics with client usernames. Labeling with client usernames is
disabled by default, because this may cause memory leaks when using
authentication with ephemeral usernames (e.g. TURN REST API).
--prometheus-port Prometheus listener port (Default: 9641).

View File

@ -192,6 +192,8 @@
#
# You can simply run the turnserver and access the port 9641 and path /metrics
#
# This is currently unavailable on apt installations
#
# For more info on the prometheus exporter and metrics
# https://prometheus.io/docs/introduction/overview/
# https://prometheus.io/docs/concepts/data_model/