Instana

Data Source

Grafana datasource plugin for Instana: Automatic Infrastructure and Application Monitoring

Instana Data Source

This is a Grafana datasource for showing metrics from Instana AI-Powered APM for dynamic applications.

Requirements

Attention: For On-premise customers Instana Release 146 is required.

Features

  • Dynamic Focus queries
  • Automatic completion for available types and metrics
  • Utilises Instana REST API
  • Security via access token

Configuration

This datasource uses the Instana REST API to query the metric values. First of all you will need to generate an API token. Use this token along with the URL for your Instana account e.g. https://prod-acme.instana.io

datasource configuration

Usage

Query Editor

empty query editor

To start, enter the Dynamic Focus query. This is exactly the same as used in the Instana dashboard; you can test your queries in Instana and then copy and paste them into Grafana. NOTE Saved filters are not currently supported by the Grafana datasource plugin.

Infrastructure built-in metrics

Once you filled in the query the available types dropdown will be automatically populated, select the type you want.

As you select the type, the available metrics dropdown will be automatically populated, select the metric you want.

If your Dynamic Focus query matches multiple instances then, the returned dataset will include metrics from all those matching instances, providing graphs with multiple plots like the example below.

multiple plot graph

Infrastructure custom metrics

To choose custom metrics matching your query you need to select "Infrastructure custom metrics" from the category dropdown, which will automatically populate the available types dropdown.

As you select the type, the available metrics dropdown will be automatically populated, select the metric you want. As there might be a huge amount of custom metrics, you can specify an optional filter to reduce to a corresponding subset.

If your Dynamic Focus query matches, the returned dataset will include metrics providing graphs like the example below.

custom plot graph

Change legend format

To adjust the legend display you can provide an own "Legend format". Supported values for replacement are:

  • $label - the entity label
  • $host - the corresponding host
  • $pid - the corresponding PID
  • $metric - the displayed metric
  • $type - the entity type
  • $service - the service label (for endpoints only)
  • $name - a label alternative
  • $index - index in the list

If no custom format is provided the default '$label (on host $host)' will be shown.

Analyze application calls

To choose application metrics you need to select "Analyze application calls" from the category dropdown. This will populate the other dropdown lists.

The "Application" dropdown will contain a list of all applications sorted by their name.

Most metrics will have more than one aggregation type (SUM, MEAN, ...) and you can choose which one to use.

It's also possible to add additional filters via "add Filter". Multiple filters are concatenated using "AND".

If your selection matches, the returned dataset will include metrics providing graphs like the example below.

application plot graph

If more then 20 metics are fetched, a warning appears that not all results are shown. Add Filter to narrow down the data.

Change legend format

To adjust the legend display you can provide an own "Legend format". Supported values for replacement are:

  • $label - the entity label
  • $application - application label
  • $metric - the displayed metric
  • $key - metric key with aggregation and rollup
  • $index - index in the list

If no custom format is provided the default label '$label ($application) $metric' will be shown.

Analyze websites

To choose EUM website metrics you need to select "Analyze websites" from the category dropdown. This will populate the other dropdown lists.

The "Website" dropdown will contain a list of all websites sorted by their pageloads.

Most metrics will have more than one aggregation type (SUM, MEAN, ...) and you can choose which one to use.

It's also possible to add additional filters via "add Filter". Multiple filters are concatenated using "AND".

If your selection matches, the returned dataset will include metrics providing graphs like the example below.

website plot graph

A default label '$label ($website) $metric' will be shown.

Change legend format

To adjust the legend display you can provide an own "Legend format". Supported values for replacement are:

  • $label - the entity label
  • $website - website label
  • $type - entity type
  • $metric - the displayed metric
  • $key - metric key with aggregation and rollup
  • $index - index in the list

If no custom format is provided the default label '$label ($website) $metric' will be shown.

Install Plugin

Version

Dependencies:
  • Grafana 3.x.x