Add 1.x Grafana docs (#2232)
* updated influxdb oss and cloud grafana/influxql instructions, closes #1340, closes #2165 * updated grafana cloud instructions to use token auth * updated cloud grafana config screenshot * show auth options with influxql in grafana doc * added tab onload js, WIP grafana rework * updated content for influxql in grafana * minor updates to grafana doc, closes #2211 * added information about downloading and configuring the influx cli to cloud grafana doc * minor update in cloud grafana doc * updated grafana influxql decision tree * fixed some typos * Apply suggestions from code review Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com> * addressed PR feedback * added updates to grafana * scaffolding for grafana doc in 1.7 * add grafana docs for influxdb 1.7 and 1.8, closes influxdata/DAR#125 * updates to 1.x grafana docs * added grafana docs to enterprise 1.7 and 1.8, closes influxdata/DAR#107 * adjusted menu order of enterprise tools section * updated enterprise grafana docs to address PR feedback * added information about RPs and more examples, closes #2215 Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>pull/2245/head
parent
4660f6c020
commit
8eb9cb9211
|
@ -0,0 +1,17 @@
|
||||||
|
---
|
||||||
|
title: InfluxDB Enterprise tools
|
||||||
|
description: >
|
||||||
|
Learn more about available tools for working with InfluxDB Enterprise.
|
||||||
|
menu:
|
||||||
|
enterprise_influxdb_1_7:
|
||||||
|
name: Tools
|
||||||
|
weight: 70
|
||||||
|
---
|
||||||
|
|
||||||
|
Use the following tools to work with InfluxDB Enterprise:
|
||||||
|
|
||||||
|
{{< children >}}
|
||||||
|
|
||||||
|
## InfluxDB open source tools
|
||||||
|
Tools built for InfluxDB OSS v1.8 also work with InfluxDB Enterprise v1.7.
|
||||||
|
For more information, see [InfluxDB tools](/influxdb/v1.7/tools/).
|
|
@ -0,0 +1,79 @@
|
||||||
|
---
|
||||||
|
title: Use Grafana with InfluxDB Enterprise
|
||||||
|
seotitle: Use Grafana with InfluxDB Enterprise v1.7
|
||||||
|
description: >
|
||||||
|
Configure Grafana to query and visualize data from InfluxDB Enterprise v1.7.
|
||||||
|
menu:
|
||||||
|
enterprise_influxdb_1_7:
|
||||||
|
name: Grafana
|
||||||
|
weight: 60
|
||||||
|
parent: Tools
|
||||||
|
canonical: /{{< latest "influxdb" >}}/tools/grafana/
|
||||||
|
---
|
||||||
|
|
||||||
|
Use [Grafana](https://grafana.com/) or [Grafana Cloud](https://grafana.com/products/cloud/)
|
||||||
|
to visualize data from your **InfluxDB Enterprise v1.7** instance.
|
||||||
|
|
||||||
|
{{% note %}}
|
||||||
|
The instructions in this guide require **Grafana Cloud** or **Grafana v7.1+**.
|
||||||
|
For information about using InfluxDB with other versions of Grafana,
|
||||||
|
see the [Grafana documentation](https://grafana.com/docs/grafana/v7.0/features/datasources/influxdb/).
|
||||||
|
{{% /note %}}
|
||||||
|
|
||||||
|
1. [Set up an InfluxDB Enterprise cluster](/enterprise_influxdb/v1.7/install-and-deploy/).
|
||||||
|
2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or
|
||||||
|
[download and install Grafana](https://grafana.com/grafana/download).
|
||||||
|
3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally,
|
||||||
|
[start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit
|
||||||
|
`http://localhost:3000` in your browser.
|
||||||
|
4. In the left navigation of the Grafana UI, hover over the gear
|
||||||
|
icon to expand the **Configuration** section. Click **Data Sources**.
|
||||||
|
5. Click **Add data source**.
|
||||||
|
6. Select **InfluxDB** from the list of available data sources.
|
||||||
|
7. On the **Data Source configuration page**, enter a **name** for your InfluxDB data source.
|
||||||
|
8. Under **Query Language**, select one of the following:
|
||||||
|
|
||||||
|
{{< tabs-wrapper >}}
|
||||||
|
{{% tabs %}}
|
||||||
|
[InfluxQL](#)
|
||||||
|
[Flux](#)
|
||||||
|
{{% /tabs %}}
|
||||||
|
{{% tab-content %}}
|
||||||
|
## Configure Grafana to use InfluxQL
|
||||||
|
|
||||||
|
With **InfluxQL** selected as the query language in your InfluxDB data source settings:
|
||||||
|
|
||||||
|
1. Under **HTTP**, enter the following:
|
||||||
|
|
||||||
|
- **URL**: Your **InfluxDB Enterprise URL** or **load balancer URL**.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
http://localhost:8086/
|
||||||
|
```
|
||||||
|
- **Access**: Server (default)
|
||||||
|
|
||||||
|
2. Under **InfluxDB Details**, enter the following:
|
||||||
|
|
||||||
|
- **Database**: your database name
|
||||||
|
- **User**: your InfluxDB Enterprise username _(if [authentication is enabled](/influxdb/v1.7/administration/authentication_and_authorization/))_
|
||||||
|
- **Password**: your InfluxDB Enterprise password _(if [authentication is enabled](/influxdb/v1.7/administration/authentication_and_authorization/))_
|
||||||
|
- **HTTP Method**: select **GET** or **POST** _(for differences between the two,
|
||||||
|
see the [query HTTP endpoint documentation](/influxdb/v1.7/tools/api/#query-http-endpoint))_
|
||||||
|
|
||||||
|
3. Provide a **[Min time interval](https://grafana.com/docs/grafana/latest/datasources/influxdb/#min-time-interval)**
|
||||||
|
(default is 10s).
|
||||||
|
|
||||||
|
{{< img-hd src="/img/enterprise/1-7-tools-grafana-influxql.png" />}}
|
||||||
|
|
||||||
|
4. Click **Save & Test**. Grafana attempts to connect to InfluxDB Enterprise and returns
|
||||||
|
the result of the test.
|
||||||
|
{{% /tab-content %}}
|
||||||
|
|
||||||
|
{{% tab-content %}}
|
||||||
|
## Configure Grafana to use Flux
|
||||||
|
To query InfluxDB Enterprise using Flux from Grafana, **upgrade to InfluxDB Enterprise 1.8.1+**:
|
||||||
|
|
||||||
|
- [Upgrade to InfluxDB Enterprise 1.8.x](/enterprise_influxdb/v1.8/administration/upgrading/)
|
||||||
|
- [Use Grafana with InfluxDB Enterprise 1.8](/enterprise_influxdb/v1.8/tools/grafana/).
|
||||||
|
{{% /tab-content %}}
|
||||||
|
{{< /tabs-wrapper >}}
|
|
@ -0,0 +1,17 @@
|
||||||
|
---
|
||||||
|
title: InfluxDB Enterprise tools
|
||||||
|
description: >
|
||||||
|
Learn more about available tools for working with InfluxDB Enterprise.
|
||||||
|
menu:
|
||||||
|
enterprise_influxdb_1_8:
|
||||||
|
name: Tools
|
||||||
|
weight: 70
|
||||||
|
---
|
||||||
|
|
||||||
|
Use the following tools to work with InfluxDB Enterprise:
|
||||||
|
|
||||||
|
{{< children >}}
|
||||||
|
|
||||||
|
## InfluxDB open source tools
|
||||||
|
Tools built for InfluxDB OSS v1.8 also work with InfluxDB Enterprise v1.8.
|
||||||
|
For more information, see [InfluxDB tools](/influxdb/v1.8/tools/).
|
|
@ -0,0 +1,128 @@
|
||||||
|
---
|
||||||
|
title: Use Grafana with InfluxDB Enterprise
|
||||||
|
seotitle: Use Grafana with InfluxDB Enterprise v1.8
|
||||||
|
description: >
|
||||||
|
Configure Grafana to query and visualize data from InfluxDB Enterprise v1.8.
|
||||||
|
menu:
|
||||||
|
enterprise_influxdb_1_8:
|
||||||
|
name: Grafana
|
||||||
|
weight: 60
|
||||||
|
parent: Tools
|
||||||
|
canonical: /{{< latest "influxdb" >}}/tools/grafana/
|
||||||
|
---
|
||||||
|
|
||||||
|
Use [Grafana](https://grafana.com/) or [Grafana Cloud](https://grafana.com/products/cloud/)
|
||||||
|
to visualize data from your **InfluxDB Enterprise v1.8** instance.
|
||||||
|
|
||||||
|
{{% note %}}
|
||||||
|
#### Required
|
||||||
|
- The instructions in this guide require **Grafana Cloud** or **Grafana v7.1+**.
|
||||||
|
For information about using InfluxDB with other versions of Grafana,
|
||||||
|
see the [Grafana documentation](https://grafana.com/docs/grafana/v7.0/features/datasources/influxdb/).
|
||||||
|
- To use **Flux**, use **InfluxDB Enterprise 1.8.1+** and [enable Flux](/influxdb/v1.8/flux/installation/)
|
||||||
|
in your InfluxDB data node configuration file.
|
||||||
|
{{% /note %}}
|
||||||
|
|
||||||
|
1. [Set up an InfluxDB Enterprise cluster](/enterprise_influxdb/v1.8/install-and-deploy/).
|
||||||
|
2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or
|
||||||
|
[download and install Grafana](https://grafana.com/grafana/download).
|
||||||
|
3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally,
|
||||||
|
[start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit
|
||||||
|
`http://localhost:3000` in your browser.
|
||||||
|
4. In the left navigation of the Grafana UI, hover over the gear
|
||||||
|
icon to expand the **Configuration** section. Click **Data Sources**.
|
||||||
|
5. Click **Add data source**.
|
||||||
|
6. Select **InfluxDB** from the list of available data sources.
|
||||||
|
7. On the **Data Source configuration page**, enter a **name** for your InfluxDB data source.
|
||||||
|
8. Under **Query Language**, select one of the following:
|
||||||
|
|
||||||
|
{{< tabs-wrapper >}}
|
||||||
|
{{% tabs %}}
|
||||||
|
[InfluxQL](#)
|
||||||
|
[Flux](#)
|
||||||
|
{{% /tabs %}}
|
||||||
|
<!--------------------------- BEGIN INFLUXQL CONTENT -------------------------->
|
||||||
|
{{% tab-content %}}
|
||||||
|
## Configure Grafana to use InfluxQL
|
||||||
|
|
||||||
|
With **InfluxQL** selected as the query language in your InfluxDB data source settings:
|
||||||
|
|
||||||
|
1. Under **HTTP**, enter the following:
|
||||||
|
|
||||||
|
- **URL**: Your **InfluxDB Enterprise URL** or **load balancer URL**.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
http://localhost:8086/
|
||||||
|
```
|
||||||
|
- **Access**: Server (default)
|
||||||
|
|
||||||
|
2. Under **InfluxDB Details**, enter the following:
|
||||||
|
|
||||||
|
- **Database**: your database name
|
||||||
|
- **User**: your InfluxDB Enterprise username _(if [authentication is enabled](/influxdb/v1.8/administration/authentication_and_authorization/))_
|
||||||
|
- **Password**: your InfluxDB Enterprise password _(if [authentication is enabled](/influxdb/v1.8/administration/authentication_and_authorization/))_
|
||||||
|
- **HTTP Method**: select **GET** or **POST** _(for differences between the two,
|
||||||
|
see the [query HTTP endpoint documentation](/influxdb/v1.8/tools/api/#query-http-endpoint))_
|
||||||
|
|
||||||
|
3. Provide a **[Min time interval](https://grafana.com/docs/grafana/latest/datasources/influxdb/#min-time-interval)**
|
||||||
|
(default is 10s).
|
||||||
|
|
||||||
|
{{< img-hd src="/img/enterprise/1-7-tools-grafana-influxql.png" />}}
|
||||||
|
|
||||||
|
4. Click **Save & Test**. Grafana attempts to connect to InfluxDB Enterprise and returns
|
||||||
|
the result of the test.
|
||||||
|
{{% /tab-content %}}
|
||||||
|
<!---------------------------- END INFLUXQL CONTENT --------------------------->
|
||||||
|
<!----------------------------- BEGIN FLUX CONTENT ---------------------------->
|
||||||
|
{{% tab-content %}}
|
||||||
|
## Configure Grafana to use Flux
|
||||||
|
|
||||||
|
With **Flux** selected as the query language in your InfluxDB data source,
|
||||||
|
configure your InfluxDB connection:
|
||||||
|
|
||||||
|
1. Ensure [Flux is enabled](/influxdb/v1.8/flux/installation/) in InfluxDB Enterprise data nodes.
|
||||||
|
|
||||||
|
2. Under **Connection**, enter the following:
|
||||||
|
|
||||||
|
- **URL**: Your **InfluxDB Enterprise URL** or **load balancer URL**.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
http://localhost:8086/
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Organization**: Provide an arbitrary value.
|
||||||
|
- **Token**: Provide your InfluxDB Enterprise username and password using the following syntax:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Syntax
|
||||||
|
username:password
|
||||||
|
|
||||||
|
# Example
|
||||||
|
johndoe:mY5uP3rS3crE7pA5Sw0Rd
|
||||||
|
```
|
||||||
|
|
||||||
|
We recommend [enabling authentication](/influxdb/v1.8/administration/authentication_and_authorization/)
|
||||||
|
on all InfluxDB Enterprise clusters. If you choose to leave authentication disabled,
|
||||||
|
leave this field blank.
|
||||||
|
|
||||||
|
- **Default Bucket**: Provide a default database and retention policy combination
|
||||||
|
using the following syntax:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Syntax
|
||||||
|
database-name/retention-policy-name
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
example-db/example-rp
|
||||||
|
telegraf/autogen
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Min time interval**: [Grafana minimum time interval](https://grafana.com/docs/grafana/latest/features/datasources/influxdb/#min-time-interval).
|
||||||
|
|
||||||
|
{{< img-hd src="/img/enterprise/1-8-tools-grafana-flux.png" />}}
|
||||||
|
|
||||||
|
3. Click **Save & Test**. Grafana attempts to connect to InfluxDB Enterprise and returns
|
||||||
|
the result of the test.
|
||||||
|
{{% /tab-content %}}
|
||||||
|
<!------------------------------ END FLUX CONTENT ----------------------------->
|
||||||
|
{{< /tabs-wrapper >}}
|
|
@ -105,6 +105,10 @@ Use the [`influx v1 dbrp create` command](/influxdb/cloud/reference/cli/influx/v
|
||||||
command to create a database/retention policy (DBRP) mapping that associates a database
|
command to create a database/retention policy (DBRP) mapping that associates a database
|
||||||
and retention policy combination with an InfluxDB Cloud [bucket](/influxdb/cloud/reference/glossary/#bucket).
|
and retention policy combination with an InfluxDB Cloud [bucket](/influxdb/cloud/reference/glossary/#bucket).
|
||||||
|
|
||||||
|
DBRP mappings do not affect the retention period of the target bucket.
|
||||||
|
These mappings allow queries following InfluxDB 1.x conventions to successfully
|
||||||
|
query InfluxDB Cloud buckets.
|
||||||
|
|
||||||
{{% note %}}
|
{{% note %}}
|
||||||
##### Automatically create DBRP mappings on write
|
##### Automatically create DBRP mappings on write
|
||||||
When using the InfluxDB 1.x compatibility API to write data to InfluxDB Cloud,
|
When using the InfluxDB 1.x compatibility API to write data to InfluxDB Cloud,
|
||||||
|
@ -116,9 +120,19 @@ For more information, see [Database and retention policy mapping – Writing dat
|
||||||
Provide the following:
|
Provide the following:
|
||||||
|
|
||||||
- database name
|
- database name
|
||||||
- retention policy
|
- retention policy name _(not retention period)_
|
||||||
- [bucket ID](/influxdb/cloud/organizations/buckets/view-buckets/)
|
- [bucket ID](/influxdb/cloud/organizations/buckets/view-buckets/)
|
||||||
|
- _(optional)_ `--default` flag if you want the retention policy to be the default retention
|
||||||
|
policy for the specified database
|
||||||
|
|
||||||
|
#### Examples
|
||||||
|
|
||||||
|
{{< code-tabs-wrapper >}}
|
||||||
|
{{% code-tabs %}}
|
||||||
|
[DB with one RP](#)
|
||||||
|
[DB with multiple RPs](#)
|
||||||
|
{{% /code-tabs %}}
|
||||||
|
{{< code-tab-content >}}
|
||||||
```sh
|
```sh
|
||||||
influx v1 dbrp create \
|
influx v1 dbrp create \
|
||||||
--db example-db \
|
--db example-db \
|
||||||
|
@ -126,6 +140,28 @@ influx v1 dbrp create \
|
||||||
--bucket-id 00xX00o0X001 \
|
--bucket-id 00xX00o0X001 \
|
||||||
--default
|
--default
|
||||||
```
|
```
|
||||||
|
{{< /code-tab-content >}}
|
||||||
|
{{< code-tab-content >}}
|
||||||
|
```sh
|
||||||
|
# Create telegraf/autogen DBRP mapping with autogen
|
||||||
|
# as the default RP for the telegraf DB
|
||||||
|
|
||||||
|
influx v1 dbrp create \
|
||||||
|
--db telegraf \
|
||||||
|
--rp autogen \
|
||||||
|
--bucket-id 00xX00o0X001 \
|
||||||
|
--default
|
||||||
|
|
||||||
|
# Create telegraf/downsampled-daily DBRP mapping that
|
||||||
|
# writes to a different bucket
|
||||||
|
|
||||||
|
influx v1 dbrp create \
|
||||||
|
--db telegraf \
|
||||||
|
--rp downsampled-daily \
|
||||||
|
--bucket-id 00xX00o0X002
|
||||||
|
```
|
||||||
|
{{< /code-tab-content >}}
|
||||||
|
{{< /code-tabs-wrapper >}}
|
||||||
|
|
||||||
_For more information about DBRP mapping, see [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/)._
|
_For more information about DBRP mapping, see [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/)._
|
||||||
|
|
||||||
|
|
|
@ -1,12 +1,81 @@
|
||||||
---
|
---
|
||||||
title: Grafana graphs and dashboards
|
title: Use Grafana with InfluxDB
|
||||||
|
seotitle: Use Grafana with InfluxDB v1.7
|
||||||
|
description: >
|
||||||
|
Configure Grafana to query and visualize data from InfluxDB v1.7.
|
||||||
menu:
|
menu:
|
||||||
influxdb_1_7:
|
influxdb_1_7:
|
||||||
url: "https://grafana.com/docs/grafana/latest/features/datasources/influxdb/"
|
name: Grafana
|
||||||
weight: 60
|
weight: 60
|
||||||
parent: Tools
|
parent: Tools
|
||||||
v2: /influxdb/v2.0/tools/grafana/
|
v2: /influxdb/v2.0/tools/grafana/
|
||||||
|
canonical: /{{< latest "influxdb" >}}/tools/grafana/
|
||||||
---
|
---
|
||||||
|
|
||||||
Please see [Grafana's InfluxDB documentation](https://grafana.com/docs/grafana/latest/features/datasources/influxdb/).
|
Use [Grafana](https://grafana.com/) or [Grafana Cloud](https://grafana.com/products/cloud/)
|
||||||
|
to visualize data from your **InfluxDB v1.7** instance.
|
||||||
|
|
||||||
|
{{% note %}}
|
||||||
|
The instructions in this guide require **Grafana Cloud** or **Grafana v7.1+**.
|
||||||
|
For information about using InfluxDB with other versions of Grafana,
|
||||||
|
see the [Grafana documentation](https://grafana.com/docs/grafana/v7.0/features/datasources/influxdb/).
|
||||||
|
{{% /note %}}
|
||||||
|
|
||||||
|
1. [Start InfluxDB](/influxdb/v1.7/get-started/).
|
||||||
|
2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or
|
||||||
|
[download and install Grafana](https://grafana.com/grafana/download).
|
||||||
|
3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally,
|
||||||
|
[start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit
|
||||||
|
`http://localhost:3000` in your browser.
|
||||||
|
4. In the left navigation of the Grafana UI, hover over the gear
|
||||||
|
icon to expand the **Configuration** section. Click **Data Sources**.
|
||||||
|
5. Click **Add data source**.
|
||||||
|
6. Select **InfluxDB** from the list of available data sources.
|
||||||
|
7. On the **Data Source configuration page**, enter a **name** for your InfluxDB data source.
|
||||||
|
8. Under **Query Language**, select one of the following:
|
||||||
|
|
||||||
|
{{< tabs-wrapper >}}
|
||||||
|
{{% tabs %}}
|
||||||
|
[InfluxQL](#)
|
||||||
|
[Flux](#)
|
||||||
|
{{% /tabs %}}
|
||||||
|
{{% tab-content %}}
|
||||||
|
## Configure Grafana to use InfluxQL
|
||||||
|
|
||||||
|
With **InfluxQL** selected as the query language in your InfluxDB data source settings:
|
||||||
|
|
||||||
|
1. Under **HTTP**, enter the following:
|
||||||
|
|
||||||
|
- **URL**: Your **InfluxDB URL**.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
http://localhost:8086/
|
||||||
|
```
|
||||||
|
- **Access**: Server (default)
|
||||||
|
|
||||||
|
2. Under **InfluxDB Details**, enter the following:
|
||||||
|
|
||||||
|
- **Database**: your database name
|
||||||
|
- **User**: your InfluxDB username _(if [authentication is enabled](/influxdb/v1.7/administration/authentication_and_authorization/))_
|
||||||
|
- **Password**: your InfluxDB password _(if [authentication is enabled](/influxdb/v1.7/administration/authentication_and_authorization/))_
|
||||||
|
- **HTTP Method**: select **GET** or **POST** _(for differences between the two,
|
||||||
|
see the [query HTTP endpoint documentation](/influxdb/v1.7/tools/api/#query-http-endpoint))_
|
||||||
|
|
||||||
|
3. Provide a **[Min time interval](https://grafana.com/docs/grafana/latest/datasources/influxdb/#min-time-interval)**
|
||||||
|
(default is 10s).
|
||||||
|
|
||||||
|
{{< img-hd src="/img/influxdb/2-0-tools-grafana-influxql.png" />}}
|
||||||
|
|
||||||
|
4. Click **Save & Test**. Grafana attempts to connect to InfluxDB and returns
|
||||||
|
the result of the test.
|
||||||
|
|
||||||
|
{{% /tab-content %}}
|
||||||
|
|
||||||
|
{{% tab-content %}}
|
||||||
|
## Configure Grafana to use Flux
|
||||||
|
To query InfluxDB using Flux from Grafana, **upgrade to InfluxDB 1.8.1+**:
|
||||||
|
|
||||||
|
- [Upgrade to InfluxDB 1.8.x](/influxdb/v1.8/administration/upgrading/)
|
||||||
|
- [Use Grafana with InfluxDB 1.8](/influxdb/v1.8/tools/grafana/).
|
||||||
|
{{% /tab-content %}}
|
||||||
|
{{< /tabs-wrapper >}}
|
||||||
|
|
|
@ -1,13 +1,129 @@
|
||||||
---
|
---
|
||||||
title: Grafana graphs and dashboards
|
title: Use Grafana with InfluxDB
|
||||||
|
seotitle: Use Grafana with InfluxDB v1.8
|
||||||
description: >
|
description: >
|
||||||
See Grafana's documentation for details about Grafana graphs and dashboards.
|
Configure Grafana to query and visualize data from InfluxDB v1.8.
|
||||||
menu:
|
menu:
|
||||||
influxdb_1_8:
|
influxdb_1_8:
|
||||||
url: "https://grafana.com/docs/grafana/latest/features/datasources/influxdb/"
|
name: Grafana
|
||||||
weight: 60
|
weight: 60
|
||||||
parent: Tools
|
parent: Tools
|
||||||
v2: /influxdb/v2.0/tools/grafana/
|
v2: /influxdb/v2.0/tools/grafana/
|
||||||
|
canonical: /{{< latest "influxdb" >}}/tools/grafana/
|
||||||
---
|
---
|
||||||
|
|
||||||
Please see [Grafana's InfluxDB documentation](https://grafana.com/docs/grafana/latest/features/datasources/influxdb/).
|
Use [Grafana](https://grafana.com/) or [Grafana Cloud](https://grafana.com/products/cloud/)
|
||||||
|
to visualize data from your **InfluxDB v1.8** instance.
|
||||||
|
|
||||||
|
{{% note %}}
|
||||||
|
#### Required
|
||||||
|
- The instructions in this guide require **Grafana Cloud** or **Grafana v7.1+**.
|
||||||
|
For information about using InfluxDB with other versions of Grafana,
|
||||||
|
see the [Grafana documentation](https://grafana.com/docs/grafana/v7.0/features/datasources/influxdb/).
|
||||||
|
- To use **Flux**, use **InfluxDB 1.8.1+** and [enable Flux](/influxdb/v1.8/flux/installation/)
|
||||||
|
in your InfluxDB configuration file.
|
||||||
|
{{% /note %}}
|
||||||
|
|
||||||
|
1. [Start InfluxDB](/influxdb/v1.8/get-started/).
|
||||||
|
2. [Sign up for Grafana Cloud](https://grafana.com/products/cloud/) or
|
||||||
|
[download and install Grafana](https://grafana.com/grafana/download).
|
||||||
|
3. Visit your **Grafana Cloud user interface** (UI) or, if running Grafana locally,
|
||||||
|
[start Grafana](https://grafana.com/docs/grafana/latest/installation/) and visit
|
||||||
|
`http://localhost:3000` in your browser.
|
||||||
|
4. In the left navigation of the Grafana UI, hover over the gear
|
||||||
|
icon to expand the **Configuration** section. Click **Data Sources**.
|
||||||
|
5. Click **Add data source**.
|
||||||
|
6. Select **InfluxDB** from the list of available data sources.
|
||||||
|
7. On the **Data Source configuration page**, enter a **name** for your InfluxDB data source.
|
||||||
|
8. Under **Query Language**, select one of the following:
|
||||||
|
|
||||||
|
{{< tabs-wrapper >}}
|
||||||
|
{{% tabs %}}
|
||||||
|
[InfluxQL](#)
|
||||||
|
[Flux](#)
|
||||||
|
{{% /tabs %}}
|
||||||
|
<!--------------------------- BEGIN INFLUXQL CONTENT -------------------------->
|
||||||
|
{{% tab-content %}}
|
||||||
|
## Configure Grafana to use InfluxQL
|
||||||
|
|
||||||
|
With **InfluxQL** selected as the query language in your InfluxDB data source settings:
|
||||||
|
|
||||||
|
1. Under **HTTP**, enter the following:
|
||||||
|
|
||||||
|
- **URL**: Your **InfluxDB URL**.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
http://localhost:8086/
|
||||||
|
```
|
||||||
|
- **Access**: Server (default)
|
||||||
|
|
||||||
|
2. Under **InfluxDB Details**, enter the following:
|
||||||
|
|
||||||
|
- **Database**: your database name
|
||||||
|
- **User**: your InfluxDB username _(if [authentication is enabled](/influxdb/v1.8/administration/authentication_and_authorization/))_
|
||||||
|
- **Password**: your InfluxDB password _(if [authentication is enabled](/influxdb/v1.8/administration/authentication_and_authorization/))_
|
||||||
|
- **HTTP Method**: Select **GET** or **POST** _(for differences between the two,
|
||||||
|
see the [query HTTP endpoint documentation](/influxdb/v1.8/tools/api/#query-http-endpoint))_
|
||||||
|
|
||||||
|
3. Provide a **[Min time interval](https://grafana.com/docs/grafana/latest/datasources/influxdb/#min-time-interval)**
|
||||||
|
(default is 10s).
|
||||||
|
|
||||||
|
{{< img-hd src="/img/influxdb/2-0-tools-grafana-influxql.png" />}}
|
||||||
|
|
||||||
|
4. Click **Save & Test**. Grafana attempts to connect to InfluxDB and returns
|
||||||
|
the result of the test.
|
||||||
|
|
||||||
|
{{% /tab-content %}}
|
||||||
|
<!---------------------------- END INFLUXQL CONTENT --------------------------->
|
||||||
|
<!----------------------------- BEGIN FLUX CONTENT ---------------------------->
|
||||||
|
{{% tab-content %}}
|
||||||
|
## Configure Grafana to use Flux
|
||||||
|
|
||||||
|
With **Flux** selected as the query language in your InfluxDB data source,
|
||||||
|
configure your InfluxDB connection:
|
||||||
|
|
||||||
|
1. Ensure [Flux is enabled](/influxdb/v1.8/flux/installation/) in InfluxDB.
|
||||||
|
|
||||||
|
2. Under **Connection**, enter the following:
|
||||||
|
|
||||||
|
- **URL**: Your **InfluxDB URL**.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
http://localhost:8086/
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Organization**: Provide an arbitrary value.
|
||||||
|
- **Token**: If [InfluxDB authentication is enabled](/influxdb/v1.8/administration/authentication_and_authorization/),
|
||||||
|
provide your InfluxDB username and password using the following syntax:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Syntax
|
||||||
|
username:password
|
||||||
|
|
||||||
|
# Example
|
||||||
|
johndoe:mY5uP3rS3crE7pA5Sw0Rd
|
||||||
|
```
|
||||||
|
|
||||||
|
If authentication is not enabled, leave blank.
|
||||||
|
|
||||||
|
- **Default Bucket**: Provide a default database and retention policy combination
|
||||||
|
using the following syntax:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Syntax
|
||||||
|
database-name/retention-policy-name
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
example-db/example-rp
|
||||||
|
telegraf/autogen
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Min time interval**: [Grafana minimum time interval](https://grafana.com/docs/grafana/latest/features/datasources/influxdb/#min-time-interval).
|
||||||
|
|
||||||
|
{{< img-hd src="/img/influxdb/1-8-tools-grafana-flux.png" />}}
|
||||||
|
|
||||||
|
3. Click **Save & Test**. Grafana attempts to connect to InfluxDB and returns
|
||||||
|
the result of the test.
|
||||||
|
{{% /tab-content %}}
|
||||||
|
<!------------------------------ END FLUX CONTENT ----------------------------->
|
||||||
|
{{< /tabs-wrapper >}}
|
||||||
|
|
|
@ -132,10 +132,15 @@ influx v1 auth create \
|
||||||
--username example-user
|
--username example-user
|
||||||
```
|
```
|
||||||
{{% /expand %}}
|
{{% /expand %}}
|
||||||
{{% expand "View and create InfluxDB DBRP mappings" %}}
|
{{< expand "View and create InfluxDB DBRP mappings" >}}
|
||||||
|
|
||||||
|
When using InfluxQL to query InfluxDB, the query must specify a database and a retention policy.
|
||||||
InfluxDB DBRP mappings associate database and retention policy combinations with
|
InfluxDB DBRP mappings associate database and retention policy combinations with
|
||||||
InfluxDB 2.0 [buckets](/influxdb/v2.0/reference/glossary/#bucket)
|
InfluxDB 2.0 [buckets](/influxdb/v2.0/reference/glossary/#bucket).
|
||||||
|
|
||||||
|
DBRP mappings do not affect the retention period of the target bucket.
|
||||||
|
These mappings allow queries following InfluxDB 1.x conventions to successfully
|
||||||
|
query InfluxDB 2.0 buckets.
|
||||||
|
|
||||||
#### View existing DBRP mappings
|
#### View existing DBRP mappings
|
||||||
Use the [`influx v1 dbrp list`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/list/)
|
Use the [`influx v1 dbrp list`](/influxdb/v2.0/reference/cli/influx/v1/dbrp/list/)
|
||||||
|
@ -151,9 +156,19 @@ command to create a DBRP mapping.
|
||||||
Provide the following:
|
Provide the following:
|
||||||
|
|
||||||
- database name
|
- database name
|
||||||
- retention policy
|
- retention policy name _(not retention period)_
|
||||||
- [bucket ID](/influxdb/v2.0/organizations/buckets/view-buckets/)
|
- [bucket ID](/influxdb/v2.0/organizations/buckets/view-buckets/)
|
||||||
|
- _(optional)_ `--default` flag if you want the retention policy to be the default retention
|
||||||
|
policy for the specified database
|
||||||
|
|
||||||
|
#### Examples
|
||||||
|
|
||||||
|
{{< code-tabs-wrapper >}}
|
||||||
|
{{% code-tabs %}}
|
||||||
|
[DB with one RP](#)
|
||||||
|
[DB with multiple RPs](#)
|
||||||
|
{{% /code-tabs %}}
|
||||||
|
{{< code-tab-content >}}
|
||||||
```sh
|
```sh
|
||||||
influx v1 dbrp create \
|
influx v1 dbrp create \
|
||||||
--db example-db \
|
--db example-db \
|
||||||
|
@ -161,9 +176,31 @@ influx v1 dbrp create \
|
||||||
--bucket-id 00xX00o0X001 \
|
--bucket-id 00xX00o0X001 \
|
||||||
--default
|
--default
|
||||||
```
|
```
|
||||||
|
{{< /code-tab-content >}}
|
||||||
|
{{< code-tab-content >}}
|
||||||
|
```sh
|
||||||
|
# Create telegraf/autogen DBRP mapping with autogen
|
||||||
|
# as the default RP for the telegraf DB
|
||||||
|
|
||||||
|
influx v1 dbrp create \
|
||||||
|
--db telegraf \
|
||||||
|
--rp autogen \
|
||||||
|
--bucket-id 00xX00o0X001 \
|
||||||
|
--default
|
||||||
|
|
||||||
|
# Create telegraf/downsampled-daily DBRP mapping that
|
||||||
|
# writes to a different bucket
|
||||||
|
|
||||||
|
influx v1 dbrp create \
|
||||||
|
--db telegraf \
|
||||||
|
--rp downsampled-daily \
|
||||||
|
--bucket-id 00xX00o0X002
|
||||||
|
```
|
||||||
|
{{< /code-tab-content >}}
|
||||||
|
{{< /code-tabs-wrapper >}}
|
||||||
|
|
||||||
_For more information about DBRP mapping, see [Database and retention policy mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/)._
|
_For more information about DBRP mapping, see [Database and retention policy mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/)._
|
||||||
{{% /expand %}}
|
{{< /expand >}}
|
||||||
{{< /expand-wrapper >}}
|
{{< /expand-wrapper >}}
|
||||||
|
|
||||||
### Configure your InfluxDB connection
|
### Configure your InfluxDB connection
|
||||||
|
|
|
@ -1,9 +1,10 @@
|
||||||
|
{{ $_hugo_config := `{ "version": 1 }` }}
|
||||||
{{ $expandLabel := .Get 0 }}
|
{{ $expandLabel := .Get 0 }}
|
||||||
<div class="expand" id="{{ $expandLabel | anchorize }}">
|
<div class="expand" id="{{ $expandLabel | anchorize }}">
|
||||||
<p class="expand-label">
|
<p class="expand-label">
|
||||||
<span class="expand-toggle"></span><span>{{ $expandLabel }}</span>
|
<span class="expand-toggle"></span><span>{{ $expandLabel }}</span>
|
||||||
</p>
|
</p>
|
||||||
<div class="expand-content" style="display: none;" >
|
<div class="expand-content" style="display: none;" >
|
||||||
{{ .Inner | markdownify | safeHTML }}
|
{{ .Inner }}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 61 KiB |
Binary file not shown.
After Width: | Height: | Size: 36 KiB |
Binary file not shown.
After Width: | Height: | Size: 33 KiB |
Loading…
Reference in New Issue