zbx-sadman / BigBlueButton

This tools helps to monitor BigBlueButon with Zabbix.
GNU General Public License v3.0
8 stars 5 forks source link

BigBlueButton tool set

This tools helps to monitoring BigBlueButon with Zabbix.

Graph examples

Summary traffic / participants

Total number of participants

BBB integration/template for Zabbix

Tested on:

Metrics supported:

LLD available for:

Clarification of the roles of users:

How to use with Zabbix

1. Fast

  1. Add string UserParameter=bbb.miner[*],curl -s https://bbb.example.com/bigbluebutton/api/$1?checksum=`echo -n "$1BigBlueButtonSecretStringThere" | sha1sum | head -c 40` 2>&1 to the end of your zabbix_agentd.conf file;
  2. Replace bbb.example.com with your BBB server hostname which used for the SSL-certificate
  3. Replace BigBlueButtonSecretStringThere with your BBB server secret. You can get it from bbb-conf --secret command output;
  4. Restart Zabbix agent;
  5. Import template to the Zabbix Server;
  6. Link template to the BBB host with Zabbix web-interface;
  7. Enjoy.

2. Using host-level macroses (credits @felcaetano)

  1. Add string UserParameter=bbb.miner[*],curl -s https://$1/bigbluebutton/api/$3?checksum=`echo -n "$3$2" | sha1sum | head -c 40` 2>&1 to the end of your zabbix_agentd.conf file;
  2. Restart Zabbix agent;
  3. Import macrosed template to the Zabbix Server;
  4. Link template to the BBB host with Zabbix web-interface;
  5. Change values of the host-level macroses {$BBB_HOSTNAME} and {$BBB_SECRET} to your own;
  6. Enjoy again.

Hint: All LLD-generated meetings's Applications will be stored for some time which specified in the {$KEEP_MEETING_GENERATED_ITEMS} macro, which default value is 7 days. If you need more history data - just create that macro on host level and set it value to... 25 years, for example.

Beware: BBB API's response can be big - ~65kb on getMeetings request to the BBB that serves 4 meeting with 50 participants per each. Do not call frequently Template's 'master items' update.