Skip to content

Latest commit

 

History

History
140 lines (100 loc) · 3.67 KB

grafana-integration.md

File metadata and controls

140 lines (100 loc) · 3.67 KB
description
Aidbox metrics has integration with Grafana, which can generate dashboards and upload it to Grafana

Set-up Grafana integration

{% hint style="info" %} Please start a discussion or contact us if you have questions, feedback, or suggestions. {% endhint %}

Configuration

You need to set up the following environment variables:

Environment variable Description
AIDBOX_BOX_ID 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

{% hint style="info" %} Сreated dashboards will be placed in the aidboxgen folder {% endhint %}

aidbox.metrics/update-aidbox-dashboard

Generates dashboards with instance-specific metrics

{% tabs %} {% tab title="Parameters" %} datasource (Optional) - specify prometheus like datasource name. Default: Prometheus

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

{% tab title="Result" %} status - "200 OK" {% endtab %}

{% tab title="Error" %} error - "Provide following environment variables: BOX_METRICS_GRAFANA_USER, BOX_METRICS_GRAFANA_PASSWORD, BOX_METRICS_GRAFANA_URL"

error - <Grafana internal error> {% endtab %} {% endtabs %}

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

Grafana Aidbox Dashboard

aidbox.metrics/update-cluster-dashboard

Generates dashboards with cluster-specific metrics

{% tabs %} {% tab title="Parameters" %}

{% endtab %}

{% tab title="Result" %} status - "200 OK" {% endtab %}

{% tab title="Error" %} error - "Provide following environment variables: BOX_METRICS_GRAFANA_USER, BOX_METRICS_GRAFANA_PASSWORD, BOX_METRICS_GRAFANA_URL"

error - <Grafana internal error> {% endtab %} {% endtabs %}

{% hint style="warning" %} Required Prometheus exporters:

  • kube-state-metrics
  • node-exporter
  • cadvisor {% endhint %}

Request example

POST /rpc
content-type: application/edn

{:method aidbox.metrics/update-cluster-dashboard}

aidbox.metrics/get-aidbox-dashboard

Generates dashboards as a JSON

{% tabs %} {% tab title="Parameters" %} Expects no parameters {% endtab %}

{% tab title="Result" %} Grafana dashboard JSON:

{
 "uid": "metrics-dev",
 "title": "Aidbox metrics dev",
 // omitted
}

{% endtab %} {% endtabs %}

{% hint style="warning" %} Required Prometheus exporters:

  • kube-state-metrics
  • node-exporter
  • cadvisor {% endhint %}

Request example

POST /rpc
content-type: application/json
accept: application/json

{"method": "aidbox.metrics/get-aidbox-dashboard"}