Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
greenstatic committed Mar 24, 2024
1 parent 0c4f199 commit 4f7d10c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/exporter-user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 4f7d10c

Please sign in to comment.