{"id":19974662,"url":"https://github.com/elan-ev/bbb-selenium-exporter","last_synced_at":"2025-05-04T02:32:59.568Z","repository":{"id":54606414,"uuid":"328482803","full_name":"elan-ev/bbb-selenium-exporter","owner":"elan-ev","description":"Selenium-based BigBlueButton monitoring for Prometheus","archived":false,"fork":false,"pushed_at":"2021-02-08T16:29:14.000Z","size":39,"stargazers_count":5,"open_issues_count":0,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-30T21:13:54.099Z","etag":null,"topics":["bigbluebutton","prometheus","prometheus-exporter"],"latest_commit_sha":null,"homepage":"https://gitlab.com/infra.run/public/bbb-selenium-exporter","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elan-ev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-10T21:26:52.000Z","updated_at":"2023-12-22T14:08:19.000Z","dependencies_parsed_at":"2022-08-13T21:20:12.326Z","dependency_job_id":null,"html_url":"https://github.com/elan-ev/bbb-selenium-exporter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elan-ev%2Fbbb-selenium-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elan-ev%2Fbbb-selenium-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elan-ev%2Fbbb-selenium-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elan-ev%2Fbbb-selenium-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elan-ev","download_url":"https://codeload.github.com/elan-ev/bbb-selenium-exporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252279087,"owners_count":21722836,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bigbluebutton","prometheus","prometheus-exporter"],"created_at":"2024-11-13T03:15:42.387Z","updated_at":"2025-05-04T02:32:59.295Z","avatar_url":"https://github.com/elan-ev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"bbb-selenium-exporter\n=====================\n\nA Selenium-based BigBlueButton monitoring for Prometheus.\n\nThe bbb-selenium-exporter runs a set of Selenium tests against BigBlueButton in a configurable interval and provides the results as OpenMetrics endpoint consumable by Prometheus.\nThis allows for a continuous monitoring of BigBlueButton based on the good working order of the user interface.\n\n\nInstallation\n------------\n\nTo run the exporter, you need:\n\n- Python 3\n- [Google Chrome](https://www.google.com/chrome/)\n- A matching [ChromeDriver](https://chromedriver.chromium.org/downloads)\n\nUse the `setup.py` to build and install the bbb-selenium-exporter:\n\n```sh\n% python setup.py install\n```\n\n\nCommand Line\n------------\n\nYou can use the `--help` flag to get all command line options of the exporter:\n\n```\n% bbb-selenium-exporter --help\nusage: bbb-selenium-exporter [-h] [--bind BIND] [--config CONFIG] [--interval INTERVAL] [--jobs JOBS] [--gui]\n\noptional arguments:\n  -h, --help            show this help message and exit\n  --bind BIND, -b BIND  bind to address:port\n  --config CONFIG, -c CONFIG\n                        config file with BBB instances to scrape\n  --interval INTERVAL, -i INTERVAL\n                        interval between scrapes of the same host in seconds\n  --jobs JOBS, -j JOBS  number of parallel webdriver instances\n  --gui                 disable headless mode for webdriver\n\n```\n\n\nConfiguration\n-------------\n\nTo allow access to BigBlueButton, the exporter needs to know the API secret for every server to monitor.\nFor this, create a configuration file in `/etc/bbb-selenium-exporter/targets` or provide the location using the `-c` option.\nThe configuration file contains domain names and secrets separated by a space character like this:\n\n```\nbbb.example.com BBB-API-SECRET\n```\n\n\nMetrics\n-------\n\n```\n# HELP connect_server_success Success of connecting to BBB server\n# TYPE connect_server_success gauge\nconnect_server_success{backend=\"bbb.example.com\"} 1.0\n# HELP connect_server_duration_seconds Duration of connecting to BBB server\n# TYPE connect_server_duration_seconds gauge\nconnect_server_duration_seconds{backend=\"bbb.example.com\"} 1.4048139119986445\n# HELP echo_test_success Success of waiting for echo test\n# TYPE echo_test_success gauge\necho_test_success{backend=\"bbb.example.com\"} 1.0\n# HELP echo_test_duration_seconds Duration of waiting for echo test\n# TYPE echo_test_duration_seconds gauge\necho_test_duration_seconds{backend=\"bbb.example.com\"} 3.0636934980029764\n# HELP join_headphone_success Success of joining room with headphones\n# TYPE join_headphone_success gauge\njoin_headphone_success{backend=\"bbb.example.com\"} 1.0\n# HELP join_headphone_duration_seconds Duration of joining room with headphones\n# TYPE join_headphone_duration_seconds gauge\njoin_headphone_duration_seconds{backend=\"bbb.example.com\"} 0.17476947300019674\n# HELP start_cam_success Success of starting camera\n# TYPE start_cam_success gauge\nstart_cam_success{backend=\"bbb.example.com\"} 1.0\n# HELP start_cam_duration_seconds Duration of starting camera\n# TYPE start_cam_duration_seconds gauge\nstart_cam_duration_seconds{backend=\"bbb.example.com\"} 14.53077382000265\n# HELP upload_pres_success Success of uploading presentation\n# TYPE upload_pres_success gauge\nupload_pres_success{backend=\"bbb.example.com\"} 1.0\n# HELP upload_pres_duration_seconds Duration of uploading presentation\n# TYPE upload_pres_duration_seconds gauge\nupload_pres_duration_seconds{backend=\"bbb.example.com\"} 6.875032278003346\n# HELP chat_test_success Success of testing chat\n# TYPE chat_test_success gauge\nchat_test_success{backend=\"bbb.example.com\"} 1.0\n# HELP chat_test_duration_seconds Duration of testing chat\n# TYPE chat_test_duration_seconds gauge\nchat_test_duration_seconds{backend=\"bbb.example.com\"} 0.8765619519981556\n# HELP poll_test_success Success of testing poll\n# TYPE poll_test_success gauge\npoll_test_success{backend=\"bbb.example.com\"} 1.0\n# HELP poll_test_duration_seconds Duration of testing poll\n# TYPE poll_test_duration_seconds gauge\npoll_test_duration_seconds{backend=\"bbb.example.com\"} 0.8743671500014898\n# HELP etherpad_test_success Success of testing etherpad\n# TYPE etherpad_test_success gauge\netherpad_test_success{backend=\"bbb.example.com\"} 1.0\n# HELP etherpad_test_duration_seconds Duration of testing etherpad\n# TYPE etherpad_test_duration_seconds gauge\netherpad_test_duration_seconds{backend=\"bbb.example.com\"} 2.3751644189978833\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felan-ev%2Fbbb-selenium-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felan-ev%2Fbbb-selenium-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felan-ev%2Fbbb-selenium-exporter/lists"}