From 4f7d10c3d8e9df5f9924459fdd557a3616c112cf Mon Sep 17 00:00:00 2001 From: Gregor Krmelj Date: Sun, 24 Mar 2024 13:53:27 +0100 Subject: [PATCH] docs update --- docs/exporter-user-guide.md | 2 +- docs/index.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/exporter-user-guide.md b/docs/exporter-user-guide.md index ff803eb..b002279 100644 --- a/docs/exporter-user-guide.md +++ b/docs/exporter-user-guide.md @@ -39,7 +39,7 @@ so running the exporter remotely with this option is not possible (unless you setup a remote file mount). * The metric `bbb_version` relies on this option to be turned on -# Optimizations +## Optimizations * RECORDINGS_METRICS_READ_FROM_DISK - Collect expensive recordings metrics by querying the disk instead of the API. This can substantially decrease the scrape time required for the exporter to respond to metrics requests. * Required: false diff --git a/docs/index.md b/docs/index.md index 1d155ce..0c9b854 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,9 +10,10 @@ On a HTTP `/metrics` request, the exporter will query the BigBlueButton's API fo Metrics exposed: * Number of participants by type (listeners, voice, video) -* Number of participants by client (HTML5, dial-in, flash) +* Number of participants by client (HTML5, dial-in) * Number of recordings (processing, published, unpublished, deleted, unprocessed) * Number of participants in rooms by bucket +* ...and more, checkout [exporter docs](https://bigbluebutton-exporter.greenstatic.dev/exporter-user-guide/) for details. ## Use Case BigBlueButton Exporter is the bridge between BigBlueButton and modern monitoring infrastructure such as Prometheus, Alertmanager & Grafana.