Scott Anderson
GitHub
commit
35fc98943a
|
|
@ -8,7 +8,7 @@
|
|||
color: $article-note-text;
|
||||
}
|
||||
strong {
|
||||
color: inherit;
|
||||
color: $article-note-strong;
|
||||
}
|
||||
a {
|
||||
color: $article-note-link;
|
||||
|
|
|
|||
|
|
@ -81,6 +81,7 @@ $article-table-scrollbar: $g0-obsidian;
|
|||
$article-note-base: $gr-viridian;
|
||||
$article-note-heading: $g20-white;
|
||||
$article-note-text: $gr-honeydew;
|
||||
$article-note-strong: $gr-krypton;
|
||||
$article-note-link: $gr-wasabi;
|
||||
$article-note-link-hover: $g20-white;
|
||||
$article-note-table-header: $grad-green-dark;
|
||||
|
|
|
|||
|
|
@ -82,6 +82,7 @@ $article-table-scrollbar: $g14-chromium !default;
|
|||
$article-note-base: $gr-rainforest !default;
|
||||
$article-note-heading: $gr-emerald !default;
|
||||
$article-note-text: $gr-emerald !default;
|
||||
$article-note-strong: $gr-emerald !default;
|
||||
$article-note-link: $b-ocean !default;
|
||||
$article-note-link-hover: $br-magenta !default;
|
||||
$article-note-table-header: $grad-green-dark !default;
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
@font-face {
|
||||
font-family: 'icomoon';
|
||||
src: url('fonts/icomoon.eot?lj8dxa');
|
||||
src: url('fonts/icomoon.eot?lj8dxa#iefix') format('embedded-opentype'),
|
||||
url('fonts/icomoon.ttf?lj8dxa') format('truetype'),
|
||||
url('fonts/icomoon.woff?lj8dxa') format('woff'),
|
||||
url('fonts/icomoon.svg?lj8dxa#icomoon') format('svg');
|
||||
src: url('fonts/icomoon.eot?a22byr');
|
||||
src: url('fonts/icomoon.eot?a22byr#iefix') format('embedded-opentype'),
|
||||
url('fonts/icomoon.ttf?a22byr') format('truetype'),
|
||||
url('fonts/icomoon.woff?a22byr') format('woff'),
|
||||
url('fonts/icomoon.svg?a22byr#icomoon') format('svg');
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
font-display: block;
|
||||
|
|
@ -25,6 +25,9 @@
|
|||
-moz-osx-font-smoothing: grayscale;
|
||||
}
|
||||
|
||||
.icon-crown:before {
|
||||
content: "\e934";
|
||||
}
|
||||
.icon-book-pencil:before {
|
||||
content: "\e965";
|
||||
}
|
||||
|
|
|
|||
|
|
@ -8,6 +8,30 @@ menu:
|
|||
parent: About the project
|
||||
---
|
||||
|
||||
## v1.8.9.1 [2020-12-10]
|
||||
|
||||
### Features
|
||||
- Configure etcd with client TLS certificate.
|
||||
- Support Flux in InfluxDB Cloud and InfluxDB OSS 2.x sources.
|
||||
- Support Flux Schema Explorer in InfluxDB Cloud and InfluxDB OSS 2.x sources.
|
||||
- Let users specify InfluxDB v2 authentication.
|
||||
- Validate credentials before creating or updating InfluxDB sources.
|
||||
- Use fully qualified bucket names when using Flux in the Data Explorer.
|
||||
- Upgrade Go to 1.15.5.
|
||||
- Upgrade Node.js to 14 LTS.
|
||||
|
||||
### Bug Fixes
|
||||
- Prevent briefly displaying "No Results" in dashboard cells upon refresh.
|
||||
- Warn about unsupported queries when creating or editing alert rules.
|
||||
- Use the `AND` logical operator with not-equal (`!=`) tag comparisons in generated TICKscript `where` filters.
|
||||
- Disable InfluxDB admin page when administration is not possible
|
||||
(while using InfluxDB Cloud or InfluxDB OSS 2.x sources).
|
||||
- Use token authentication against InfluxDB Cloud and InfluxDB OSS 2.x sources.
|
||||
- Avoid blank screen on Windows.
|
||||
- Repair visual comparison with time variables (`:upperDashboardTime:` and `:dashboardTime:`).
|
||||
- Repair possible millisecond differences in duration computation.
|
||||
- Remove deprecated React SFC type.
|
||||
|
||||
## v.1.8.8 [2020-11-04]
|
||||
|
||||
## Features
|
||||
|
|
|
|||
|
|
@ -258,6 +258,18 @@ The default is 1s.
|
|||
|
||||
Environment variable: `$ETCD_REQUEST_TIMEOUT`
|
||||
|
||||
#### `--etcd-cert=`
|
||||
|
||||
Path to etcd PEM-encoded TLS public key certificate.
|
||||
|
||||
Environment variable: `$ETCD_CERTIFICATE`
|
||||
|
||||
#### `--etcd-key=`
|
||||
|
||||
Path to private key associated with specified etcd certificate.
|
||||
|
||||
Environment variable: `$ETCD_PRIVATE_KEY`
|
||||
|
||||
### Other service options
|
||||
|
||||
#### `--custom-link <display_name>:<link_address>`
|
||||
|
|
|
|||
|
|
@ -58,4 +58,15 @@ export ETCD_ENDPOINTS=localhost:2379,192.168.1.61:2379,192.192.168.1.100:2379
|
|||
chronograf
|
||||
```
|
||||
|
||||
##### Define etcd endpoints with TLS enabled
|
||||
Use the `--etcd-cert` flag to specify the path to the etcd PEM-encoded public
|
||||
certificate file and the `--etcd-key` flag to specify the path to the private key
|
||||
associated with the etcd certificate.
|
||||
|
||||
```sh
|
||||
chronograf --etcd-endpoints=localhost:2379 \
|
||||
--etcd-cert=path/to/etcd-certificate.pem \
|
||||
--etcd-key=path/to/etcd-private-key.key
|
||||
```
|
||||
|
||||
For more information, see [Chronograf etcd configuration options](/chronograf/v1.8/administration/config-options#etcd-options).
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ menu:
|
|||
name: Create InfluxDB and Kapacitor connections
|
||||
weight: 50
|
||||
parent: Administration
|
||||
related:
|
||||
- /influxdb/v2.0/tools/chronograf/
|
||||
---
|
||||
|
||||
Connections to InfluxDB and Kapacitor can be configured through the Chronograf user interface (UI) or with JSON configuration files:
|
||||
|
|
@ -23,20 +25,58 @@ To create an InfluxDB connection in the Chronograf UI:
|
|||
|
||||
1. Open Chronograf and click **Configuration** (wrench icon) in the navigation menu.
|
||||
2. Click **Add Connection**.
|
||||
|
||||
3. Enter values for the following fields:
|
||||
|
||||
<img src="/img/chronograf/1-7-influxdb-connection-config.png" style="width:100%; max-width:600px;">
|
||||
|
||||
|
||||
* **Connection URL**: Enter the hostname or IP address of the InfluxDB instance and the port. The field is prefilled with `http://localhost:8086`.
|
||||
* **Connection Name**: Enter the name for this connection.
|
||||
* **Username**: Enter the username that will be shared for this connection.
|
||||
*Required only if [authorization is enabled](/{{< latest "influxdb" "v1" >}}/administration/authentication_and_authorization/) on the InfluxDB instance to which you're connecting.*
|
||||
* **Password**: Enter the password.
|
||||
*Required only if [authorization is enabled](/{{< latest "influxdb" "v1" >}}/administration/authentication_and_authorization/) on the InfluxDB instance to which you're connecting.*
|
||||
* **Telegraf Database Name**: This field specifies the database that Chronograf will use for populating different parts of the application, including the Host List page. If none is provided, we will use `autogen`. You will still be able to query any database you have access to in the InfluxDB instance when building dashboards or exploring data.
|
||||
* **Default Retention Policy**: Enter the name of the default [retention policy](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp). If none is provided, it assumes `autogen`. If you've changed the default retention policy in your InfluxDB instance, you may want to change it here as well.
|
||||
* **Make this the default connection**: When this option is selected, this InfluxDB connection will be used when Chronograf is launched.
|
||||
3. Provide the necessary connection credentials.
|
||||
|
||||
{{< tabs-wrapper >}}
|
||||
{{% tabs %}}
|
||||
[InfluxDB 1.x](#)
|
||||
[InfluxDB Cloud or OSS 2.x ](#)
|
||||
{{% /tabs %}}
|
||||
{{% tab-content %}}
|
||||
<img src="/img/chronograf/1-8-influxdb-v1-connection-config.png" style="width:100%; max-width:798px;"/>
|
||||
|
||||
- **Connection URL**: hostname or IP address and port of the InfluxDB 1.x instance
|
||||
- **Connection Name**: Unique name for this connection.
|
||||
- **Username**: InfluxDB 1.x username
|
||||
_(Required only if [authorization is enabled](/{{< latest "influxdb" "v1" >}}/administration/authentication_and_authorization/) in InfluxDB)_
|
||||
- **Password**: InfluxDB password
|
||||
_(Required only if [authorization is enabled](/{{< latest "influxdb" "v1" >}}/administration/authentication_and_authorization/) in InfluxDB)_
|
||||
- **Telegraf Database Name**: the database Chronograf uses to populate parts of the application, including the Host List page (default is `telegraf`)
|
||||
- **Default Retention Policy**: default [retention policy](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp)
|
||||
(if left blank, defaults to `autogen`)
|
||||
- **Default connection**: use this connection as the default connection for data exploration, dashboards, and administrative actions
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
<img src="/img/chronograf/1-8-influxdb-v2-connection-config.png" style="width:100%; max-width:798px;"/>
|
||||
|
||||
- **Enable the {{< req "InfluxDB v2 Auth" >}} option**
|
||||
- **Connection URL**: [InfluxDB Cloud region URL](/influxdb/cloud/reference/regions/)
|
||||
or [InfluxDB OSS 2.x URL](/influxdb/v2.0/reference/urls/)
|
||||
|
||||
```
|
||||
http://localhost:8086
|
||||
```
|
||||
|
||||
- **Connection Name**: Unique name for this connection.
|
||||
- **Organiziation**: InfluxDB [organization](/influxdb/v2.0/organizations/)
|
||||
- **Token**: InfluxDB [authentication token](/influxdb/v2.0/security/tokens/)
|
||||
- **Telegraf Database Name:** InfluxDB [bucket](/influxdb/v2.0/organizations/buckets/)
|
||||
Chronograf uses to populate parts of the application, including the Host List page (default is `telegraf`)
|
||||
- **Default Retention Policy:** default [retention policy](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp)
|
||||
_**(leave blank)**_
|
||||
- **Default connection**: use this connection as the default connection for data exploration and dashboards
|
||||
|
||||
{{% note %}}
|
||||
For more information about connecting Chronograf to an InfluxDB Cloud or OSS 2.x instance, see:
|
||||
|
||||
- [Use Chronograf with InfluxDB Cloud](/influxdb/cloud/tools/chronograf/)
|
||||
- [Use Chronograf with InfluxDB OSS 2.x](/{{< latest "influxdb" "v2" >}}/tools/chronograf/)
|
||||
{{% /note %}}
|
||||
{{% /tab-content %}}
|
||||
{{< /tabs-wrapper >}}
|
||||
|
||||
4. Click **Add Connection**
|
||||
* If the connection is valid, the Dashboards window appears, allowing you to import dashboard templates you can use to display and analyze your data. For details, see [Creating dashboards](/chronograf/v1.8/guides/create-a-dashboard).
|
||||
|
|
|
|||
|
|
@ -16,6 +16,13 @@ The **Chronograf Admin** provides InfluxDB user management for InfluxDB OSS and
|
|||
|
||||
> ***Note:*** For details on Chronograf user authentication and management, see [Managing security](/chronograf/v1.8/administration/managing-security/).
|
||||
|
||||
{{% note %}}
|
||||
#### Disabled administrative features
|
||||
If connected to **InfluxDB OSS v2.x** or **InfluxDB Cloud**, all InfluxDB administrative
|
||||
features are disabled in Chronograf. Use the InfluxDB OSS v2.x or InfluxDB Cloud user
|
||||
interfaces, CLIs, or APIs to complete administrative tasks.
|
||||
{{% /note %}}
|
||||
|
||||
**On this page:**
|
||||
|
||||
* [Enable authentication](#enable-authentication)
|
||||
|
|
|
|||
|
|
@ -381,8 +381,8 @@ When using the generic configuration, some or all of the following environment v
|
|||
* `GENERIC_TOKEN_URL`: Provider's token [endpoint](https://tools.ietf.org/html/rfc6749#section-3.2) URL used by the Chronograf client to obtain an access token
|
||||
* `USE_ID_TOKEN`: Enable OpenID [id_token](https://openid.net/specs/openid-connect-core-1_0.html#rfc.section.3.1.3.3) processing
|
||||
* `JWKS_URL`: Provider's JWKS [endpoint](https://tools.ietf.org/html/rfc7517#section-4.7) used by the client to validate RSA signatures
|
||||
* `GENERIC_API_URL`: Provider's [OpenID UserInfo endpoint](https://connect2id.com/products/server/docs/api/userinfo)] URL used by Chronograf to request user data
|
||||
* `GENERIC_API_KEY`: JSON lookup key for [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo)] (known to be required for Microsoft Azure, with the value `userPrincipalName`)
|
||||
* `GENERIC_API_URL`: Provider's [OpenID UserInfo endpoint](https://connect2id.com/products/server/docs/api/userinfo) URL used by Chronograf to request user data
|
||||
* `GENERIC_API_KEY`: JSON lookup key for [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo) (known to be required for Microsoft Azure, with the value `userPrincipalName`)
|
||||
* `GENERIC_SCOPES`: [Scopes](https://tools.ietf.org/html/rfc6749#section-3.3) of user data required for your instance of Chronograf, such as user email and OAuth provider organization
|
||||
- Multiple values must be space-delimited, e.g. `user:email read:org`
|
||||
- These may vary by OAuth 2.0 provider
|
||||
|
|
@ -425,6 +425,18 @@ TOKEN_SECRET="ZNh2N9toMwUVQxTVEe2ZnnMtgkh3xqKZ"
|
|||
Do not use special characters for the `GENERIC_CLIENT_ID` as AD FS may split strings at the special character, resulting in an identifier mismatch.
|
||||
{{% /note %}}
|
||||
|
||||
{{% note %}}
|
||||
#### Troubleshoot OAuth errors
|
||||
|
||||
##### ERRO[0053]
|
||||
A **ERRO[0053]** error indicates that a primary email is not found for the specified user.
|
||||
A user must have a primary email.
|
||||
|
||||
```
|
||||
ERRO[0053] Unable to get OAuth Group malformed email address, expected "..." to contain @ symbol
|
||||
```
|
||||
{{% /note %}}
|
||||
|
||||
### Configure authentication duration
|
||||
|
||||
By default, user authentication remains valid for 30 days using a cookie stored in the web browser.
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ menu:
|
|||
weight: 130
|
||||
parent: Guides
|
||||
---
|
||||
|
||||
Explore and visualize your data in the **Data Explorer**. For both InfluxQL and Flux, Chronograf allows you to move seamlessly between using the builder or templates and manually editing the query; when possible, the interface automatically populates the builder with the information from your raw query. Choose between [visualization types](/chronograf/v1.8/guides/visualization-types/) for your query.
|
||||
|
||||
To open the **Data Explorer**, click the **Explore** icon in the navigation bar:
|
||||
|
|
@ -25,6 +26,14 @@ To open the **Data Explorer**, click the **Explore** icon in the navigation bar:
|
|||
|
||||
InfluxQL is a SQL-like query language you can use to interact with data in InfluxDB. For detailed tutorials and reference material, see our [InfluxQL documentation](/{{< latest "influxdb" "v1" >}}/query_language/).
|
||||
|
||||
{{% note %}}
|
||||
#### Limited InfluxQL support in InfluxDB Cloud and OSS 2.x
|
||||
Chronograf interacts with **InfluxDB Cloud** and **InfluxDB OSS 2.x** through the
|
||||
[v1 compatibility API](/influxdb/cloud/reference/api/influxdb-1x/).
|
||||
The v1 compatibility API provides limited InfluxQL support.
|
||||
For more information, see [InfluxQL support](/influxdb/cloud/query-data/influxql/#influxql-support).
|
||||
{{% /note %}}
|
||||
|
||||
1. Open the Data Explorer and click **Add a Query**.
|
||||
2. To the right of the source dropdown above the graph placeholder, select **InfluxQL** as the source type.
|
||||
3. Use the builder to select from your existing data and allow Chronograf to format the query for you. Alternatively, manually enter and edit a query.
|
||||
|
|
@ -35,9 +44,6 @@ InfluxQL is a SQL-like query language you can use to interact with data in Influ
|
|||
|
||||
Flux is InfluxData's new functional data scripting language designed for querying, analyzing, and acting on time series data. To learn more about Flux, see [Getting started with Flux](/flux/v0.7/introduction/getting-started).
|
||||
|
||||
> ***Note:*** Flux v0.7 is a technical preview included with [InfluxDB v1.8](/influxdb/v1.8). It is still in active development and many functions provided by InfluxQL and TICKscript have yet to be implemented.
|
||||
|
||||
|
||||
1. Open the Data Explorer and click **Add a Query**.
|
||||
2. To the right of the source dropdown above the graph placeholder, select **Flux** as the source type.
|
||||
The **Schema**, **Functions**, and **Script** panes appear.
|
||||
|
|
@ -53,12 +59,12 @@ Flux is InfluxData's new functional data scripting language designed for queryin
|
|||
|
||||
```js
|
||||
from(bucket: "telegraf/autogen")
|
||||
|> range(start: dashboardTime)
|
||||
|> filter(fn: (r) => r._measurement == "cpu" and (r._field == "usage_system"))
|
||||
|> window(every: autoInterval)
|
||||
|> toFloat()
|
||||
|> percentile(percentile: 0.95)
|
||||
|> group(except: ["_time", "_start", "_stop", "_value"])
|
||||
|> range(start: dashboardTime)
|
||||
|> filter(fn: (r) => r._measurement == "cpu" and (r._field == "usage_system"))
|
||||
|> window(every: autoInterval)
|
||||
|> toFloat()
|
||||
|> percentile(percentile: 0.95)
|
||||
|> group(except: ["_time", "_start", "_stop", "_value"])
|
||||
```
|
||||
* Alternatively, you can enter your entire script manually.
|
||||
|
||||
|
|
|
|||
|
|
@ -19,17 +19,17 @@ chronograf [flags]
|
|||
|
||||
## Chronograf service flags
|
||||
|
||||
| Flag | Description | Env. Variable |
|
||||
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|
|
||||
| `--host` | IP the Chronograf service listens on. By default, `0.0.0.0` | `$HOST` |
|
||||
| `--port` | Port the Chronograf service listens on for insecure connections. By default, `8888` | `$PORT` |
|
||||
| `-b`,`--bolt-path` | File path to the BoltDB file. By default, `./chronograf-v1.db` | `$BOLT_PATH` |
|
||||
| `-c`,`--canned-path` | File path to the directory of canned dashboard files. By default, `/usr/share/chronograf/canned` | `$CANNED_PATH` |
|
||||
| `--resources-path` | Path to directory of canned dashboards, sources, Kapacitor connections, and organizations. By default, `/usr/share/chronograf/resources` | `$RESOURCES_PATH` |
|
||||
| `-b`, `--basepath` | URL path prefix under which all Chronograf routes will be mounted. | `$BASE_PATH` |
|
||||
| `--status-feed-url` | URL of JSON feed to display as a news feed on the client status page. By default, `https://www.influxdata.com/feed/json` | `$STATUS_FEED_URL` |
|
||||
| `-v`, `--version` | Displays the version of the Chronograf service | |
|
||||
| `-h`, `--host-page-disabled` | Disables the hosts page | `$HOST_PAGE_DISABLED`|
|
||||
| Flag | Description | Env. Variable |
|
||||
|:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:---------------------|
|
||||
| `--host` | IP the Chronograf service listens on. By default, `0.0.0.0` | `$HOST` |
|
||||
| `--port` | Port the Chronograf service listens on for insecure connections. By default, `8888` | `$PORT` |
|
||||
| `-b`,`--bolt-path` | File path to the BoltDB file. By default, `./chronograf-v1.db` | `$BOLT_PATH` |
|
||||
| `-c`,`--canned-path` | File path to the directory of canned dashboard files. By default, `/usr/share/chronograf/canned` | `$CANNED_PATH` |
|
||||
| `--resources-path` | Path to directory of canned dashboards, sources, Kapacitor connections, and organizations. By default, `/usr/share/chronograf/resources` | `$RESOURCES_PATH` |
|
||||
| `-b`, `--basepath` | URL path prefix under which all Chronograf routes will be mounted. | `$BASE_PATH` |
|
||||
| `--status-feed-url` | URL of JSON feed to display as a news feed on the client status page. By default, `https://www.influxdata.com/feed/json` | `$STATUS_FEED_URL` |
|
||||
| `-v`, `--version` | Displays the version of the Chronograf service | |
|
||||
| `-h`, `--host-page-disabled` | Disables the hosts page | `$HOST_PAGE_DISABLED`|
|
||||
|
||||
## InfluxDB connection flags
|
||||
|
||||
|
|
@ -49,23 +49,23 @@ chronograf [flags]
|
|||
|
||||
## TLS (Transport Layer Security) flags
|
||||
|
||||
| Flag | Description | Env. Variable |
|
||||
|:---------|:------------------------------------------------------------|:--------------------|
|
||||
| `--cert` | File path to PEM-encoded public key certificate | `$TLS_CERTIFICATE` |
|
||||
| `--key` | File path to private key associated with given certificate | `$TLS_PRIVATE_KEY` |
|
||||
| `--tls-ciphers` | Comma-separated list of supported cipher suites. Use `help` to print available ciphers. | `$TLS_CIPHERS` |
|
||||
| `--tls-min-version` | Minimum version of the TLS protocol that will be negotiated. (default: 1.2) | `$TLS_MIN_VERSION` |
|
||||
| `--tls-max-version` | Maximum version of the TLS protocol that will be negotiated. | `$TLS_MAX_VERSION` |
|
||||
| Flag | Description | Env. Variable |
|
||||
|:--------- |:------------------------------------------------------------ |:--------------------|
|
||||
| `--cert` | File path to PEM-encoded public key certificate | `$TLS_CERTIFICATE` |
|
||||
| `--key` | File path to private key associated with given certificate | `$TLS_PRIVATE_KEY` |
|
||||
| `--tls-ciphers` | Comma-separated list of supported cipher suites. Use `help` to print available ciphers. | `$TLS_CIPHERS` |
|
||||
| `--tls-min-version` | Minimum version of the TLS protocol that will be negotiated. (default: 1.2) | `$TLS_MIN_VERSION` |
|
||||
| `--tls-max-version` | Maximum version of the TLS protocol that will be negotiated. | `$TLS_MAX_VERSION` |
|
||||
|
||||
## Other service option flags
|
||||
|
||||
| Flag | Description | Env. Variable |
|
||||
|:---------------------------------------------|:------------------------------------------------------------------------|:----------------------|
|
||||
| `--custom-link` <display_name>:<link_address>| Custom link added to Chronograf user menu options. Useful for providing links to internal company resources for your Chronograf users. Can be used when any OAuth 2.0 authentication is enabled. To add another custom link, repeat the custom link option. | |
|
||||
| `-r`, `--reporting-disabled` | Disables reporting of usage statistics. Usage statistics reported once every 24 hours include: `OS`, `arch`, `version`, `cluster_id`, and `uptime`. | `$REPORTING_DISABLED` |
|
||||
| `-l`, `--log-level` | Sets the logging level. Valid values include `info` (default), `debug`, and `error`. | `$LOG_LEVEL` |
|
||||
| `-d`, `--develop` | Runs the Chronograf service in developer mode | |
|
||||
| `-h`, `--help` | Displays command line help for Chronograf | |
|
||||
| Flag | Description | Env. Variable |
|
||||
|:---------------------------- |:------------------------------------------------------------------------ |:----------------------|
|
||||
| `--custom-link` | Adds a custom link to Chronograf user menu options using `<display_name>:<link_address>` syntax. For multiple custom links, include multiple flags. | |
|
||||
| `-r`, `--reporting-disabled` | Disables reporting of usage statistics. Usage statistics reported once every 24 hours include: `OS`, `arch`, `version`, `cluster_id`, and `uptime`. | `$REPORTING_DISABLED` |
|
||||
| `-l`, `--log-level` | Sets the logging level. Valid values include `info` (default), `debug`, and `error`. | `$LOG_LEVEL` |
|
||||
| `-d`, `--develop` | Runs the Chronograf service in developer mode | |
|
||||
| `-h`, `--help` | Displays command line help for Chronograf | |
|
||||
|
||||
## Authentication option flags
|
||||
|
||||
|
|
@ -124,3 +124,15 @@ chronograf [flags]
|
|||
| `--generic-auth-url` | Authorization endpoint URL for the OAuth 2.0 provider | `$GENERIC_AUTH_URL` |
|
||||
| `--generic-token-url` | Token endpoint URL for the OAuth 2.0 provider | `$GENERIC_TOKEN_URL` |
|
||||
| `--generic-api-url` | URL that returns OpenID UserInfo-compatible information | `$GENERIC_API_URL` |
|
||||
|
||||
### etcd flags
|
||||
|
||||
| Flag | Description | Env. Variable |
|
||||
|:--------------------------|:-----------------------------------------------------------------------------------------------------------|:------------------------|
|
||||
| `-e`, `--etcd-endpoints` | etcd endpoint URL (include multiple flags for multiple endpoints) | `$ETCD_ENDPOINTS` |
|
||||
| `--etcd-username` | etcd username | `$ETCD_USERNAME` |
|
||||
| `--etcd-password` | etcd password | `$ETCD_PASSWORD` |
|
||||
| `--etcd-dial-timeout` | Total time to wait before timing out while connecting to etcd endpoints (0 means no timeout, default: -1s) | `$ETCD_DIAL_TIMEOUT` |
|
||||
| `--etcd-request-timeout` | Total time to wait before timing out the etcd view or update (0 means no timeout, default: -1s) | `$ETCD_REQUEST_TIMEOUT` |
|
||||
| `--etcd-cert` | Path to PEM encoded TLS public key certificate for use with TLS | `$ETCD_CERTIFICATE` |
|
||||
| `--etcd-key` | Path to private key associated with given certificate for use with TLS | `$ETCD_PRIVATE_KEY` |
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Example post
|
||||
description: This is just an example post to show the format of new 2.0 posts
|
||||
weight: 1
|
||||
draft: true
|
||||
#draft: true
|
||||
related:
|
||||
- /influxdb/v2.0/write-data/
|
||||
- /influxdb/v2.0/write-data/quick-start
|
||||
|
|
@ -35,6 +35,7 @@ This is **bold** text. This is _italic_ text. This is _**bold and italic**_.
|
|||
{{< icon "cog" >}} cog
|
||||
{{< icon "config" >}} config
|
||||
{{< icon "copy" >}} copy
|
||||
{{< icon "crown" >}} crown
|
||||
{{< icon "dashboard" >}} dashboard
|
||||
{{< icon "dashboards" >}} dashboards
|
||||
{{< icon "data-explorer" >}} data-explorer
|
||||
|
|
|
|||
|
|
@ -137,7 +137,7 @@ To return results as **CSV**, include the `Accept: application/csv` header.
|
|||
|
||||
## InfluxQL support
|
||||
|
||||
InfluxDB Cloud support InfluxQL **read-only** queries. See supported and unsupported queries below.
|
||||
InfluxDB Cloud supports InfluxQL **read-only** queries. See supported and unsupported queries below.
|
||||
To learn more about InfluxQL, see [Influx Query Language (InfluxQL)](/{{< latest "influxdb" "v1" >}}/query_language/).
|
||||
|
||||
{{< flex >}}
|
||||
|
|
|
|||
|
|
@ -208,7 +208,7 @@ To return results as **CSV**, include the `Accept: application/csv` header.
|
|||
|
||||
## InfluxQL support
|
||||
|
||||
InfluxDB OSS 2.0 support InfluxQL **read-only** queries. See supported and unsupported queries below.
|
||||
InfluxDB OSS 2.0 supports InfluxQL **read-only** queries. See supported and unsupported queries below.
|
||||
To learn more about InfluxQL, see [Influx Query Language (InfluxQL)](/{{< latest "influxdb" "v1" >}}/query_language/).
|
||||
|
||||
{{< flex >}}
|
||||
|
|
|
|||
|
|
@ -21,30 +21,14 @@ 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:
|
||||
2. Toggle the **InfluxDB v2 Auth** option at the bottom of the form.
|
||||
|
||||
{{< img-hd src="/img/influxdb/2-0-tools-chronograf-v2-auth.png" alt="InfluxDB v2 Auth toggle" />}}
|
||||
|
||||
3. 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/))_
|
||||
|
||||
|
|
@ -53,15 +37,19 @@ For more information, see [InfluxQL support](/influxdb/v2.0/query-data/influxql/
|
|||
```
|
||||
|
||||
- **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
|
||||
- **Organization:** InfluxDB [organization](/influxdb/v2.0/organizations/)
|
||||
- **Token:** InfluxDB [authentication token](/influxdb/v2.0/security/tokens/)
|
||||
- **Telegraf Database Name:** InfluxDB [bucket](/influxdb/v2.0/organizations/buckets/)
|
||||
Chronograf uses to populate parts of the application, including the Host List page (default is `telegraf`)
|
||||
- **Default Retention Policy:** default [retention policy](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp)
|
||||
_**(leave blank)**_
|
||||
|
||||
{{% 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.
|
||||
**DBRP mappings are required to query InfluxDB OSS 2.x or InfluxDB Cloud using InfluxQL.**
|
||||
|
||||
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 %}}
|
||||
|
|
@ -73,3 +61,38 @@ and [Map unmapped buckets](/influxdb/v2.0/query-data/influxql/#map-unmapped-buck
|
|||
_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**.
|
||||
|
||||
## Important notes
|
||||
|
||||
- [Update upgraded InfluxDB connections](#Update-upgraded-InfluxDB-connections)
|
||||
- [No administrative functionality](#No-administrative-functionality)
|
||||
- [Limited InfluxQL support](#Limited-InfluxQL-support)
|
||||
|
||||
### Update upgraded InfluxDB connections
|
||||
If using Chronograf with an InfluxDB instance that was upgraded from 1.x
|
||||
to 2.x, update your InfluxDB connection configuration in Chronograf to use the
|
||||
**InfluxDB v2 Auth** option and provide an organization and a token.
|
||||
**Without an organization, Chronograf cannot use Flux to query InfluxDB.**
|
||||
|
||||
### 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
|
||||
- Kill queries
|
||||
|
||||
When connected to an InfluxDB Cloud or InfluxDB 2.0 database, functionality in the
|
||||
**{{< icon "crown" >}} InfluxDB Admin** section of Chronograf is disabled.
|
||||
|
||||
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).
|
||||
|
||||
|
|
|
|||
|
|
@ -60,6 +60,8 @@
|
|||
<span class="inline icon-eye-closed large"></span>
|
||||
{{ else if or (eq $icon "notebook") (eq $icon "notebooks") }}
|
||||
<span class="inline icon-book-pencil"></span>
|
||||
{{ else if eq $icon "crown" }}
|
||||
<span class="inline icon-crown large"></span>
|
||||
{{ else if eq $icon "add-label" }}
|
||||
<span class="inline add-btn-round"></span>
|
||||
{{ else if or (eq $icon "toggle") (eq $icon "toggle-blue") }}
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -59,6 +59,7 @@
|
|||
<glyph unicode="" glyph-name="refresh" d="M875.95 653.953c-76.95 76.95-176.344 127.609-285.357 144.282-135.304 20.52-270.608-12.826-381.545-93.622-110.296-81.439-182.756-200.712-203.277-336.016-5.13-35.268 18.596-67.972 53.866-73.102 3.206-0.642 6.412-0.642 9.618-0.642 31.422 0 58.354 22.444 63.484 54.506 15.39 101.318 69.896 191.093 152.618 252.012s184.68 85.928 285.998 70.538c82.080-12.184 156.466-50.658 214.178-108.372l-144.282-144.282h384.751v384.751l-150.053-150.053zM966.367 286.516c-35.268 5.13-67.972-18.596-73.102-53.866-32.062-209.69-228.927-354.612-438.616-322.55-81.439 12.184-156.466 50.658-214.178 108.372l144.282 144.282h-384.751v-384.751l150.053 150.053c76.95-76.95 176.986-127.609 285.357-144.282 26.292-3.848 51.942-5.772 77.592-5.772 248.806 0 468.114 182.116 506.589 435.41 5.772 35.268-17.956 67.972-53.224 73.102z" />
|
||||
<glyph unicode="" glyph-name="remove" d="M641.252 291.004l236.622 236.622c25.008 25.008 25.008 66.049 0 90.416l-37.834 37.834c-25.008 25.008-66.049 25.008-90.416 0l-236.622-236.622-236.622 236.622c-25.008 25.008-66.049 25.008-90.416 0l-37.834-37.834c-25.008-25.008-25.008-66.049 0-90.416l236.622-236.622-236.622-236.622c-25.008-25.008-25.008-66.049 0-90.416l37.834-37.834c25.008-25.008 66.049-25.008 90.416 0l236.622 236.622 236.622-236.622c25.008-25.008 66.049-25.008 90.416 0l37.834 37.834c25.008 25.008 25.008 66.049 0 90.416l-236.622 236.622z" />
|
||||
<glyph unicode="" glyph-name="alert-circle" d="M982.292 300.179c0 129.706-52.616 247.238-137.606 332.185s-202.481 137.606-332.185 137.606-247.238-52.616-332.185-137.606-137.606-202.481-137.606-332.185 52.616-247.238 137.606-332.185 202.481-137.606 332.185-137.606 247.238 52.616 332.185 137.606 137.606 202.481 137.606 332.185zM896.876 300.179c0-106.173-42.965-202.181-112.579-271.796s-165.623-112.579-271.796-112.579-202.181 42.965-271.796 112.579-112.579 165.623-112.579 271.796 42.965 202.181 112.579 271.796 165.623 112.579 271.796 112.579 202.181-42.965 271.796-112.579 112.579-165.623 112.579-271.796zM469.792 471.013v-170.834c0-23.575 19.134-42.709 42.709-42.709s42.709 19.134 42.709 42.709v170.834c0 23.575-19.134 42.709-42.709 42.709s-42.709-19.134-42.709-42.709zM512.5 86.637c23.575 0 42.709 19.134 42.709 42.709s-19.134 42.709-42.709 42.709-42.709-19.134-42.709-42.709 19.134-42.709 42.709-42.709z" />
|
||||
<glyph unicode="" glyph-name="crown" d="M187.063-96.155c-28.188 0-51.25 20.5-58.938 46.125l-125.563 492c-5.125 17.938 2.563 38.438 17.938 48.688 15.375 12.813 35.875 12.813 53.813 2.563l233.188-148.625 166.563 246c7.688 12.813 23.063 20.5 38.438 20.5s30.75-7.688 38.438-20.5l169.125-246 233.188 148.625c15.375 10.25 38.438 10.25 53.813-2.563s23.063-30.75 17.938-51.25l-128.125-489.438c-7.688-28.188-30.75-46.125-58.938-46.125h-650.876zM202.438-29.53v0c0 0 0 0 0 0zM199.875-19.28h625.251l105.063 407.438-181.938-117.875c-28.188-17.938-64.063-10.25-82 15.375l-153.75 222.938-153.75-222.938c-17.938-25.625-53.813-33.313-82-17.938l-181.938 117.875 105.063-404.875zM994.251 429.158v0c0 0 0 0 0 0zM76.875 459.908v0c0 0 0 0 0 0zM948.126 459.908c0 0 0 0 0 0v0zM486.875 547.033c2.563 0 2.563 0 0 0v0zM535.563 547.033v0c0 0 0 0 0 0z" />
|
||||
<glyph unicode="" glyph-name="trash" d="M936.227 675.756h-194.94l-66.69 110.296c-5.13 10.26-17.956 17.956-30.78 17.956h-261.63c-12.826 0-25.65-7.696-33.346-17.956l-64.126-110.296h-194.94c-20.52 0-38.476-17.956-38.476-38.476v-102.6c0-20.52 17.956-38.476 38.476-38.476h846.453c20.52 0 38.476 17.956 38.476 38.476v102.6c0 20.52-17.956 38.476-38.476 38.476zM405.271 727.056h215.46l30.78-51.3h-277.021l30.78 51.3zM859.277 444.905h-692.552c-10.26 0-20.52-5.13-28.216-12.826s-10.26-17.956-10.26-28.216l51.3-589.952c2.566-20.52 17.956-35.91 38.476-35.91h589.952c20.52 0 35.91 15.39 38.476 35.91l51.3 589.952c0 10.26-2.566 20.52-10.26 28.216s-17.956 12.826-28.216 12.826z" />
|
||||
<glyph unicode="" glyph-name="triangle" d="M983.252 66.567l-359.101 607.052c-17.101 29.925-47.025 51.3-81.225 59.849s-68.401 4.275-98.325-12.826c-17.101-8.549-34.199-25.65-42.751-42.751 0 0 0 0 0 0l-359.101-611.326c-34.199-59.849-12.826-141.076 47.025-175.275 17.101-12.826 38.476-17.101 59.849-17.101h726.752c34.199 0 68.401 12.826 89.776 38.476 25.65 25.65 38.476 55.575 38.476 89.776-4.275 21.375-8.549 47.025-21.375 64.126zM906.302-27.483c-8.549-8.549-21.375-12.826-29.925-12.826h-726.752c-8.549 0-12.826 0-21.375 4.275-21.375 12.826-25.65 38.476-17.101 59.849l363.377 602.777c4.275 4.275 8.549 12.826 12.826 12.826 21.375 12.826 47.025 4.275 59.849-12.826l363.377-602.777c4.275-4.275 4.275-12.826 4.275-21.375 4.275-12.826-4.275-21.375-8.549-29.925z" />
|
||||
<glyph unicode="" glyph-name="x" d="M572.851 301.692l226.575 226.575c17.101 17.101 17.101 42.751 0 59.849s-42.751 17.101-59.849 0l-226.575-226.575-226.575 226.575c-17.101 17.101-42.751 17.101-59.849 0s-17.101-42.751 0-59.849l226.575-226.575-226.575-226.575c-17.101-17.101-17.101-42.751 0-59.849 8.549-8.549 17.101-12.826 29.925-12.826s21.375 4.275 29.925 12.826l226.575 226.575 226.575-226.575c8.549-8.549 21.375-12.826 29.925-12.826s21.375 4.275 29.925 12.826c17.101 17.101 17.101 42.751 0 59.849l-226.575 226.575z" />
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 63 KiB After Width: | Height: | Size: 64 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.4 KiB |
Loading…
Reference in New Issue