Skip to content

Commit

Permalink
fix ROOM_PARTICIPANTS_CUSTOM_BUCKETS env var parsing bug
Browse files Browse the repository at this point in the history
  • Loading branch information
greenstatic committed May 7, 2020
1 parent 0d2d4d0 commit c67235f
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 38 deletions.
39 changes: 3 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,40 +20,7 @@ Available at: [https://bigbluebutton-exporter.greenstatic.dev](https://bigbluebu
![](docs/assets/img_grafana_dashboard_server_instance.png)

## Metrics
Gauges:
* bbb_meetings_participants - Total number of participants in all BigBlueButton meetings
* bbb_meetings_listeners - Total number of listeners in all BigBlueButton meetings
* bbb_meetings_voice_participants - Total number of voice participants in all BigBlueButton meetings
* bbb_meetings_video_participants - Total number of video participants in all BigBlueButton meetings
* bbb_meetings_participant_clients(type=<client>) - Total number of participants in all BigBlueButton meetings by client (html5|dial-in|flash)
* bbb_recordings_processing - Total number of BigBlueButton recordings processing
* bbb_recordings_processed - Total number of BigBlueButton recordings processed
* bbb_recordings_published - Total number of BigBlueButton recordings published
* bbb_recordings_unpublished - Total number of BigBlueButton recordings unpublished
* bbb_recordings_deleted - Total number of BigBlueButton recordings deleted
* bbb_api_up - 1 if BigBlueButton API is responding 0 otherwise

Histograms:
* bbb_api_latency(labels: endpoint, parameters) - BigBlueButton API call latency
* buckets: .01, .025, .05, .075, .1, .25, .5, .75, 1.0, 1.25, 1.5, 1.75, 2.0, 2.5, 5.0, 7.5, 10.0, INF

See: [Exporter User Guide - Metrics](https://bigbluebutton-exporter.greenstatic.dev/exporter-user-guide/#metrics).

## Environment Variables
* API_SECRET - BigBlueButton API Secret
* **Required: true**
* Use `$ bbb-conf --secret` on BigBlueButton server to get secret and Base API url
* API_BASE_URL -
* **Required: true**
* Example: "https://example.com/bigbluebutton/api/"
* Trailing slash is required!
* DEBUG
* Required: false
* Default: false
* Values: <true | false>
* BIND_IP
* Required: false
* Default: 0.0.0.0
* PORT
* Required: false
* Default: 9688
* Values: <1 - 65535>

See: [Exporter User Guide - Environment Variables](https://bigbluebutton-exporter.greenstatic.dev/exporter-user-guide/#environment-variables).
2 changes: 1 addition & 1 deletion bbb-exporter/helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def get_buckets(self):


def string_list_to_int_list(xs: List[str]) -> List[int]:
return [int(i) for i in xs]
return [int(i) for i in xs.split(",")]


def int_list_greater_than_zero(l: List[int]) -> bool:
Expand Down
11 changes: 10 additions & 1 deletion docs/exporter-user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@
* Example: "https://example.com/bigbluebutton/api/"
* Trailing slash is required!
* Make sure you supply the base url **of the API**, often this URL ends in `/api/`
* ROOM_PARTICIPANTS_CUSTOM_BUCKETS - Custom bucket sizes for the `bbb_room_participants_bucket` histogram metric
* Required: false
* Default: `0,1,5,15,30,60,90,120,150,200,250,300,400,500`
* `INF` will be added automatically as the final bucket size
* Values: list of integers separated using comma (`,`)
* DEBUG - Enable debug logging
* Required: false
* Default: false
Expand All @@ -35,9 +40,13 @@ Gauges:
* bbb_recordings_unpublished - Total number of BigBlueButton recordings unpublished
* bbb_recordings_deleted - Total number of BigBlueButton recordings deleted
* bbb_api_up - 1 if BigBlueButton API is responding 0 otherwise
* bbb_exporter - Information about the exporter (i.e. version)

Histograms:

* bbb_api_latency(labels: endpoint, parameters) - BigBlueButton API call latency
* buckets: .01, .025, .05, .075, .1, .25, .5, .75, 1.0, 1.25, 1.5, 1.75, 2.0, 2.5, 5.0, 7.5, 10.0, INF

* bbb_room_participants_bucket - Number of rooms with participants less than or equal to the bucket size
* buckets: 0, 1, 5, 15, 30, 60, 90, 120, 150, 200, 250, 300, 400, 500, INF
* bucket sizes can be overridden using `ROOM_PARTICIPANTS_CUSTOM_BUCKETS`, see [environment variables](#environment-variables)
for details

0 comments on commit c67235f

Please sign in to comment.