Plugin that allows you to connect Bitmovin Analytics solution into your Grafana dashboards.
Add the plugin and acquire your Bitmovin Analytics API key from the bitmovin dashboard.
Configure the datasource:
Setting | Value |
---|---|
URL | https://api.bitmovin.com/v1 |
API Key | Your API key |
Ad Analytics | If checked, the datasource is switched to query ads data |
Optionally add your Tenant Org Id
which you can also get from the bitmovin dashboard.
See the example_dashboard.json for a demo. Configure the datasource with your Api Key and select a license key in each panel.
Add a new panel and select the bitmovin analytics datasource. Configure the metric with following settings:
Setting | Description |
---|---|
License* | Your analytics license |
Metric* | Aggregation method to use, e.g. count , sum |
Dimension* | Dimension to aggregate over |
Filter | Apply filters to the query |
Format as time series* | Check the switch to see time series data |
Group By | Group query by dimension and plot as individual time series |
Order By | Order query ascending or descending by dimension |
Limit | Limit the result to given number |
Interval* | Time granularity of queries, select AUTO to automatically adapt to selected time range |
Alias By | Set the name of series (only visible with multiple queries in one Graph) |
Settings marked with *
are required for the time series graph.
To compare e.g. impressions per browser, we provide the Group By
attribute to group the results by specific dimensions and plot them as individual time series. Multiple Group Bys
are supported for time series.
Configure the metric as described in Time Series Graph but uncheck the Format as time series
option and add a Group By
dimension. It is recommended to add a limit (e.g. 10).
Configure the Gauge's Value Options
, depending on your query.
- For table data (
Format as time series
option unchecked) for theShow
option selectAll Values
. - For time series data (
Format as time series
option checked) for theShow
option selectCalculate
and choose a reducer function.
Please refer to our Documentation and Analytics Api Reference for more information or reach out to us at bitmovin.com.
This project was generated with yarn create @grafana/plugin@4.3.0
.
-
Install dependencies
yarn install
-
Build plugin in development mode and run in watch mode
yarn run dev
-
Build plugin in production mode
yarn run build
-
Run the tests (using Jest)
# Runs the tests and watches for changes, requires git init first yarn run test # Exits after running all the tests yarn run test:ci
-
Spin up a Grafana instance and run the plugin inside it (using Docker)
yarn run server
-
Run the E2E tests (using Playwright)
# Spins up a Grafana instance first that we tests against yarn run server # Starts the tests yarn run e2e
-
Run the linter
yarn run lint # or yarn run lint:fix