Grafana integration

​
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
POST /rpc
content-type: application/edn
​
{:method aidbox.metrics/update-aidbox-dashboard}
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
POST /rpc
content-type: application/edn
​
{:method aidbox.metrics/update-cluster-dashboard}
aidbox.metrics/get-aidbox-dashboard
Generates dashboards as a JSON 
Parameters
Result
Expects no parameters
Grafana dashboard JSON:
{
 "uid": "metrics-dev",
 "title": "Aidbox metrics dev",
 // omitted
}
Required Prometheus exporters:
kube-state-metrics
node-exporter
cadvisor
Request example
POST /rpc
content-type: application/json
accept: application/json
​
{"method": "aidbox.metrics/get-aidbox-dashboard"}

Aidbox Metrics Server

Next - Core Modules

Logging & Audit

Last modified 3mo ago

Copy link

Edit on GitHub

On this page

Configuration

RPC Methods

aidbox.metrics/update-aidbox-dashboard

aidbox.metrics/update-cluster-dashboard

aidbox.metrics/get-aidbox-dashboard