Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bigblueswarm/bigbluebutton-telegraf-plugin

BigBlueButton telegraf external plugin. Gather meetings and recordings metrics about your BigBlueButton server
https://github.com/bigblueswarm/bigbluebutton-telegraf-plugin

bigbluebutton hacktoberfest metrics monitoring telegraf

Last synced: 21 days ago
JSON representation

BigBlueButton telegraf external plugin. Gather meetings and recordings metrics about your BigBlueButton server

Host: GitHub
URL: https://github.com/bigblueswarm/bigbluebutton-telegraf-plugin
Owner: bigblueswarm
License: gpl-3.0
Created: 2021-03-14T11:58:21.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2023-10-22T15:29:51.000Z (about 1 year ago)
Last Synced: 2023-10-22T16:28:14.295Z (about 1 year ago)
Topics: bigbluebutton, hacktoberfest, metrics, monitoring, telegraf
Language: Go
Homepage:
Size: 93.8 KB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # BigBlueButton Input Plugin

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/0ffb957fe6074e93b06b6b52106a4659)](https://www.codacy.com/gh/bigblueswarm/bigbluebutton-telegraf-plugin/dashboard?utm_source=github.com&utm_medium=referral&utm_content=bigblueswarm/bigbluebutton-telegraf-plugin&utm_campaign=Badge_Grade)

[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/0ffb957fe6074e93b06b6b52106a4659)](https://www.codacy.com/gh/bigblueswarm/bigbluebutton-telegraf-plugin/dashboard?utm_source=github.com&utm_medium=referral&utm_content=bigblueswarm/bigbluebutton-telegraf-plugin&utm_campaign=Badge_Coverage)

[![Code linting](https://github.com/bigblueswarm/bbsctl/actions/workflows/lint.yml/badge.svg)](https://github.com/bigblueswarm/bigbluebutton-telegraf-plugin/actions/workflows/lint.yml)

[![Unit tests](https://github.com/bigblueswarm/bbsctl/actions/workflows/unit_test.yml/badge.svg)](https://github.com/bigblueswarm/bigbluebutton-telegraf-plugin/actions/workflows/unit_test.yml)

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/bigblueswarm/bigbluebutton-telegraf-plugin)

![GitHub](https://img.shields.io/github/license/bigblueswarm/bigbluebutton-telegraf-plugin)

The BigBlueButton Input Plugin gathers metrics from [BigBlueButton](https://bigbluebutton.org/) server. It uses [BigBlueButton API](https://docs.bigbluebutton.org/dev/api.html) `getMeetings` and `getRecordings` endpoints to query the data.

## Configuration

```toml

[[inputs.bigbluebutton]]

	## Required BigBlueButton server url

	url = "http://localhost:8090"

	## BigBlueButton path prefix. Default is "/bigbluebutton"

	# path_prefix = "/bigbluebutton"

	## Required BigBlueButton secret key

	secret_key = ""

	## Gather metrics by metadata

	# Using this option, gathering data will also insert metrics grouped by metadata configuration

	# gather_by_metadata = []

	## Optional HTTP Basic Auth Credentials

	# username = "username"

	# password = "pa$$word

	## Optional HTTP Proxy support

	# http_proxy_url = ""

	## Optional TLS Config

	# tls_ca = "/etc/telegraf/ca.pem"

	# tls_cert = "/etc/telegraf/cert.pem"

	# tls_key = "/etc/telegraf/key.pem"

	## Use TLS but skip chain & host verification

	# insecure_skip_verify = false

```

## Metrics

- bigbluebutton:

  - fields:

    - meetings

    - participants

    - listener_participants

    - voice_participants

    - video_participants

    - active_recordings

    - recordings

    - published_recordings

  	- online

Using the `gather_by_metadata`, plugin will add meetings and recordings metrics grouped by meetings provided metadata like the following:

```

tenant active_recordings=0i,listener_participants=0i,participants=0i,video_participants=0i,voice_participants=0i,meetings=1i 0

```

For example, using the following configuration:

```toml

## Gather metrics by metadata

# Using this option, gathering data will also insert metrics grouped by metadata configuration

gather_by_metadata = ["tenant"]

```

With a meeting:

```xml

	Meeting 2

	b0a78452-2266-4a0a-abae-8a016db8fccd

	6e2f5787a62c9c3e13ee557c847decded4a53d59-1613138647914

	1613138647914

	Fri Feb 12 15:04:07 CET 2021

	75042

	613-555-1234

	e313fc20-2247-48dd-884a-b1cb48c7919c

	be89c431-00d9-4e38-a2f9-c9a54c9873a3

	true

	0

	true

	false

	false

	1613138647937

	0

	5

	3

	3

	1

	0

	1

	

	

	

		localhost

	

	false

```

will generate the following metric:

```

tenant active_recordings=0i,listener_participants=3i,participants=5i,video_participants=1i,voice_participants=3i,meetings=1i,tenant=localhost 1617611008787972024

```

## Example output

```sh

bigbluebutton meetings=0i,voice_participants=0i,recordings=0i,active_recordings=0i,participants=0i,listener_participants=0i,published_recordings=0i,online=1i,video_participants=0i 1673991941312623800

tenant voice_participants=0i,video_participants=0i,online=1i,meetings=1i,participants=0i,active_recordings=0i,listener_participants=0i,published_recordings=0i,recordings=0i,tenant=locahost 1673992041293464800

```

## Installation

- Download the latest release from [release page](https://github.com/SLedunois/bigbluebutton-telegraf-plugin/releases)

- Configure telegraf to call it using execd

 ```toml

[[inputs.execd]]

  command = ["/path/to/bbb-telegraf", "-config", "/path/to/bbb-telegraf/config", "-poll_interval", "10s"]

  signal = "none"

 ```

Alternatively, you can build your own binary using:

```bash

git clone [email protected]:SLedunois/bigbluebutton-telegraf-plugin.git

go build -o bbb-telegraf cmd/main.go

```