Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana documentation Administration Correlations Create a new correlation

Create a new correlation

Before you begin

Make sure you have permission to add new correlations. Only users with write permissions to data sources can define new correlations.

Create a correlation in Explore’s correlations editor

To learn more, refer to Explore’s documentation about building correlations in Explore.

Create a correlation in Administration page

1. Go to the Administration section in Grafana.
2. Under Plugins and data, open the Correlations page.
3. Click the “Add” button in the top right corner.
4. Provide a label for the correlation.
5. Provide an optional description.
6. Go to the next page.
7. Provide target data source.
8. Provide target query using variables.
9. Go to the next page.
10. Provide source data source.
11. Provide results field.
12. Add transformations if you need variables that are not fields in the source data source.
13. Click “Add” to add a new transformation.
14. Select the type of a transformation.
15. Configure transformation depending on the selected type.
16. Save correlation.

You can edit correlation in the same way, but you cannot change the selected data sources.

Create a correlation with provisioning

Provision correlations by extending provisioned data sources. Correlations are defined as a subsection of the source data source configuration:

yaml Copy

datasources:
  - name: Data source name # source data source
    ...
    jsonData:
    ...
    correlations:
      - targetUID: uid
        label: "test"
        description: "..."
        config:
          type: "query"
          target:
            expr: "..."
          field: "name"
          transformations:
            - type: regex
              field: "test"
              expression: /\w+/
              mapValue: "other"
            - type: logfmt
              field: "test"

Description of provisioning properties:

targetUID

Target data source UID

label

Link label

description

Optional description

config

Config object

config.type

Correlation type. “query” is the only supported type at the moment

config.target

Target query model

config.field

Name of the field where link is shown

config.transformations (list)

List of transformation objects

transformation.type

regex, or logfmt

transformation.field

The field that will be transformed. If this is not defined, it will apply the transformation to the data from the correlation’s config.field.

transformation.expression

Regex expression (regex transformation only)

transformation.mapValue

New name of the variable from the first regex match (regex transformation only)

Determine target query model structure

When you set up a correlation with admin page you can use the target query editor. When you use provisioning you may need to know the structure of the target query which may not be well documented depending on the plugin. Here is a quick step-by-step guide on how to determine the target query model:

1. Open Explore.

2. Select the data source you want to use as the target of the correlation.

3. Open the inspector tab and select “Query”.

4. Run a sample query.

5. Inspect results.

6. Look for the “queries” list object. Each object is created using the query model structure defined by the data source. You can use the same structure in your provisioning file.

   The query model in this example is represented by the first entry in the queries list. Properties “refId” and “datasource” are added to all queries in runtime and can be omitted:

   json Copy

   {
     "scenario_id": "random_walk",
     "alias": "app",
     "seriesCount: 2
   }