---
title: "ITRS Group Obcerv data source plugin for Grafana"
description: "Data source for ITRS Group observability platform. ITRS Group Obcerv data source plugin for Grafana by ITRS Group. See install steps and the changelog."
---

> This is the Markdown version of https://grafana.com/grafana/plugins/itrs-obcerv-datasource/

# ITRS Group Obcerv

- Developer: ITRS Group
- Version: 2.1.0
- [Installation](https://grafana.com/grafana/plugins/itrs-obcerv-datasource/installation.md)
- [Change log](https://grafana.com/grafana/plugins/itrs-obcerv-datasource/changelog.md)

![config-empty](https://grafana.com/api/plugins/itrs-obcerv-datasource/versions/2.1.0/images/img/config-empty-panel.png)

![query-empty](https://grafana.com/api/plugins/itrs-obcerv-datasource/versions/2.1.0/images/img/query-empty-panel.png)

![variable-empty](https://grafana.com/api/plugins/itrs-obcerv-datasource/versions/2.1.0/images/img/variable-empty-panel.png)

![add-variable](https://grafana.com/api/plugins/itrs-obcerv-datasource/versions/2.1.0/images/img/add-variable-panel.png)

![query-use-variable](https://grafana.com/api/plugins/itrs-obcerv-datasource/versions/2.1.0/images/img/query-use-variable-panel.png)

# ITRS Group Obcerv data source for Grafana

## Datasource Usage

### Configure the data source

1. Go to Configuration > Data sources section

2. Click on "Add data source" and look for "ITRS Group Obcerv" one and select it

ITRS Group Obcerv Settings

| Field                 | Description                                                                                   |
| --------------------- | --------------------------------------------------------------------------------------------- |
| Obcerv API            | Host and Port of the Obcerv REST API, i.e. `https://local.itrslab.com/obcerv-app-api-gateway` |
| Skip tls verification | If you want to skip the TLS verification                                                      |

You can also click on the _Default_ switch on the top of the screen if you want it to appear as default datasource.

Click on _Save and test_ to save the configuration

(You can see the official Grafana doc to add a datasource [here](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/))

### Query the data source

| Field           | Description                                                                                                                                                          |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Alias           | Displayed in the legend to identify a time serie                                                                                                                     |
| Metric          | The name of the metric                                                                                                                                               |
| Filter          | Filters will be available for auto-completion when composing a query, they are in the form _attribute/dimension="value"_. For example _pod="collection-agent-sx6cv"_ |
| Group by        | Dimensions or attributes to group by the results                                                                                                                     |
| Buckets         | Used to populate the `Buckets` in `BucketRequest`                                                                                                                    |
| Bucket function | Used to populate the `Function` in `BucketRequest`                                                                                                                   |
| Forecast        | If enabled, returns the forecast of the selected metric. Please note that it only works if the filter returns only one metric                                        |

- Note: Stat visualization, to use status metrics on "Options Panel", "Value options" section, select in Fields drop-down _All fields_ in order to display not only numeric fields.

### Templates and variables

You can add variables to your dashboard. To add a new ITRS Group Obcerv query variable, go to dashboards settings, and click on _Add variable_ in _Variables_ section.

Required fields:

General

| Field | Value                                                                                                        |
| ----- | ------------------------------------------------------------------------------------------------------------ |
| Name  | Variable name, this name will be used in the data source to refer to the variable with the $ symbol in front |
| Type  | Query                                                                                                        |

Query Options

| Field       | Value                                                                       |
| ----------- | --------------------------------------------------------------------------- |
| Data source | ITRS Group Obcerv                                                           |
| Query       | syntax: {"name":"dimension-or-attribute"}, example: { "name": "container" } |

- Note: Selection options, check multi-value switch if you want to choose more than one value for the variable

If you want to see a preview of the values, click on _Update_.

Then you can filter the widgets you want to depend on the variable using the name with a `$`:

```json
{ "name": "$<variable-name>" }
```

And you will be able to use the [variable in your dashboard](https://grafana.com/docs/grafana/latest/variables/).

#### Variables with filter

The variables can be filtered by another variable, a dimension or an attribute. The syntax to populate variables with a filter is:

```json
{ "name": "<dimension-or-attribute>", "filter": [{ "name": "<dimension-or-attribute>", "value": "$variableName1" }] }
```

The `filter` is a list of objects with the fields `name` and `value`. The `name` must be an attribute or dimension name, the value can be a specific value or the name of another variable with the `$`preffix. For example, if it exists a variable named `kubecontainer`, the query could be:

```json
{ "name": "pod", "filter": [{ "name": "container", "value": "$kubecontainer" }] }
```

This will allow variable chaining so the values of some variables can be used to filter other _dependant_ variables.

Some useful links with information about query variables:

[Add a query variable](https://grafana.com/docs/grafana/latest/variables/variable-types/add-query-variable/)

[Variable syntax](https://grafana.com/docs/grafana/latest/variables/syntax/)

[Templates and variables](https://grafana.com/docs/grafana/latest/variables/)
