Skip to content

kumahq/kuma-grafana-datasource

kuma-grafana-datasource

A grafana datasource plugin for Kuma

Build

This datasource will enable you to do some queries to inspect Kuma. It also has a mesh-graph query type which will render a NodeGraph panel similar to what Kiali provides.

How to install

[plugins]
allow_loading_unsigned_plugins = "kumahq-kuma-datasource"

How to configure

Manually

It's as easy as any datasource, you can follow the instructions on the Grafana docs.

The configuration for the datasource will look like:

Kuma datasource configuration

You'll have to set the url to your global control plane api and pick an already configured prometheus datasource in the dropdown.

Once this is done you can go in explore and pick the kuma-datasource with the mesh-graph query type:

Mesh graph example

With provisioner

Add to the datasource configuration:

kuma >= 1.7.0

    datasources:
      - name: Prometheus
        type: prometheus
        access: proxy
        url: http://prometheus-server.mesh-observability
      - name: Kuma
        type: kumahq-kuma-datasource
        url: http://kuma-control-plane.kuma-system:5681
        jsonData:
          prometheusDataSourceId: "1"

kuma < 1.7.0

    datasources:
      - name: Prometheus
        type: prometheus
        access: proxy
        url: http://prometheus-server.kuma-metrics
      - name: Kuma
        type: kumahq-kuma-datasource
        url: http://kuma-control-plane.kuma-system:5681
        jsonData:
          prometheusDataSourceId: "1"

With kumactl

kumactl >= 1.7.0

If you use kumactl install observability with a version of kumactl >= 1.7.0 the plugin will be setup automatically.

kumactl 1.3.0-1.6.*

If you use kumactl install metrics with a version of kumactl 1.3.0-1.6.* the plugin will be setup automatically.

Future features

  • Add links for logs and traces.
  • Add possibility to filter services.
  • Add query type for dataplane inspection.
  • Support non HTTP services.

File an issue if you want something :).