Grafana integration
Aidbox metrics has integration with Grafana, which can generate dashboards and upload it to Grafana
Please start a discussion or contact us if you have questions, feedback, or suggestions.

Configuration

You need to set up the following environment variables:
Environment variable
Description
BOX_INSTANCE_NAME
Provided instance name will be attached to metrics labels. Required for monitoring of multiple Aidbox instances.
BOX_METRICS_GRAFANA_URL
Grafana instance url
BOX_METRICS_GRAFANA_USER
Grafana user name
BOX_METRICS_GRAFANA_PASSWORD
Grafana user password

RPC Methods

Сreated dashboards will be placed in the aidboxgen folder

aidbox.metrics/update-aidbox-dashboard

Generates dashboards with instance-specific metrics
Parameters
Result
Error
Expects no parameters
status - "200 OK"
error - "Provide following environment variables: BOX_METRICS_GRAFANA_USER, BOX_METRICS_GRAFANA_PASSWORD, BOX_METRICS_GRAFANA_URL"
error - <Grafana internal error>
"Prometheus" datasource is required

Request example

1
POST /rpc
2
content-type: application/edn
3
4
{:method aidbox.metrics/update-aidbox-dashboard}
Copied!

aidbox.metrics/update-cluster-dashboard

Generates dashboards with cluster-specific metrics
Parameters
Result
Error
status - "200 OK"
error - "Provide following environment variables: BOX_METRICS_GRAFANA_USER, BOX_METRICS_GRAFANA_PASSWORD, BOX_METRICS_GRAFANA_URL"
error - <Grafana internal error>
Required Prometheus exporters:
  • kube-state-metrics
  • node-exporter
  • cadvisor

Request example

1
POST /rpc
2
content-type: application/edn
3
4
{:method aidbox.metrics/update-cluster-dashboard}
Copied!

aidbox.metrics/get-aidbox-dashboard

Generates dashboards as a JSON
Parameters
Result
Expects no parameters
Grafana dashboard JSON:
1
{
2
"uid": "metrics-dev",
3
"title": "Aidbox metrics dev",
4
// omitted
5
}
Copied!
Required Prometheus exporters:
  • kube-state-metrics
  • node-exporter
  • cadvisor

Request example

1
POST /rpc
2
content-type: application/json
3
accept: application/json
4
5
{"method": "aidbox.metrics/get-aidbox-dashboard"}
Copied!