Set-up Grafana integration (deprecated)

Aidbox metrics has integration with Grafana, which can generate dashboards and upload them to Grafana

Grafana integration is deprecated since 2601.

Use the new official Aidbox dashboard: 24752-aidbox .

Before setting up Grafana integration, ensure you have set up the Aidbox Metrics Server. Check the guide below on how to do it.

use-aidbox-metrics-server.md

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 variableDescription
AIDBOX_BOX_IDProvided instance name will be attached to metrics labels. Required for monitoring of multiple Aidbox instances.
BOX_METRICS_GRAFANA_URLGrafana instance url
BOX_METRICS_GRAFANA_USERGrafana user name
BOX_METRICS_GRAFANA_PASSWORDGrafana user password

RPC Methods

Сreated dashboards will be placed in the aidboxgen folder

aidbox.metrics/update-aidbox-dashboard

Generates dashboards with instance-specific metrics

datasource (Optional) - specify prometheus like datasource name. Default: Prometheus

kibana-url (Optional) - specify Kibana base url for generating a drill-down link to Kibana.

Request example

POST /rpc
content-type: application/edn

{:method aidbox.metrics/update-aidbox-dashboard
 :params {:datasource "My Prometheus Datasource name"
          :kibana-url "https://my.kibana.url.com"}}

aidbox.metrics/update-cluster-dashboard

Generates dashboards with cluster-specific metrics

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

Expects no parameters

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"}

Last updated: