Merge pull request #1827 from influxdata/v1-integrations
Kapacitor and Chronograf with InfluxDB Cloud and OSS 2.0pull/1885/head
Scott Anderson
GitHub
commit
4b3a74c658
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
title: Telegraf configurations
|
||||
description: >
|
||||
placeholder
|
||||
InfluxDB Cloud lets you automatically generate Telegraf configurations or upload customized
|
||||
Telegraf configurations that collect metrics and write them to InfluxDB Cloud.
|
||||
weight: 12
|
||||
menu: influxdb_cloud
|
||||
influxdb/cloud/tags: [telegraf]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: Use Chronograf with InfluxDB Cloud
|
||||
description: >
|
||||
[Chronograf](/{{< latest "chronograf" >}}/) is a data visualization and dashboarding
|
||||
tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstack](/platform/)
|
||||
that provides an InfluxQL data explorer, Kapacitor integrations, and more.
|
||||
Continue to use Chronograf with **InfluxDB Cloud** and **InfluxDB OSS 2.0** and the
|
||||
[1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/).
|
||||
menu:
|
||||
influxdb_cloud:
|
||||
name: Use Chronograf
|
||||
parent: Tools & integrations
|
||||
weight: 103
|
||||
related:
|
||||
- /{{< latest "chronograf" >}}/
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
@ -7,7 +7,7 @@ description: >
|
|||
menu:
|
||||
influxdb_cloud:
|
||||
parent: Tools & integrations
|
||||
weight: 102
|
||||
weight: 104
|
||||
influxdb/cloud/tags: [google]
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
title: Use Kapacitor with InfluxDB Cloud
|
||||
description: >
|
||||
[Kapacitor](/kapacitor/) is a data processing framework that makes it easy to
|
||||
create alerts, run ETL (Extract, Transform and Load) jobs and detect anomalies.
|
||||
Use Kapacitor with **InfluxDB Cloud**.
|
||||
menu:
|
||||
influxdb_cloud:
|
||||
name: Use Kapacitor
|
||||
parent: Tools & integrations
|
||||
weight: 102
|
||||
related:
|
||||
- /{{< latest "kapacitor" >}}/
|
||||
---
|
||||
|
||||
{{< duplicate-oss >}}
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
title: Change your password
|
||||
seotitle: Change your password in InfluxDB Cloud
|
||||
description: Change your password in InfluxDB Cloud.
|
||||
menu:
|
||||
influxdb_2_0:
|
||||
name: Change your password
|
||||
parent: Account management
|
||||
identifier: change_password_cloud
|
||||
weight: 105
|
||||
---
|
||||
|
||||
To change or reset your InfluxDB Cloud password, use the **Forgot Password** button on the [login page](https://cloud2.influxdata.com/login).
|
||||
If you are logged in, log out and then click the **Forgot Password** button.
|
||||
In the **InfluxCloud: Password Change Requested** email, click the link to choose a new password.
|
||||
|
|
@ -11,7 +11,7 @@ weight: 301
|
|||
influxdb/v2.0/tags: [influxql, query]
|
||||
list_code_example: |
|
||||
<pre>
|
||||
<span class="api get">GET</span> https://cloud2.influxdata.com/query
|
||||
<span class="api get">GET</span> http://localhost:8086/query
|
||||
</pre>
|
||||
related:
|
||||
- /influxdb/v2.0/query-data/influxql
|
||||
|
|
@ -21,7 +21,7 @@ The `/query` 1.x compatibility endpoint queries InfluxDB Cloud and InfluxDB OSS
|
|||
Use the `GET` request method to query data from the `/query` endpoint.
|
||||
|
||||
<pre>
|
||||
<span class="api get">GET</span> https://cloud2.influxdata.com/query
|
||||
<span class="api get">GET</span> http://localhost:8086/query
|
||||
</pre>
|
||||
|
||||
The `/query` compatibility endpoint use the **database** and **retention policy**
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ weight: 301
|
|||
influxdb/v2.0/tags: [write]
|
||||
list_code_example: |
|
||||
<pre>
|
||||
<span class="api post">POST</span> https://cloud2.influxdata.com/write
|
||||
<span class="api post">POST</span> http://localhost:8086/write
|
||||
</pre>
|
||||
related:
|
||||
- /influxdb/v2.0/reference/syntax/line-protocol
|
||||
|
|
@ -24,7 +24,7 @@ Use the `POST` request method to write [line protocol](/influxdb/v2.0/reference/
|
|||
to the `/write` endpoint.
|
||||
|
||||
<pre>
|
||||
<span class="api post">POST</span> https://cloud2.influxdata.com/write
|
||||
<span class="api post">POST</span> http://localhost:8086/write
|
||||
</pre>
|
||||
|
||||
## Authentication
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
title: Telegraf configurations
|
||||
description: >
|
||||
InfluxDB lets you automatically generate Telegraf configurations or upload customized
|
||||
Telegraf configurations that collect metrics and write them to InfluxDB.
|
||||
InfluxDB OSS lets you automatically generate Telegraf configurations or upload custom
|
||||
Telegraf configurations that collect metrics and write them to InfluxDB OSS.
|
||||
weight: 12
|
||||
menu: influxdb_2_0
|
||||
influxdb/v2.0/tags: [telegraf]
|
||||
|
|
@ -11,7 +11,7 @@ related:
|
|||
- /influxdb/v2.0/write-data/no-code/use-telegraf/auto-config/
|
||||
---
|
||||
|
||||
InfluxDB lets you automatically generate Telegraf configurations or upload customized
|
||||
InfluxDB lets you automatically generate Telegraf configurations or upload custom
|
||||
Telegraf configurations that collect metrics and write them to InfluxDB.
|
||||
Telegraf retrieves configurations from InfluxDB on startup.
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,75 @@
|
|||
---
|
||||
title: Use Chronograf with InfluxDB OSS
|
||||
description: >
|
||||
[Chronograf](/{{< latest "chronograf" >}}/) is a data visualization and dashboarding
|
||||
tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstack](/platform/)
|
||||
that provides an InfluxQL data explorer, Kapacitor integrations, and more.
|
||||
Continue to use Chronograf with **InfluxDB Cloud** and **InfluxDB OSS 2.0** and the
|
||||
[1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/).
|
||||
menu:
|
||||
influxdb_2_0:
|
||||
name: Use Chronograf
|
||||
parent: Tools & integrations
|
||||
weight: 103
|
||||
related:
|
||||
- /{{< latest "chronograf" >}}/
|
||||
---
|
||||
|
||||
[Chronograf](/{{< latest "chronograf" >}}/) is a data visualization and dashboarding
|
||||
tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstack](/platform/)
|
||||
that provides an InfluxQL data explorer, Kapacitor integrations, and more.
|
||||
Continue to use Chronograf with **InfluxDB Cloud** and **InfluxDB OSS 2.0** and the
|
||||
[1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/).
|
||||
|
||||
{{% warn %}}
|
||||
### No administrative functionality
|
||||
Chronograf cannot be used for administrative tasks in InfluxDB Cloud and InfluxDB OSS 2.0.
|
||||
For example, you **cannot** do the following:
|
||||
|
||||
- Define databases
|
||||
- Modify retention policies
|
||||
- Add users
|
||||
|
||||
To complete administrative tasks, use the following:
|
||||
|
||||
- **InfluxDB user interface (UI)**
|
||||
- [InfluxDB CLI](/influxdb/v2.0/reference/cli/influx/)
|
||||
- [InfluxDB v2 API](/influxdb/v2.0/reference/api/)
|
||||
|
||||
### Limited InfluxQL support
|
||||
InfluxDB Cloud and InfluxDB OSS 2.0 support InfluxQL **read-only** queries.
|
||||
For more information, see [InfluxQL support](/influxdb/v2.0/query-data/influxql/#influxql-support).
|
||||
{{% /warn %}}
|
||||
|
||||
## Create an InfluxDB connection
|
||||
1. In Choronograf, click **Configuration** in the left navigation bar,
|
||||
and then click **{{< icon "plus" >}} Add Connection**.
|
||||
2. Enter your InfluxDB connection credentials:
|
||||
- **Connection URL:** InfluxDB URL _(see [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/)
|
||||
or [InfluxDB OSS URLs](/influxdb/v2.0/reference/urls/))_
|
||||
|
||||
```
|
||||
http://localhost:8086
|
||||
```
|
||||
|
||||
- **Connection Name:** Name to uniquely identify this connection configuration
|
||||
- **Username:** InfluxDB username
|
||||
- **Password:** InfluxDB [authentication token](/influxdb/v2.0/security/tokens/)
|
||||
- **Telegraf Database Name:** Default database name
|
||||
- **Default Retention Policy:** Default retention policy
|
||||
|
||||
{{% note %}}
|
||||
#### DBRPs map to InfluxDB buckets
|
||||
In InfluxDB Cloud and InfluxDB OSS 2.0, database/retention-policy (DBRP) combinations
|
||||
are mapped to buckets using the `database-name/retention-policy` naming convention.
|
||||
For information, see [DBRP mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/)
|
||||
and [Map unmapped buckets](/influxdb/v2.0/query-data/influxql/#map-unmapped-buckets).
|
||||
{{% /note %}}
|
||||
|
||||
3. Click **Add Connection**.
|
||||
4. Select the dashboards you would like to create, and then click **Next**.
|
||||
5. To configure a Kapacitor connection, provide the necessary credentials,
|
||||
and then click **Continue**. Otherwise, click **Skip**.
|
||||
_For information about using Kapacitor with InfluxDB Cloud or InfluxDB OSS 2.0,
|
||||
see [Use Kapacitor with InfluxDB](/influxdb/v2.0/tools/kapacitor/)._
|
||||
6. Click **Finish**.
|
||||
|
|
@ -7,7 +7,7 @@ description: >
|
|||
menu:
|
||||
influxdb_2_0:
|
||||
parent: Tools & integrations
|
||||
weight: 102
|
||||
weight: 104
|
||||
influxdb/v2.0/tags: [google]
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,139 @@
|
|||
---
|
||||
title: Use Kapacitor with InfluxDB OSS
|
||||
description: >
|
||||
[Kapacitor](/kapacitor/) is a data processing framework that makes it easy to
|
||||
create alerts, run ETL (Extract, Transform and Load) jobs and detect anomalies.
|
||||
Use Kapacitor with **InfluxDB OSS 2.0**.
|
||||
menu:
|
||||
influxdb_2_0:
|
||||
name: Use Kapacitor
|
||||
parent: Tools & integrations
|
||||
weight: 102
|
||||
related:
|
||||
- /{{< latest "kapacitor" >}}/
|
||||
---
|
||||
|
||||
[Kapacitor](/{{< latest "kapacitor" >}}/) is a data processing framework that makes
|
||||
it easy to create alerts, run ETL jobs and detect anomalies.
|
||||
Kapacitor interacts with **InfluxDB Cloud** and **InfluxDB OSS 2.0** using the
|
||||
[InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/), so
|
||||
you can continue using Kapacitor without having to migrate libraries of TICKscripts
|
||||
to InfluxDB tasks.
|
||||
|
||||
{{% note %}}
|
||||
#### Support for stream tasks
|
||||
InfluxDB Cloud and InfluxDB OSS 2.0 do not have subscription APIs and
|
||||
**do not support Kapacitor stream tasks**, but you can continue to use stream
|
||||
tasks by writing data directly to Kapacitor.
|
||||
For more information, see [below](#use-kapacitor-stream-tasks).
|
||||
{{% /note %}}
|
||||
|
||||
#### On this page
|
||||
- [Configure Kapacitor to connect to InfluxDB](#configure-kapacitor-to-connect-to-influxdb)
|
||||
- [Use Kapacitor batch tasks](#use-kapacitor-batch-tasks)
|
||||
- [Use Kapacitor stream tasks](#use-kapacitor-stream-tasks)
|
||||
- [Write back to InfluxDB](#write-back-to-influxdb)
|
||||
|
||||
## Configure Kapacitor to connect to InfluxDB
|
||||
To connect Kapacitor to InfluxDB Cloud or InfluxDB OSS 2.0, update the `[[influxdb]]`
|
||||
section(s) of your [Kapacitor configuration file](/{{< latest "kapacitor" >}}/administration/configuration/#kapacitor-configuration-file):
|
||||
|
||||
- [Specify your InfluxDB URL](#specify-your-influxdb-url)
|
||||
- [Provide InfluxDB authentication credentials](#provide-influxdb-authentication-credentials)
|
||||
- [Disable InfluxDB subcriptions](#disable-influxdb-subscriptions)
|
||||
|
||||
### Specify your InfluxDB URL
|
||||
Provide your InfluxDB URL in the `[[influxdb]].urls` configuration option.
|
||||
For more information, see [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/)
|
||||
or [InfluxDB OSS URLs](/influxdb/v2.0/reference/urls/).
|
||||
|
||||
```toml
|
||||
[[influxdb]]
|
||||
# ...
|
||||
urls = ["http://localhost:8086"]
|
||||
```
|
||||
|
||||
### Provide InfluxDB authentication credentials
|
||||
InfluxDB Cloud and InfluxDB OSS 2.0 require authentication.
|
||||
Provide the following credentials in your `[[influxdb]].username` and `[[influxdb]].password`
|
||||
configuration options:
|
||||
|
||||
- **username:** InfluxDB username
|
||||
- **password:** InfluxDB [authentication token](/influxdb/v2.0/security/tokens/)
|
||||
|
||||
```toml
|
||||
[[influxdb]]
|
||||
# ...
|
||||
username = "influxdb-username"
|
||||
password = "influxdb-token"
|
||||
```
|
||||
|
||||
{{% warn %}}
|
||||
Kapacitor is subject to InfluxDB token permission restrictions.
|
||||
To query or write to an InfluxDB bucket, the InfluxDB token must have read and/or
|
||||
write permissions for the target bucket.
|
||||
For information about token permissions, see [Create a token](/influxdb/v2.0/security/tokens/create-token/).
|
||||
{{% /warn %}}
|
||||
|
||||
### Disable InfluxDB subscriptions
|
||||
InfluxDB Cloud and InfluxDB OSS 2.0 do not have subscriptions APIs.
|
||||
Set the `[[influxdb]].disable-subscriptions`to `true` to disable InfluxDB subscriptions.
|
||||
|
||||
```toml
|
||||
[[influxdb]]
|
||||
# ...
|
||||
disable-subscriptions = true
|
||||
```
|
||||
|
||||
## Use Kapacitor batch tasks
|
||||
Kapacitor batch tasks use the `query` endpoint of the 1.x compatibility API
|
||||
and require no change to use with InfluxDB Cloud and InfluxDB OSS.
|
||||
For information about writing back to InfluxDB in Kapacitor tasks,
|
||||
see [Write back to InfluxDB](#write-back-to-influxdb) below.
|
||||
|
||||
## Use Kapacitor stream tasks
|
||||
InfluxDB Cloud and OSS 2.0 do not have subscription APIs and do not support Kapacitor stream tasks directly.
|
||||
To use Kapacitor stream tasks, write data directly to Kapacitor using the [Kapcitior `write` API](/{{< latest "kapacitor" >}}/working/api/#writing-data).
|
||||
|
||||
We recommend using [Telegraf InfluxDB output plugin](/{{< latest "telegraf" >}}/plugins/#influxdb)
|
||||
to write data to both InfluxDB Cloud or OSS and Kapacitor.
|
||||
The following example Telegraf configuration writes data to both InfluxDB and Kapacitor:
|
||||
|
||||
##### Example Telegraf configuration
|
||||
```toml
|
||||
# Write to Kapacitor
|
||||
[[outputs.influxdb]]
|
||||
urls = ["http://localhost:9092"]
|
||||
database = "example-db"
|
||||
retention_policy = "example-rp"
|
||||
|
||||
# Write to InfluxDB Cloud or OSS
|
||||
[[outputs.influxdb]]
|
||||
urls = ["http://localhost:8086"]
|
||||
database = "example-db"
|
||||
retention_policy = "example-rp"
|
||||
username = "influxdb-username"
|
||||
password = "influxdb-token"
|
||||
```
|
||||
|
||||
## Write back to InfluxDB
|
||||
If using the Kapacitor `InfluxDBOut` node to write data to InfluxDB Cloud or OSS 2.0,
|
||||
InfluxDB maps the specified database and retention policy to a corresponding bucket.
|
||||
You can also manually map database/retention policy combinations (DBRPs) to buckets.
|
||||
For more information, see [DBRP mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/)
|
||||
and [Map unmapped buckets](/influxdb/v2.0/query-data/influxql/#map-unmapped-buckets).
|
||||
|
||||
The following example TICKscript writes to the `my-db/my-rp` bucket in
|
||||
InfluxDB Cloud or InfluxDB OSS 2.0.
|
||||
|
||||
```js
|
||||
batch
|
||||
|query('SELECT errors / total AS error_percent from requests')
|
||||
// Write the transformed data to InfluxDB
|
||||
|influxDBOut()
|
||||
.database('my-db')
|
||||
.retentionPolicy('my-rp')
|
||||
.measurement('errors')
|
||||
.tag('kapacitor', 'true')
|
||||
.tag('version', '0.2')
|
||||
```
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
{{ else if eq $icon "play" }}
|
||||
<span class="inline icon-play middle small"></span>
|
||||
{{ else if eq $icon "plus" }}
|
||||
<span class="inline icon-plus middle xsmall"></span>
|
||||
<span class="inline icon-ui-plus middle xsmall"></span>
|
||||
{{ else if or (eq $icon "refresh") (eq $icon "replay") }}
|
||||
<span class="inline icon-refresh middle small"></span>
|
||||
{{ else if or (eq $icon "remove") (eq $icon "x") }}
|
||||
|
|
|
|||
Loading…
Reference in New Issue