Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge branch 'v1-merge' into store-tokens

pull/1364/head
kelseiv 2020-09-01 13:41:29 -07:00 committed by GitHub
parent f7f5e79c79 6c62df2b52
commit 5527bd9ff4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
883 changed files with 3973 additions and 5293 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
assets/js/content-interactions.js
View File

@ -94,13 +94,6 @@ $('.expand-label').click(function() {
$(this).next('.expand-content').slideToggle(200)
})
//////////////////// Replace Missing Images with Placeholder ///////////////////
$(".article--content img").on("error", function() {
$(this).attr("src", "/img/coming-soon.svg");
$(this).attr("style", "max-width:500px;");
});
////////////////////////// Inject tooltips on load //////////////////////////////
$('.tooltip').each( function(){

36
assets/styles/layouts/_error-page.scss
View File

@ -7,7 +7,7 @@
.error-content {
margin-top: 10vh;
max-width: 310px;
max-width: 380px;
}
.error-code {
@ -56,24 +56,50 @@
margin: 2rem 0 1.5rem;
.btn {
display: block;
display: flex;
position: relative;
flex-grow: 1;
margin-right: 4px;
padding: .75rem 1rem;
border-radius: $radius;
text-align: center;
justify-content: center;
align-items: center;
color: $error-page-btn-text;
transition: background-color .2s;
z-index: 1;
@include gradient($article-btn-gradient);
&:hover {
@include gradient($article-btn-gradient-hover);
}
&.back:before {
content: "\e90a";
font-family: "icomoon";
margin-right: .35rem;
vertical-align: text-top;
}
&:after {
content: "";
position: absolute;
display: block;
top: 0;
right: 0;
width: 100%;
height: 100%;
border-radius: $radius;
@include gradient($article-btn-gradient-hover);
opacity: 0;
transition: opacity .2s;
z-index: -1;
}
&:hover {
cursor: pointer;
&:after {
opacity: 1;
}
}
}
}

5
assets/styles/layouts/_feature-callouts.scss
View File

@ -7,6 +7,7 @@
font-weight: $medium;
color: $g20-white;
box-shadow: 2px 2px 6px rgba($g2-kevlar, .35);
z-index: 10;
// temp styles for animation
transition: margin .3s ease-out;
@ -50,8 +51,8 @@
#callout-url-selector {
position: absolute;
top: 3.25rem;
right: 1rem;
top: 3rem;
right: .75rem;
p:after {
top: -1rem;

61
assets/styles/layouts/_homepage.scss
View File

@ -34,7 +34,7 @@
// overflow: hidden;
h2 {
margin: 1.5rem 0 .5rem;
margin: 1.25rem 0 .5rem;
font-weight: 300;
font-size: 3rem;
}
@ -54,15 +54,16 @@
a.btn {
position: relative;
display: inline-block;
margin: .5rem .25rem .5rem 0;
padding: 1rem 2rem;
margin: .5rem .25rem .75rem 0;
padding: 1.25rem 2.25rem;
color: $article-btn-text !important;
border-radius: $radius;
font-weight: $medium;
font-size: 1.1rem;
text-decoration: none;
text-align: center;
z-index: 1;
@include gradient($article-btn-gradient);
@include gradient($home-btn-gradient);
&:after {
content: "";
@ -73,7 +74,7 @@
width: 100%;
height: 100%;
border-radius: $radius;
@include gradient($article-btn-gradient-hover);
@include gradient($home-btn-gradient-hover, 270deg);
opacity: 0;
transition: opacity .2s;
z-index: -1;
@ -175,10 +176,13 @@
flex-wrap: wrap;
position: relative;
color: $g20-white;
@include gradient($home-tick-bg-gradient, 45deg)
h2 { color: $article-heading-alt; }
a {
display: inline-block;
position: relative;
color: $g20-white;
&:after{
content: "";
margin-top: .15rem;
@ -192,12 +196,40 @@
&:after { width: 100%; }
}
}
}
.telegraf {@include gradient($telegraf-dropdown-gradient);}
.influxdb {@include gradient($default-dropdown-gradient);}
.chronograf {@include gradient($chronograf-dropdown-gradient);}
.kapacitor {@include gradient($kapacitor-dropdown-gradient);}
.card {
position: relative;
z-index: 1;
color: $article-text;
transition: color .2s;
&:after {
content: "";
position: absolute;
display: block;
bottom: 0;
left: 0;
width: 100%;
height: 100%;
opacity: 0;
z-index: -1;
transition: opacity .4s;
}
&.telegraf:after {@include gradient($telegraf-home-card-gradient);}
&.influxdb:after {@include gradient($default-home-card-gradient);}
&.chronograf:after {@include gradient($chronograf-home-card-gradient);}
&.kapacitor:after {@include gradient($kapacitor-home-card-gradient);}
&:hover {
color: $g20-white;
h2, a {color: $g20-white;}
&:after { opacity: 1; }
}
}
}
#enterprise {
padding-top: 2.5rem;
@ -294,7 +326,12 @@
padding-right: 0;
#tick-cards {
flex-direction: column;
.card { width: 100%; }
.card {
width: 100%;
color: $g20-white;
a {color: $g20-white;}
&:after { opacity: 1; }
}
}
}
&#enterprise { order: 4; padding-left: 0; padding-right: 0; }

17
assets/styles/layouts/_landing.scss
View File

@ -50,7 +50,8 @@
width: 90%;
position: relative;
margin-bottom: 1px;
padding: 2rem 3.5vw 2rem 3vw;
// padding: 2rem 3.5vw 2rem 3vw;
padding: 0 3.5vw 0 3vw; // added
min-height: 140px;
background: $landing-sm-bg;
transition: background-color .4s, width .2s;
@ -61,28 +62,31 @@
background: $landing-sm-bg-hover;
width: 100%;
h3 {
transform: translateY(-1.2rem);
font-weight: $medium;
font-size: 1.2rem;
}
p {
opacity: 1;
transition-delay: 100ms;
// transition-delay: 100ms;
max-height: 3.75rem; // added
}
}
h3 {
font-size: 1.1rem;
transition: all .2s;
margin: 0; // added
}
p {
position: absolute;
// position: absolute;
margin: .5rem 0 0; // added
max-height: 0; // added
width: 80%;
color: $g20-white;
font-size: .95rem;
line-height: 1.25rem;
opacity: 0;
transition: opacity .2s;
transition: opacity .2s .1s, max-height .2s;
}
}
@ -181,13 +185,14 @@
p {
opacity: .6;
position: relative;
max-height: fit-content;
width: auto;
margin: 0;
}
&:hover {
background: $landing-sm-bg-hover;
h3 { transform: none; }
p { opacity: 1; }
p { opacity: 1; max-height: fit-content; }
}
}
}

2
assets/styles/layouts/_v1-overrides.scss
View File

@ -1,4 +1,4 @@
body.v1{
body.v1, body.platform{
.article .article--content {
blockquote {
padding: 1.65rem 2rem .1rem 2rem;

6
assets/styles/themes/_theme-dark.scss
View File

@ -176,6 +176,12 @@ $landing-btn-text: $g20-white;
$landing-btn-grad: $grad-blue;
$landing-btn-grad-hover: $grad-blue-light;
// Home page colors
$home-btn-gradient: $grad-NineteenEightyFour;
$home-btn-gradient-hover: $grad-PastelGothic;
$home-tick-bg-gradient: $grad-grey-abyss;
$default-home-card-gradient: $grad-Miyazakisky;
// Tooltip colors
$tooltip-color: $br-chartreuse;
$tooltip-color-alt: $br-chartreuse;

6
assets/styles/themes/_theme-light.scss
View File

@ -176,6 +176,12 @@ $landing-btn-text: $g20-white !default;
$landing-btn-grad: $grad-blue !default;
$landing-btn-grad-hover: $grad-blue-light !default;
// Home page colors
$home-btn-gradient: $grad-NineteenEightyFour !default;
$home-btn-gradient-hover: $grad-PastelGothic !default;
$home-tick-bg-gradient: $grad-grey-mist !default;
$default-home-card-gradient: $grad-PastelGothic !default;
// Tooltip colors
$tooltip-color: $p-amethyst !default;
$tooltip-color-alt: $p-twilight !default;

3
assets/styles/themes/dark/chronograf.scss
View File

@ -29,3 +29,6 @@ $chronograf-btn-gradient-hover: $grad-OminousFog;
// Article Tabs for tabbed content
$chronograf-article-tab-active-text: $g20-white;
// Homepage cards
$chronograf-home-card-gradient: $grad-PurpleRain;

3
assets/styles/themes/dark/kapacitor.scss
View File

@ -29,3 +29,6 @@ $kapacitor-btn-gradient-hover: $grad-green-shade;
// Article Tabs for tabbed content
$kapacitor-article-tab-active-text: $g20-white;
// Homepage cards
$kapacitor-home-card-gradient: $grad-GarageBand;

4
assets/styles/themes/dark/telegraf.scss
View File

@ -29,3 +29,7 @@ $telegraf-btn-gradient-hover: $grad-yellow-dark;
// Article Tabs for tabbed content
$telegraf-article-tab-active-text: $g20-white;
// Homepage cards
$telegraf-home-card-gradient: $grad-ScotchBonnet;

3
assets/styles/themes/light/chronograf.scss
View File

@ -29,3 +29,6 @@ $chronograf-btn-gradient-hover: $grad-PurpleFog !default;
// Article Tabs for tabbed content
$chronograf-article-tab-active-text: $g20-white !default;
// Homepage cards
$chronograf-home-card-gradient: $grad-OminousFog !default;

3
assets/styles/themes/light/kapacitor.scss
View File

@ -29,3 +29,6 @@ $kapacitor-btn-gradient-hover: $grad-green !default;
// Article Tabs for tabbed content
$kapacitor-article-tab-active-text: $g20-white !default;
// Homepage cards
$kapacitor-home-card-gradient: $grad-GarageBand !default;

3
assets/styles/themes/light/telegraf.scss
View File

@ -29,3 +29,6 @@ $telegraf-btn-gradient-hover: $grad-yellow-dark !default;
// Article Tabs for tabbed content
$telegraf-article-tab-active-text: $g20-white !default;
// Homepage cards
$telegraf-home-card-gradient: $grad-ScotchBonnet !default;

4
assets/styles/tools/_color-palette.scss
View File

@ -104,9 +104,11 @@ $grad-LavenderLatte: $br-deeppurple, $p-star;
$grad-OminousFog: $br-pulsar, $br-galaxy;
// Single Hue Gradient
$grad-grey-mist: $g18-cloud, $g19-ghost;
$grad-grey-light: $g13-mist, $g18-cloud;
$grad-grey: $g10-wolf, $g13-mist;
$grad-grey-dark: $g3-castle, $g6-smoke;
$grad-grey-abyss: $g1-raven, $g2-kevlar;
$grad-blue-light: $b-pool, $b-hydrogen;
$grad-blue: $b-ocean, $b-pool;
@ -144,4 +146,4 @@ $grad-PurpleFog: $p-potassium, $cp-munchkin;
$grad-PurpleRain: $p-void, $cp-marguerite;
// Transparent gradients
$grad-whiteFade: rgba($g20-white, .75), rgba($g20-white, 0);
$grad-whiteFade: rgba($g20-white, .75), rgba($g20-white, 0);

2
config.toml
View File

@ -1,4 +1,4 @@
baseURL = "https://v2.docs.influxdata.com/"
baseURL = "https://docs.influxdata.com/"
languageCode = "en-us"
title = "InfluxDB Documentation"

16
content/chronograf/v1.6/about_the_project/_index.md
View File

@ -10,21 +10,7 @@ Chronograf is the user interface component of the [InfluxData time series platfo
Follow the links below for more information.
## [Chronograf 1.6 release notes](/chronograf/v1.6/about_the_project/release-notes-changelog/)
The [Chronograf 1.6 release notes](/chronograf/v1.6/about_the_project/release-notes-changelog/) includes details about features, bug fixes, and breaking changes for current and earlier Chronograf OSS releases.
## [Contributing to Chronograf](https://github.com/influxdata/chronograf/blob/master/CONTRIBUTING.md)
See [Contributing to InfluxDB OSS](https://github.com/influxdata/chronograf/blob/master/CONTRIBUTING.md) for information about how you can contribute to the InfluxDB OSS GitHub project.
### [InfluxData Contributor License Agreement (CLA)](https://influxdata.com/community/cla/)
In order to begin contributing to InfluxDB OSS project, you need to complete and sign the [InfluxData Contributor License Agreement (CLA)](https://influxdata.com/community/cla/).
## [Open source license for Chronograf](https://github.com/influxdata/chronograf/blob/master/LICENSE/)
See the [open source license for Chronograf](https://github.com/influxdata/chronograf/blob/master/LICENSE/) for conditions and restrictions for the use of the Chronograf source code.
{{< children hlevel="h2" >}}
Chronograf is released under the GNU Affero General Public License. This Free Software Foundation license is fairly new,
and differs from the more widely known and understood GPL.

24
content/chronograf/v1.6/about_the_project/release-notes-changelog.md
View File

@ -615,9 +615,9 @@ menu:
### UI improvements
* When dashboard time range is changed, reset graphs that are zoomed in
* [Bar graph](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#bar) option added to dashboard
* [Bar graph](/chronograf/v1.6/troubleshooting/frequently-asked-questions/#bar) option added to dashboard
* Redesign source management table to be more intuitive
* Redesign [Line + Single Stat](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#line-stat) cells to appear more like a sparkline, and improve legibility
* Redesign [Line + Single Stat](/chronograf/v1.6/troubleshooting/frequently-asked-questions/#line-stat) cells to appear more like a sparkline, and improve legibility
## v1.3.2.0 [2017-06-05]
@ -633,7 +633,7 @@ menu:
### Features
* Add UI to the Data Explorer for [writing data to InfluxDB](/{{< latest "chronograf" >}}/guides/transition-web-admin-interface/#writing-data)
* Add UI to the Data Explorer for [writing data to InfluxDB](/chronograf/v1.6/guides/transition-web-admin-interface/#writing-data)
### UI improvements
@ -653,26 +653,26 @@ In versions 1.3.1+, installing a new version of Chronograf automatically clears
### Bug fixes
* Fix infinite spinner when `/chronograf` is a [basepath](/{{< latest "chronograf" >}}/administration/configuration/#p-basepath)
* Fix infinite spinner when `/chronograf` is a [basepath](/chronograf/v1.6/administration/configuration/#p-basepath)
* Remove the query templates dropdown from dashboard cell editor mode
* Fix the backwards sort arrows in table column headers
* Make the logout button consistent with design
* Fix the loading spinner on graphs
* Filter out any template variable values that are empty, whitespace, or duplicates
* Allow users to click the add query button after selecting singleStat as the [visualization type](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#what-visualization-types-does-chronograf-support)
* Allow users to click the add query button after selecting singleStat as the [visualization type](/chronograf/v1.6/troubleshooting/frequently-asked-questions/#what-visualization-types-does-chronograf-support)
* Add a query for windows uptime - thank you, @brianbaker!
### Features
* Add log [event handler](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#what-kapacitor-event-handlers-are-supported-in-chronograf) - thank you, @mpchadwick!
* Add log [event handler](/chronograf/v1.6/troubleshooting/frequently-asked-questions/#what-kapacitor-event-handlers-are-supported-in-chronograf) - thank you, @mpchadwick!
* Update Go (golang) vendoring to dep and committed vendor directory
* Add autocomplete functionality to [template variable](/{{< latest "chronograf" >}}/guides/dashboard-template-variables/) dropdowns
* Add autocomplete functionality to [template variable](/chronograf/v1.6/guides/dashboard-template-variables/) dropdowns
### UI improvements
* Refactor scrollbars to support non-webkit browsers
* Increase the query builder's default height in cell editor mode and in the data explorer
* Make the [template variables](/{{< latest "chronograf" >}}/guides/dashboard-template-variables/) manager more space efficient
* Make the [template variables](/chronograf/v1.6/guides/dashboard-template-variables/) manager more space efficient
* Add page spinners to pages that did not have them
* Denote which source is connected in the sources table
* Use milliseconds in the InfluxDB dashboard instead of nanoseconds
@ -682,25 +682,25 @@ In versions 1.3.1+, installing a new version of Chronograf automatically clears
### Bug fixes
* Fix the link to home when using the [`--basepath` option](/{{< latest "chronograf" >}}/administration/configuration/#p-basepath)
* Fix the link to home when using the [`--basepath` option](/chronograf/v1.6/administration/configuration/#p-basepath)
* Remove the notification to login on the login page
* Support queries that perform math on functions
* Prevent the creation of blank template variables
* Ensure thresholds for Kapacitor Rule Alerts appear on page load
* Update the Kapacitor configuration page when the configuration changes
* Fix Authentication when using Chronograf with a set [basepath](/{{< latest "chronograf" >}}/administration/configuration/#p-basepath)
* Fix Authentication when using Chronograf with a set [basepath](/chronograf/v1.6/administration/configuration/#p-basepath)
* Show red indicator on Hosts Page for an offline host
* Support escaping from presentation mode in Safari
* Re-implement level colors on the alerts page
* Fix router bug introduced by upgrading to react-router v3.0
* Show legend on [Line+Stat](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#line-stat) visualization type
* Show legend on [Line+Stat](/chronograf/v1.6/troubleshooting/frequently-asked-questions/#line-stat) visualization type
* Prevent queries with `:dashboardTime:` from breaking the query builder
### Features
* Add line-protocol proxy for InfluxDB/InfluxDB Enterprise Cluster data sources
* Add `:dashboardTime:` to support cell-specific time ranges on dashboards
* Add support for enabling and disabling [TICKscripts that were created outside Chronograf](/{{< latest "chronograf" >}}/guides/advanced-kapacitor/#tickscript-management)
* Add support for enabling and disabling [TICKscripts that were created outside Chronograf](/chronograf/v1.6/guides/advanced-kapacitor/#tickscript-management)
* Allow users to delete Kapacitor configurations
### UI improvements

41
content/chronograf/v1.6/administration/_index.md
View File

@ -10,43 +10,4 @@ menu:
Follow the links below for more information.
## [Upgrading to Chronograf 1.6](/chronograf/v1.6/administration/upgrading/)
See [Upgrading to Chronograf 1.6](/chronograf/v1.6/administration/upgrading/) for details on upgrading to the latest Chronograf release.
## [Configuring Chronograf 1.6](/chronograf/v1.6/administration/configuration/)
See [Configuring Chronograf 1.6](/chronograf/v1.6/administration/configuration/) to information on starting Chronograf, configuring Chronograf, setting custom default Chronograf configuration options, and enabling security, multi-organization, and multi-user support.
## [Configuration options](/chronograf/v1.6/administration/config-options/)
[Configuration options](/chronograf/v1.6/administration/config-options/) includes details on Chronograf configuration options, including command line settings and environment variables, for the Chronograf service, connections for Kapacitor and InfluxDB, and OAuth 2.0 authentication options.
## [Connecting Chronograf to InfluxDB Enterprise clusters](/chronograf/v1.6/administration/chrono-on-clusters/)
[Connecting Chronograf to InfluxDB Enterprise clusters](/chronograf/v1.6/administration/chrono-on-clusters/) covers details on configuring and using Chronograf to monitor and manage your InfluxDB Enterprise clusters.
## [Creating InfluxDB and Kapacitor connections](/chronograf/v1.6/administration/creating-connections/)
[Creating InfluxDB and Kapacitor connections](/chronograf/v1.6/administration/creating-connections/) includes steps for creating InfluxDB and Kapacitor connections for use with Chronograf.
## [Managing InfluxDB users in Chronograf](/chronograf/v1.6/administration/managing-influxdb-users/)
[Managing InfluxDB users in Chronograf](/chronograf/v1.6/administration/managing-influxdb-users/) covers how to use Chronograf to create and manage InfluxDB users, roles, and permissions.
## [Managing Chronograf security](/chronograf/v1.6/administration/managing-security/)
See [Managing Chronograf security](/chronograf/v1.6/administration/managing-security/) for details on configuring OAuth 2.0 authentication providers, authentication duration, and configuring TLS and HTTPS support.
## [Managing Chronograf organizations](/chronograf/v1.6/administration/managing-organizations/)
[Managing Chronograf organizations](/chronograf/v1.6/administration/managing-organizations/) covers use of the Default organization and creating, managing, and removing Chronograf organizations.
## [Managing Chronograf users](/chronograf/v1.6/administration/managing-chronograf-users/)
See [Managing Chronograf users](/chronograf/v1.6/administration/managing-chronograf-users/) for details on managing Chronograf users and roles, organization-bound users, cross-organization SuperAdmin status, and navigating organizations in the Chronograf user interface.
## [Transitioning from InfluxDB's Web Admin Interface](/chronograf/v1.6/guides/transition-web-admin-interface/)
Versions 1.3+ of InfluxDB OSS and InfluxDB Enterprise no longer support the web admin interface, the built-in user interface for writing and querying data in InfluxDB.
Learn how to use Chronograf as a replacement for the web admin interface.
{{< children hlevel="h2" >}}

2
content/chronograf/v1.6/administration/chrono-on-clusters.md
View File

@ -19,4 +19,4 @@ Enter the HTTP bind address of one of your cluster's meta nodes into that input
Note that the example above assumes that you do not have authentication enabled.
If you have authentication enabled, the form requires username and password information.
For details about monitoring InfluxDB Enterprise clusters, see [Monitoring InfluxDB Enterprise clusters](/{{< latest "chronograf" >}}/guides/monitoring-influxenterprise-clusters/).
For details about monitoring InfluxDB Enterprise clusters, see [Monitoring InfluxDB Enterprise clusters](/chronograf/v1.6/guides/monitoring-influxenterprise-clusters/).

2
content/chronograf/v1.6/administration/config-options.md
View File

@ -78,7 +78,7 @@ Environment variable: `$BOLT_PATH`
#### `--canned-path=` | `-c`
The path to the directory of [canned dashboards](/{{< latest "chronograf" >}}/guides/using-precreated-dashboards/) files.
The path to the directory of [canned dashboards](/chronograf/v1.6/guides/using-precreated-dashboards/) files.
Default value: `/usr/share/chronograf/canned`

6
content/chronograf/v1.6/administration/configuration.md
View File

@ -47,12 +47,12 @@ It is neither created nor used in macOS.
## Enabling security, multi-organization, and multi-user support
See [Managing security](/{{< latest "chronograf" >}}/administration/managing-security) for details on configuring authentication options for Chronograf using the JWT and OAuth 2.0 authentication protocols.
See [Managing security](/chronograf/v1.6/administration/managing-security) for details on configuring authentication options for Chronograf using the JWT and OAuth 2.0 authentication protocols.
After you configure OAuth 2.0 authentication in Chronograf, you can use the multi-organization and multi-user support described in detail here:
* [Managing organizations](/{{< latest "chronograf" >}}/administration/managing-organizations)
* [Managing Chronograf users](/{{< latest "chronograf" >}}/administration/managing-chronograf-users)
* [Managing organizations](/chronograf/v1.6/administration/managing-organizations)
* [Managing Chronograf users](/chronograf/v1.6/administration/managing-chronograf-users)
<!-- TODO ## Configuring Chronograf for InfluxDB Enterprise clusters) -->

4
content/chronograf/v1.6/administration/managing-influxdb-users.md
View File

@ -13,7 +13,7 @@ menu:
The **Chronograf Admin** provides InfluxDB user management for InfluxDB OSS and InfluxDB Enterprise users.
> ***Note:*** For details on Chronograf user authentication and management, see [Managing security](/{{< latest "chronograf" >}}/administration/managing-security/).
> ***Note:*** For details on Chronograf user authentication and management, see [Managing security](/chronograf/v1.6/administration/managing-security/).
**On this page:**
@ -77,7 +77,7 @@ A successful `CREATE USER` query returns a blank result:
### Step 4: Edit the InfluxDB source in Chronograf.
If you've already [connected your database to Chronograf](/{{< latest "chronograf" >}}/introduction/getting-started/#3-connect-to-chronograf), update the connection configuration in Chronograf with your new username and password.
If you've already [connected your database to Chronograf](/chronograf/v1.6/introduction/getting-started/#3-connect-to-chronograf), update the connection configuration in Chronograf with your new username and password.
Edit existing InfluxDB database sources by navigating to the Chronograf configuration page and clicking on the name of the source.
## InfluxDB OSS User Management

6
content/chronograf/v1.6/administration/managing-organizations.md
View File

@ -22,7 +22,7 @@ menu:
> ***Note:*** Support for organizations and distinct users with role-based access control is new in Chronograf 1.4.
>
> For information about the new user roles and SuperAdmin status, see [Managing Chronograf users](/{{< latest "chronograf" >}}/administration/managing-chronograf-users/).
> For information about the new user roles and SuperAdmin status, see [Managing Chronograf users](/chronograf/v1.6/administration/managing-chronograf-users/).
A Chronograf organization is a collection of Chronograf users who share common Chronograf-owned resources, including dashboards, InfluxDB connections, and Kapacitor connections. Organizations can be used to represent companies, functional units, projects, or teams. Chronograf users can be members of multiple organizations.
@ -67,8 +67,8 @@ You can configure existing and new organizations in the **Organizations** tab of
See the following pages for more information about managing Chronograf users and security:
* [Managing Chronograf users](/{{< latest "chronograf" >}}/administration/managing-chronograf-users/)
* [Managing security](/{{< latest "chronograf" >}}/administration/managing-security/)
* [Managing Chronograf users](/chronograf/v1.6/administration/managing-chronograf-users/)
* [Managing security](/chronograf/v1.6/administration/managing-security/)
## Mapping organizations

2
content/chronograf/v1.6/administration/transition-web-admin-interface.md
View File

@ -80,7 +80,7 @@ In the web admin interface, the `Query Template` dropdown was the only way to ma
### Chronograf
In Chronograf, the `Admin` page includes a complete interface for user management.
The `Admin` page supports both InfluxDB OSS users and InfluxDB Enterprise users; see the [User Management](/{{< latest "chronograf" >}}/administration/user-management/) page for more information.
The `Admin` page supports both InfluxDB OSS users and InfluxDB Enterprise users; see the [User Management](/chronograf/v1.6/administration/user-management/) page for more information.
The `Admin` page allows users to:
* View, create, and delete users

2
content/chronograf/v1.6/administration/upgrading.md
View File

@ -24,4 +24,4 @@ Users can continue to use the deprecated product; documentation is available und
For more information, please read the original [announcement blog](https://www.influxdata.com/announcing-the-new-chronograf-a-ui-for-the-tick-stack-and-a-complete-open-source-monitoring-solution/) by our CTO, Paul Dix.
InfluxData recommends migrating to the open source Chronograf product.
See [Getting Started](/{{< latest "chronograf" >}}/introduction/getting-started/) to get up and running!
See [Getting Started](/chronograf/v1.6/introduction/getting-started/) to get up and running!

49
content/chronograf/v1.6/guides/_index.md
View File

@ -9,51 +9,4 @@ menu:
Follow the links below to explore Chronograf's features.
## [Using pre-created dashboards](/chronograf/v1.6/guides/using-precreated-dashboards/)
Pre-created dashboards are available when the required Telegraf input plugins are enabled. These applications make many useful metrics quickly available and are useful in giving you ideas about
## [Using the TICKscript editor](/chronograf/v1.6/guides/tickscript-logging/)
Using the TICKscript editor in Chronograf to create, test, and debug Kapacitor TICKscripts.
## [Creating dashboards](/{{< latest "chronograf" >}}/guides/create-a-dashboard/)
Chronograf offers a complete dashboard solution for visualizing your data and monitoring your infrastructure.
Learn how to create customized dashboards in Chronograf.
## [Cloning dashboards and cells](/chronograf/v1.6/guides/cloning-in-ui/)
Use Chronograf's cloning functionality to make copies of dashboards and cells.
## [Visualization types in Chronograf](/chronograf/v1.6/guides/visualization-types/)
Describes the visualization types available to display in Chronograf views in dashboards.
## [Adding annotations in Chronograf views](/chronograf/v1.6/guides/annotations/)
Describes how to add annotations to Chronograf views with the user interface or using the command line interface.
## [Creating Chronograf alert rules](/chronograf/v1.6/guides/create-alert-rules/)
Learn how to create alert rules in Chronograf.
## [Configuring Chronograf alert endpoints](/chronograf/v1.6/guides/configuring-alert-endpoints/)
Chronograf works with Kapacitor to send alert messages to supported event handlers.
Use Chronograf to send alert messages to specific URLs as well as to applications like Slack and HipChat.
Learn how to set up event handlers in Chronograf.
## [Monitoring InfluxDB Enterprise clusters](/chronograf/v1.6/guides/monitoring-influxenterprise-clusters/)
InfluxDB Enterprise offers high availability and a highly-scalable clustering solution for your time series data needs.
Learn how to use Chronograf to assess your cluster’s health and monitor the infrastructure behind your project.
## [Using dashboard template variables](/chronograf/v1.6/guides/dashboard-template-variables/)
Learn how to use Chronograf's dashboard template variables to interact with your dashboards and gain insights into your data.
## [Advanced Kapacitor usage](/chronograf/v1.6/guides/advanced-kapacitor/)
Chronograf provides a user interface for Kapacitor, InfluxData’s processing framework for creating alerts, running ETL jobs, and detecting anomalies in your data.
Learn how Kapacitor interacts with Chronograf at a lower level and learn about advanced Kapacitor usage within Chronograf.
{{< children hlevel="h3" >}}

6
content/chronograf/v1.6/guides/configuring-alert-endpoints.md
View File

@ -38,7 +38,7 @@ Chronograf supports the following event handlers:
* TCP
* VictorOps
To configure a Kapacitor event handler in Chronograf, [install Kapacitor](/{{< latest "chronograf" >}}/introduction/getting-started/#kapacitor-setup) and [connect it to Chronograf](/{{< latest "chronograf" >}}/introduction/getting-started/#4-connect-chronograf-to-kapacitor).
To configure a Kapacitor event handler in Chronograf, [install Kapacitor](/chronograf/v1.6/introduction/getting-started/#kapacitor-setup) and [connect it to Chronograf](/chronograf/v1.6/introduction/getting-started/#4-connect-chronograf-to-kapacitor).
The **Configure Kapacitor** page includes the event handler configuration options.
@ -46,10 +46,10 @@ The **Configure Kapacitor** page includes the event handler configuration option
Alert endpoint configurations appear on the Chronograf Configure Kapacitor page.
You must have a connected Kapacitor instance to access the configurations.
For more information, see [Kapacitor installation instructions](/{{< latest "chronograf" >}}/introduction/getting-started/#kapacitor-setup) and how to [connect a Kapacitor instance](/{{< latest "chronograf" >}}/introduction/getting-started/#4-connect-chronograf-to-kapacitor) to Chronograf.
For more information, see [Kapacitor installation instructions](/chronograf/v1.6/introduction/getting-started/#kapacitor-setup) and how to [connect a Kapacitor instance](/chronograf/v1.6/introduction/getting-started/#4-connect-chronograf-to-kapacitor) to Chronograf.
Note that the configuration options in the **Configure alert endpoints** section are not all-inclusive.
Some event handlers allow users to customize event handler configurations per [alert rule](/{{< latest "chronograf" >}}/guides/create-a-kapacitor-alert/).
Some event handlers allow users to customize event handler configurations per [alert rule](/chronograf/v1.6/guides/create-a-kapacitor-alert/).
For example, Chronograf's Slack integration allows users to specify a default channel in the **Configure alert endpoints** section and a different channel for individual alert rules.
### HipChat

10
content/chronograf/v1.6/guides/create-a-dashboard.md
View File

@ -9,7 +9,7 @@ menu:
---
Chronograf offers a complete dashboard solution for visualizing your data and monitoring your infrastructure.
Use Chronograf's [pre-created dashboards](/{{< latest "chronograf" >}}/guides/using-precreated-dashboards) or create custom dashboards to meet your requirements.
Use Chronograf's [pre-created dashboards](/chronograf/v1.6/guides/using-precreated-dashboards) or create custom dashboards to meet your requirements.
This guide shows you how to create custom Chronograf dashboards.
By the end of this guide, you'll be aware of the tools available to you for creating dashboards similar to this example:
@ -20,7 +20,7 @@ By the end of this guide, you'll be aware of the tools available to you for crea
To perform the tasks in this guide, you must have a working Chronograf instance that is connected to an InfluxDB source.
Data is accessed using the Telegraf [system ](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/system) input plugins.
For more information, see [Configuring Chronograf](/{{< latest "chronograf" >}}/administration/configuration).
For more information, see [Configuring Chronograf](/chronograf/v1.6/administration/configuration).
## Build a Dashboard
@ -55,7 +55,7 @@ In addition, the time range (`:dashboardTime:`) is [configurable on the dashboar
### Step 4: Choose your visualization type
Chronograf supports many different [visualization types](/{{< latest "chronograf" >}}/guides/visualization-types/). To choose a visualization type, click **Visualization** and select **Step-Plot Graph**.
Chronograf supports many different [visualization types](/chronograf/v1.6/guides/visualization-types/). To choose a visualization type, click **Visualization** and select **Step-Plot Graph**.
![Visualization type](/img/chronograf/1-6-g-dashboard-visualization.png)
@ -77,7 +77,7 @@ Click **Save** (the green checkmark icon) to save your cell.
* **Reset** your cell by double-clicking your mouse in the cell window
> Note:
These tips only apply to the line, stacked, step-plot, and line+stat [visualization types](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#what-visualization-types-does-chronograf-support).
These tips only apply to the line, stacked, step-plot, and line+stat [visualization types](/chronograf/v1.6/troubleshooting/frequently-asked-questions/#what-visualization-types-does-chronograf-support).
#### Configure dashboard-wide settings:
* You can change the dashboard's *auto-refresh interval* at the top of the page - the default interval selected is **Every 15 seconds**.
@ -93,4 +93,4 @@ To exit full screen mode, press the Esc key.
### Template variables
Dashboards support template variables.
See the [Dashboard Template Variables](/{{< latest "chronograf" >}}/guides/dashboard-template-variables/) guide for more information.
See the [Dashboard Template Variables](/chronograf/v1.6/guides/dashboard-template-variables/) guide for more information.

7
content/chronograf/v1.6/guides/create-alert-rules.md
View File

@ -26,13 +26,12 @@ This guide walks through creating a Chronograf alert rule that sends an alert me
## Requirements
[Getting started with Chronograf](/{{< latest "chronograf" >}}/introduction/getting-started/) offers step-by-step instructions for each of the following requirements:
[Getting started with Chronograf](/chronograf/v1.6/introduction/getting-started/) offers step-by-step instructions for each of the following requirements:
* Downloaded and install the entire TICKstack (Telegraf, InfluxDB, Chronograf, and Kapacitor).
* Configure Telegraf to collect data using the InfluxDB [system statistics](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/system) input plugin and write data to your InfluxDB instance.
* [Create a Kapacitor connection in Chronograf](/{{< latest "chronograf" >}}/introduction/getting-started/#4-connect-chronograf-to-kapacitor).
* Slack is available and configured as an [event handler](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#what-kapacitor-event-handlers-are-supported-in-chronograf) in Chronograf.
See the [Configuring Kapacitor Event Handlers](/{{< latest "chronograf" >}}/guides/configuring-alert-endpoints/) guide for detailed configuration instructions.
* [Create a Kapacitor connection in Chronograf](/chronograf/v1.6/introduction/getting-started/#4-connect-chronograf-to-kapacitor).
* Slack is available and configured as an event handler in Chronograf. See [Configuring Chronograf alert endpoints](/chronograf/v1.6/guides/configuring-alert-endpoints/) for detailed configuration instructions.
## Configuring Chronograf alert rules

4
content/chronograf/v1.6/guides/monitoring-influxenterprise-clusters.md
View File

@ -23,7 +23,7 @@ See the InfluxDB Enterprise documentation for
This guide uses an InfluxData Enterprise cluster with three meta nodes and three data nodes; the steps are also applicable to other cluster configurations.
InfluxData recommends using a separate server to store your monitoring data.
It is possible to store the monitoring data in your cluster and [connect the cluster to Chronograf](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#how-do-i-connect-chronograf-to-an-influxenterprise-cluster), but, in general, your monitoring data should live on a separate server.
It is possible to store the monitoring data in your cluster and [connect the cluster to Chronograf](/chronograf/v1.6/troubleshooting/frequently-asked-questions/#how-do-i-connect-chronograf-to-an-influxenterprise-cluster), but, in general, your monitoring data should live on a separate server.
You're working on an Ubuntu installation.
Chronograf and the other components of the TICK stack are supported on several operating systems and hardware architectures. Check out the [downloads page](https://portal.influxdata.com/downloads) for links to the binaries of your choice.
@ -258,6 +258,6 @@ In the image below, the Chronograf query editor is used to visualize the idle CP
![Data Explorer](/img/chronograf/1-6-cluster-de.png)
Create more customized graphs and save them to a dashboard on the Dashboard page in Chronograf.
See the [Creating Chronograf dashboards](/{{< latest "chronograf" >}}/guides/create-a-dashboard/) guide for more information.
See the [Creating Chronograf dashboards](/chronograf/v1.6/guides/create-a-dashboard/) guide for more information.
That's it! You've successfully configured Telegraf to collect and write data, InfluxDB to store those data, and Chonograf to use those data for monitoring and visualization purposes.

4
content/chronograf/v1.6/guides/using-precreated-dashboards.md
View File

@ -11,7 +11,7 @@ menu:
## Overview
Pre-created dashboards are delivered with Chronograf and are available depending on which Telegraf input plugins you have enabled. These dashboards include cells with data visualizations for metrics that are relevant to data sources you are likely to be using. The JSON files that are delivered include headings, queries, labels, and other information that can also be useful for helping you get started in [creating custom dashboards](/{{< latest "chronograf" >}}/guides/create-a-dashboard/).
Pre-created dashboards are delivered with Chronograf and are available depending on which Telegraf input plugins you have enabled. These dashboards include cells with data visualizations for metrics that are relevant to data sources you are likely to be using. The JSON files that are delivered include headings, queries, labels, and other information that can also be useful for helping you get started in [creating custom dashboards](/chronograf/v1.6/guides/create-a-dashboard/).
> Note that these pre-created dashboards do not appear in the Dashboards tab, which only include custom dashboards that your organization has created.
@ -33,7 +33,7 @@ Pre-created dashboards are delivered in Chronograf installations and are ready t
The pre-created dashboards available for use with Chronograf are listed below as Apps and appear in the Apps listing for hosts in the Host List page. The listings for apps (pre-created dashboards) on this page include information about the required Telegraf input plugins, JSON files included in the apps, and listings of the cell titles that are included in each of the JSON files.
The JSON files for the precreated dashboards are delivered on installation in the `/usr/share/chronograf/canned` directory. Information about the configuration option `--canned-path` can be found in the [Chronograf configuration options](/{{< latest "chronograf" >}}/administration/config-options/#) page.
The JSON files for the precreated dashboards are delivered on installation in the `/usr/share/chronograf/canned` directory. Information about the configuration option `--canned-path` can be found in the [Chronograf configuration options](/chronograf/v1.6/administration/config-options/#) page.
You can enable and disable applications in your [Telegraf configuration file](https://github.com/influxdata/telegraf/blob/master/etc/telegraf.conf).
See [Telegraf configuration](https://github.com/influxdata/telegraf/blob/master/docs/CONFIGURATION.md) for details.

14
content/chronograf/v1.6/introduction/_index.md
View File

@ -10,16 +10,4 @@ menu:
Follow the links below to get acquainted with Chronograf:
## [Downloading Chronograf](https://portal.influxdata.com/downloads)
Chronograf is supported on several operating systems and hardware architectures.
See the [InfluxData downloads page](https://portal.influxdata.com/downloads) page for to the available binaries.
## [Installing Chronograf](/{{< latest "chronograf" >}}/introduction/installation/)
[Installing Chronograf](/{{< latest "chronograf" >}}/introduction/installation/) lists the requirements for installing, starting, and configuring Chronograf.
## Getting Started
[Getting started with Chronograf](/{{< latest "chronograf" >}}/introduction/getting-started/) gets you up and running with Chronograf with as little configuration and code as possible.
By the end of the guide, you will have downloaded, installed, and configured all four packages of the
TICK stack ([Telegraf](https://github.com/influxdata/telegraf), [InfluxDB](https://github.com/influxdata/influxdb), Chronograf, and [Kapacitor](https://github.com/influxdata/kapacitor)), and you will be all set to monitor your infrastructure.
{{< children hlevel="h2" >}}

19
content/chronograf/v1.6/introduction/getting-started.md
View File

@ -1,8 +1,7 @@
---
title: Getting started with Chronograf
aliases:
- /{{< latest "chronograf" >}}/introduction/getting-started/
- /chronograf/v1.6/introduction/getting_started/
- /chronograf/v1.6/introduction/getting_started/
menu:
chronograf_1_6:
name: Getting started
@ -11,18 +10,18 @@ menu:
---
## Overview
Chronograf allows you to quickly see data you have stored in InfluxDB so you can build robust queries and alerts. After your administrator has set up Chronograf as described in [Installing Chronograf](/{{< latest "chronograf" >}}/introduction/installation), get started with key features using the guides below.
Chronograf allows you to quickly see data you have stored in InfluxDB so you can build robust queries and alerts. After your administrator has set up Chronograf as described in [Installing Chronograf](/chronograf/v1.6/introduction/installation), get started with key features using the guides below.
### Data visualization
* Investigate your data by building queries using [InfluxQL](/{{< latest "influxdb" "v1" >}}/query_language/).
* Use pre-created [pre-created dashboards](/{{< latest "chronograf" >}}/guides/using-precreated-dashboards/) to monitor your application data or [create your own dashboards](/{{< latest "chronograf" >}}/guides/create-a-dashboard/).
* Customize dashboards using [template variables](/{{< latest "chronograf" >}}/guides/dashboard-template-variables/).
* Use pre-created [pre-created dashboards](/chronograf/v1.6/guides/using-precreated-dashboards/) to monitor your application data or [create your own dashboards](/chronograf/v1.6/guides/create-a-dashboard/).
* Customize dashboards using [template variables](/chronograf/v1.6/guides/dashboard-template-variables/).
### Alerting
* [Create alert rules](/{{< latest "chronograf" >}}/guides/create-alert-rules/) to generate threshold, relative, and deadman alerts on your data.
* [View all active alerts](/{{< latest "chronograf" >}}/guides/create-alert-rules/#step-2-view-the-alerts) on an alert dashboard.
* Use [alert endpoints](/{{< latest "chronograf" >}}/guides/configuring-alert-endpoints/) in Chronograf to send alert messages to specific URLs and applications.
* [Create alert rules](/chronograf/v1.6/guides/create-alert-rules/) to generate threshold, relative, and deadman alerts on your data.
* [View all active alerts](/chronograf/v1.6/guides/create-alert-rules/#step-2-view-the-alerts) on an alert dashboard.
* Use [alert endpoints](/chronograf/v1.6/guides/configuring-alert-endpoints/) in Chronograf to send alert messages to specific URLs and applications.
### Infrastructure monitoring
* [View all hosts](/{{< latest "chronograf" >}}/guides/monitoring-influxenterprise-clusters/#step-4-explore-the-monitoring-data-in-chronograf) and their statuses in your infrastructure.
* [Use pre-created dashboards](/{{< latest "chronograf" >}}/guides/using-precreated-dashboards/) to monitor your applications.
* [View all hosts](/chronograf/v1.6/guides/monitoring-influxenterprise-clusters/#step-4-explore-the-monitoring-data-in-chronograf) and their statuses in your infrastructure.
* [Use pre-created dashboards](/chronograf/v1.6/guides/using-precreated-dashboards/) to monitor your applications.

2
content/chronograf/v1.6/troubleshooting/_index.md
View File

@ -9,4 +9,4 @@ menu:
Follow the link below to access Chronograf's FAQ.
## [Frequently Asked Questions](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/)
{{< children hlevel="h2" >}}

2
content/chronograf/v1.6/troubleshooting/frequently-asked-questions.md
View File

@ -19,4 +19,4 @@ Enter the HTTP bind address of one of your cluster's meta nodes into that input
Note that the example above assumes that you do not have authentication enabled.
If you have authentication enabled, the form requires username and password information.
For more details about monitoring an InfluxDB Enterprise cluster, see the [Monitor an InfluxDB Enterprise Cluster](/{{< latest "chronograf" >}}/guides/monitoring-influxenterprise-clusters/) guide.
For more details about monitoring an InfluxDB Enterprise cluster, see the [Monitor an InfluxDB Enterprise Cluster](/chronograf/v1.6/guides/monitoring-influxenterprise-clusters/) guide.

18
content/chronograf/v1.7/about_the_project/_index.md
View File

@ -1,6 +1,6 @@
---
title: About the Chronograf project
description: Chronograf is the UI component of the InfluxData time series platform. This section includes documentation about the Chronograf project, release notes and changelogs, what's new, contributing, and licenses.
description: Learn about Chronograf, the user interface (UI) for InfluxDB.
menu:
chronograf_1_7:
name: About the project
@ -10,21 +10,7 @@ Chronograf is the user interface component of the [InfluxData time series platfo
Follow the links below for more information.
## [Chronograf 1.7 release notes](/chronograf/v1.7/about_the_project/release-notes-changelog/)
The [Chronograf 1.7 release notes](/chronograf/v1.7/about_the_project/release-notes-changelog/) includes details about features, bug fixes, and breaking changes for current and earlier Chronograf OSS releases.
## [Contributing to Chronograf](https://github.com/influxdata/chronograf/blob/master/CONTRIBUTING.md)
See [Contributing to InfluxDB OSS](https://github.com/influxdata/chronograf/blob/master/CONTRIBUTING.md) for information about how you can contribute to the InfluxDB OSS GitHub project.
### [InfluxData Contributor License Agreement (CLA)](https://influxdata.com/community/cla/)
In order to begin contributing to InfluxDB OSS project, you need to complete and sign the [InfluxData Contributor License Agreement (CLA)](https://influxdata.com/community/cla/).
## [Open source license for Chronograf](https://github.com/influxdata/chronograf/blob/master/LICENSE/)
See the [open source license for Chronograf](https://github.com/influxdata/chronograf/blob/master/LICENSE/) for conditions and restrictions for the use of the Chronograf source code.
{{< children hlevel="h2" >}}
Chronograf is released under the GNU Affero General Public License. This Free Software Foundation license is fairly new,
and differs from the more widely known and understood GPL.

2
content/chronograf/v1.7/about_the_project/cla.md
View File

@ -1,6 +1,6 @@
---
title: InfluxData Contributor License Agreement (CLA)
description: Before contributing to the Chronograf project, you need to submit the InfluxData Contributor License Agreement.
description: Before contributing to the Chronograf project, submit the InfluxData Contributor License Agreement.
menu:
chronograf_1_7:
weight: 30

4
content/chronograf/v1.7/about_the_project/contributing.md
View File

@ -1,8 +1,8 @@
---
title: Contributing to Chronograf
title: Contribute to Chronograf
menu:
chronograf_1_7:
name: Contributing
name: Contribute
weight: 20
parent: About the project
url: https://github.com/influxdata/chronograf/blob/master/CONTRIBUTING.md

24
content/chronograf/v1.7/about_the_project/release-notes-changelog.md
View File

@ -1,6 +1,6 @@
---
title: Chronograf 1.7 release notes
description: Features, breaking features, user interface improvements, and bug fixes for the latest and earlier Chronograf releases for the InfluxData time series platform.
description: Important changes and what's new in each version of Chronograf.
menu:
chronograf_1_7:
name: Release notes
@ -836,9 +836,9 @@ menu:
### UI improvements
* When dashboard time range is changed, reset graphs that are zoomed in
* [Bar graph](/{{< latest "chronograf" >}}/guides/visualization-types/#bar-graph) option added to dashboard
* [Bar graph](/chronograf/v1.7/guides/visualization-types/#bar-graph) option added to dashboard
* Redesign source management table to be more intuitive
* Redesign [Line + Single Stat](/{{< latest "chronograf" >}}/guides/visualization-types/#line-graph-single-stat) cells to appear more like a sparkline, and improve legibility
* Redesign [Line + Single Stat](/chronograf/v1.7/guides/visualization-types/#line-graph-single-stat) cells to appear more like a sparkline, and improve legibility
## v1.3.2.0 [2017-06-05]
@ -854,7 +854,7 @@ menu:
### Features
* Add UI to the Data Explorer for [writing data to InfluxDB](/{{< latest "chronograf" >}}/guides/querying-data/)
* Add UI to the Data Explorer for [writing data to InfluxDB](/chronograf/v1.7/guides/querying-data/)
### UI improvements
@ -874,26 +874,26 @@ In versions 1.3.1+, installing a new version of Chronograf automatically clears
### Bug fixes
* Fix infinite spinner when `/chronograf` is a [basepath](/{{< latest "chronograf" >}}/administration/config-options/#p-basepath)
* Fix infinite spinner when `/chronograf` is a [basepath](/chronograf/v1.7/administration/config-options/#p-basepath)
* Remove the query templates dropdown from dashboard cell editor mode
* Fix the backwards sort arrows in table column headers
* Make the logout button consistent with design
* Fix the loading spinner on graphs
* Filter out any template variable values that are empty, whitespace, or duplicates
* Allow users to click the add query button after selecting singleStat as the [visualization type](/{{< latest "chronograf" >}}/guides/visualization-types)
* Allow users to click the add query button after selecting singleStat as the [visualization type](/chronograf/v1.7/guides/visualization-types)
* Add a query for windows uptime - thank you, @brianbaker!
### Features
* Add log event handler- thank you, @mpchadwick!
* Update Go (golang) vendoring to dep and committed vendor directory
* Add autocomplete functionality to [template variable](/{{< latest "chronograf" >}}/guides/dashboard-template-variables) dropdowns
* Add autocomplete functionality to [template variable](/chronograf/v1.7/guides/dashboard-template-variables) dropdowns
### UI improvements
* Refactor scrollbars to support non-webkit browsers
* Increase the query builder's default height in cell editor mode and in the data explorer
* Make the [template variables](/{{< latest "chronograf" >}}/guides/dashboard-template-variables) manager more space efficient
* Make the [template variables](/chronograf/v1.7/guides/dashboard-template-variables) manager more space efficient
* Add page spinners to pages that did not have them
* Denote which source is connected in the sources table
* Use milliseconds in the InfluxDB dashboard instead of nanoseconds
@ -903,25 +903,25 @@ In versions 1.3.1+, installing a new version of Chronograf automatically clears
### Bug fixes
* Fix the link to home when using the [`--basepath` option](/{{< latest "chronograf" >}}/administration/config-options/#p-basepath)
* Fix the link to home when using the [`--basepath` option](/chronograf/v1.7/administration/config-options/#p-basepath)
* Remove the notification to login on the login page
* Support queries that perform math on functions
* Prevent the creation of blank template variables
* Ensure thresholds for Kapacitor Rule Alerts appear on page load
* Update the Kapacitor configuration page when the configuration changes
* Fix Authentication when using Chronograf with a set [basepath](/{{< latest "chronograf" >}}/administration/config-options/#p-basepath)
* Fix Authentication when using Chronograf with a set [basepath](/chronograf/v1.7/administration/config-options/#p-basepath)
* Show red indicator on Hosts Page for an offline host
* Support escaping from presentation mode in Safari
* Re-implement level colors on the alerts page
* Fix router bug introduced by upgrading to react-router v3.0
* Show legend on [Line+Stat](/{{< latest "chronograf" >}}/guides/visualization-types/#line-graph-single-stat) visualization type
* Show legend on [Line+Stat](/chronograf/v1.7/guides/visualization-types/#line-graph-single-stat) visualization type
* Prevent queries with `:dashboardTime:` from breaking the query builder
### Features
* Add line-protocol proxy for InfluxDB/InfluxEnterprise Cluster data sources
* Add `:dashboardTime:` to support cell-specific time ranges on dashboards
* Add support for enabling and disabling [TICKscripts that were created outside Chronograf](/{{< latest "chronograf" >}}/guides/advanced-kapacitor/#tickscript-management)
* Add support for enabling and disabling [TICKscripts that were created outside Chronograf](/chronograf/v1.7/guides/advanced-kapacitor/#tickscript-management)
* Allow users to delete Kapacitor configurations
### UI improvements

43
content/chronograf/v1.7/administration/_index.md
View File

@ -1,6 +1,6 @@
---
title: Administering Chronograf
description: This section documents Chronograf administration, including configuration, InfluxDB Enterprise clusters, Kapacitor and InfluxDB connections, user and organization management, security, and upgrading.
description: Learn how to administer Chronograf.
menu:
chronograf_1_7:
name: Administration
@ -10,43 +10,4 @@ menu:
Follow the links below for more information.
## [Upgrading to Chronograf 1.7](/chronograf/v1.7/administration/upgrading/)
See [Upgrading to Chronograf 1.7](/chronograf/v1.7/administration/upgrading/) for details on upgrading to the latest Chronograf release.
## [Configuring Chronograf 1.7](/chronograf/v1.7/administration/configuration/)
See [Configuring Chronograf 1.7](/chronograf/v1.7/administration/configuration/) to information on starting Chronograf, configuring Chronograf, setting custom default Chronograf configuration options, and enabling security, multi-organization, and multi-user support.
## [Configuration options](/chronograf/v1.7/administration/config-options/)
[Configuration options](/chronograf/v1.7/administration/config-options/) includes details on Chronograf configuration options, including command line settings and environment variables, for the Chronograf service, connections for Kapacitor and InfluxDB, and OAuth 2.0 authentication options.
## [Connecting Chronograf to InfluxDB Enterprise clusters](/chronograf/v1.7/administration/chrono-on-clusters/)
[Connecting Chronograf to InfluxDB Enterprise clusters](/chronograf/v1.7/administration/chrono-on-clusters/) covers details on configuring and using Chronograf to monitor and manage your InfluxDB Enterprise clusters.
## [Creating InfluxDB and Kapacitor connections](/chronograf/v1.7/administration/creating-connections/)
[Creating InfluxDB and Kapacitor connections](/chronograf/v1.7/administration/creating-connections/) includes steps for creating InfluxDB and Kapacitor connections for use with Chronograf.
## [Managing InfluxDB users in Chronograf](/chronograf/v1.7/administration/managing-influxdb-users/)
[Managing InfluxDB users in Chronograf](/chronograf/v1.7/administration/managing-influxdb-users/) covers how to use Chronograf to create and manage InfluxDB users, roles, and permissions.
## [Managing Chronograf security](/chronograf/v1.7/administration/managing-security/)
See [Managing Chronograf security](/chronograf/v1.7/administration/managing-security/) for details on configuring OAuth 2.0 authentication providers, authentication duration, and configuring TLS and HTTPS support.
## [Managing Chronograf organizations](/chronograf/v1.7/administration/managing-organizations/)
[Managing Chronograf organizations](/chronograf/v1.7/administration/managing-organizations/) covers use of the Default organization and creating, managing, and removing Chronograf organizations.
## [Managing Chronograf users](/chronograf/v1.7/administration/managing-chronograf-users/)
See [Managing Chronograf users](/chronograf/v1.7/administration/managing-chronograf-users/) for details on managing Chronograf users and roles, organization-bound users, cross-organization SuperAdmin status, and navigating organizations in the Chronograf user interface.
## [Transitioning from InfluxDB's Web Admin Interface](/chronograf/v1.7/guides/transition-web-admin-interface/)
Versions 1.3+ of InfluxDB OSS and InfluxDB Enterprise no longer support the web admin interface, the built-in user interface for writing and querying data in InfluxDB.
Learn how to use Chronograf as a replacement for the web admin interface.
{{< children hlevel="h2" >}}

8
content/chronograf/v1.7/administration/chrono-on-clusters.md
View File

@ -1,9 +1,9 @@
---
title: Connecting Chronograf to InfluxDB Enterprise clusters
description: Configuration steps for connecting Chronograf to InfluxDB Enterprise clusters and the InfluxData time series platform.
title: Connect Chronograf to InfluxDB Enterprise clusters
description: Connect Chronograf to InfluxDB Enterprise.
menu:
chronograf_1_7:
name: Connecting Chronograf to clusters
name: Connect Chronograf to clusters
weight: 40
parent: Administration
---
@ -19,4 +19,4 @@ Enter the HTTP bind address of one of your cluster's meta nodes into that input
Note that the example above assumes that you do not have authentication enabled.
If you have authentication enabled, the form requires username and password information.
For details about monitoring InfluxEnterprise clusters, see [Monitoring InfluxDB Enterprise clusters](/{{< latest "chronograf" >}}/guides/monitoring-influxenterprise-clusters).
For details about monitoring InfluxEnterprise clusters, see [Monitoring InfluxDB Enterprise clusters](/chronograf/v1.7/guides/monitoring-influxenterprise-clusters).

4
content/chronograf/v1.7/administration/config-options.md
View File

@ -1,6 +1,6 @@
---
title: Chronograf configuration options
description: Details on configuration settings (command line options and environment variables) for Chronograf services, Kapacitor and InfluxDB connections, and OAuth 2.0 authentication providers.
description: Review options available in the Chronograf configuration file and environment variables.
menu:
chronograf_1_7:
name: Configuration options
@ -78,7 +78,7 @@ Environment variable: `$BOLT_PATH`
#### `--canned-path=` | `-c`
The path to the directory of [canned dashboards](/{{< latest "chronograf" >}}/guides/using-precreated-dashboards) files.
The path to the directory of [canned dashboards](/chronograf/v1.7/guides/using-precreated-dashboards) files.
Default value: `/usr/share/chronograf/canned`

3
content/chronograf/v1.7/administration/configuration.md
View File

@ -54,8 +54,7 @@ To set up security for Chronograf, configure:
After you configure OAuth 2.0 authentication, you can set up multiple organizations, roles, and users. For details, check out the following topics:
* [Managing organizations](chronograf/v1.7/administration/managing-organizations/)
* [Managing organizations](/chronograf/v1.7/administration/managing-organizations/)
* [Managing Chronograf users](/chronograf/v1.7/administration/managing-chronograf-users/)
<!-- TODO ## Configuring Chronograf for InfluxDB Enterprise clusters) -->

2
content/chronograf/v1.7/administration/creating-connections.md
View File

@ -39,7 +39,7 @@ To create an InfluxDB connection in the Chronograf UI:
* **Make this the default connection**: When this option is selected, this InfluxDB connection will be used when Chronograf is launched.
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](/{{< latest "chronograf" >}}/guides/create-a-dashboard).
* 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.7/guides/create-a-dashboard).
* If the connection cannot be created, the following error message appears:
"Unable to create source: Error contacting source."
If this occurs, ensure all connection credentials are correct and that the InfluxDB instance is running and accessible.

5
content/chronograf/v1.7/administration/managing-influxdb-users.md
View File

@ -12,8 +12,7 @@ menu:
The **Chronograf Admin** provides InfluxDB user management for InfluxDB OSS and InfluxDB Enterprise users.
> ***Note:*** For details on Chronograf user authentication and management, see [Managing security](/{{< latest "chronograf" >}}/administration/managing-security/).
> ***Note:*** For details on Chronograf user authentication and management, see [Managing security](/chronograf/v1.7/administration/managing-security/).
**On this page:**
@ -77,7 +76,7 @@ A successful `CREATE USER` query returns a blank result:
### Step 4: Edit the InfluxDB source in Chronograf.
If you've already [connected your database to Chronograf](chronograf/latest/introduction/installation#connect-chronograf-to-your-influxdb-instance-or-influxdb-enterprise-cluster), update the connection configuration in Chronograf with your new username and password.
If you've already [connected your database to Chronograf](/chronograf/v1.8/introduction/installation#connect-chronograf-to-your-influxdb-instance-or-influxdb-enterprise-cluster), update the connection configuration in Chronograf with your new username and password.
Edit existing InfluxDB database sources by navigating to the Chronograf configuration page and clicking on the name of the source.
## InfluxDB OSS User Management

4
content/chronograf/v1.7/administration/managing-security.md
View File

@ -20,8 +20,8 @@ To enhance security, configure Chronograf to authenticate and authorize with [OA
## Configure OAuth 2.0
> After configuring OAuth 2.0, the Chronograf Admin tab becomes visible.
> You can then set up [multiple organizations](/{{< latest "chronograf" >}}/administration/managing-organizations/)
> and [users](/{{< latest "chronograf" >}}/administration/managing-influxdb-users/).
> You can then set up [multiple organizations](/chronograf/v1.7/administration/managing-organizations/)
> and [users](/chronograf/v1.7/administration/managing-influxdb-users/).
Configure Chronograf to use an OAuth 2.0 provider and JWT (JSON Web Token) to authenticate users and enable role-based access controls.

2
content/chronograf/v1.7/administration/transition-web-admin-interface.md
View File

@ -80,7 +80,7 @@ In the web admin interface, the `Query Template` dropdown was the only way to ma
### Chronograf
In Chronograf, the `Admin` page includes a complete interface for user management.
The `Admin` page supports both InfluxDB OSS users and InfluxDB Enterprise users; see [Managing Chronograf Users](/{{< latest "chronograf" >}}/administration/managing-chronograf-users/) page for more information.
The `Admin` page supports both InfluxDB OSS users and InfluxDB Enterprise users; see [Managing Chronograf Users](/chronograf/v1.7/administration/managing-chronograf-users/) page for more information.
The `Admin` page allows users to:
* View, create, and delete users

2
content/chronograf/v1.7/administration/upgrading.md
View File

@ -24,4 +24,4 @@ Users can continue to use the deprecated product; documentation is available und
For more information, please read the original [announcement blog](https://www.influxdata.com/announcing-the-new-chronograf-a-ui-for-the-tick-stack-and-a-complete-open-source-monitoring-solution/) by our CTO, Paul Dix.
InfluxData recommends migrating to the open source Chronograf product.
See [Getting Started](/{{< latest "chronograf" >}}/introduction/getting-started/) to get up and running!
See [Getting Started](/chronograf/v1.7/introduction/getting-started/) to get up and running!

54
content/chronograf/v1.7/guides/_index.md
View File

@ -9,56 +9,4 @@ menu:
Follow the links below to explore Chronograf's features.
## [Exploring data in Chronograf](/chronograf/v1.7/guides/querying-data)
Use Chronograf's Data Explorer to query and visualize your time series data.
## [Using pre-created dashboards](/chronograf/v1.7/guides/using-precreated-dashboards/)
Pre-created dashboards are available when the required Telegraf input plugins are enabled. These dashboards include cells with data visualizations for metrics that are relevant to data sources you are likely to be using.
## [Using the TICKscript editor](/chronograf/v1.7/guides/tickscript-logging/)
Using the TICKscript editor in Chronograf to create, test, and debug Kapacitor TICKscripts.
## [Creating dashboards](/{{< latest "chronograf" >}}/guides/create-a-dashboard/)
Chronograf offers a complete dashboard solution for visualizing your data and monitoring your infrastructure.
Learn how to create customized dashboards in Chronograf.
## [Cloning dashboards and cells](/chronograf/v1.7/guides/cloning-in-ui/)
Use Chronograf's cloning functionality to make copies of dashboards and cells.
## [Visualization types in Chronograf](/chronograf/v1.7/guides/visualization-types/)
Describes the visualization types available to display in Chronograf views in dashboards.
## [Adding annotations in Chronograf views](/chronograf/v1.7/guides/annotations/)
Describes how to add annotations to Chronograf views with the user interface or using the command line interface.
## [Creating Chronograf alert rules](/chronograf/v1.7/guides/create-alert-rules/)
Learn how to create alert rules in Chronograf.
## [Configuring Chronograf alert endpoints](/chronograf/v1.7/guides/configuring-alert-endpoints/)
Chronograf works with Kapacitor to send alert messages to supported event handlers.
Use Chronograf to send alert messages to specific URLs as well as to applications like Slack and HipChat.
Learn how to set up event handlers in Chronograf.
## [Monitoring InfluxDB Enterprise clusters](/chronograf/v1.7/guides/monitoring-influxenterprise-clusters/)
InfluxDB Enterprise offers high availability and a highly-scalable clustering solution for your time series data needs.
Learn how to use Chronograf to assess your cluster’s health and monitor the infrastructure behind your project.
## [Using dashboard template variables](/chronograf/v1.7/guides/dashboard-template-variables/)
Learn how to use Chronograf's dashboard template variables to interact with your dashboards and gain insights into your data.
## [Advanced Kapacitor usage](/chronograf/v1.7/guides/advanced-kapacitor/)
Chronograf provides a user interface for Kapacitor, InfluxData’s processing framework for creating alerts, running ETL jobs, and detecting anomalies in your data.
Learn how Kapacitor interacts with Chronograf at a lower level and learn about advanced Kapacitor usage within Chronograf.
{{< children hlevel="h2" >}}

4
content/chronograf/v1.7/guides/configuring-alert-endpoints.md
View File

@ -50,7 +50,7 @@ You must have a connected Kapacitor instance to access the configurations.
For more information, see [Kapacitor installation instructions](/{{< latest "kapacitor" >}}/introduction/installation/) and how to [connect a Kapacitor instance](/{{< latest "kapacitor" >}}/working/kapa-and-chrono/#add-a-kapacitor-instance) to Chronograf.
Note that the configuration options in the **Configure alert endpoints** section are not all-inclusive.
Some event handlers allow users to customize event handler configurations per [alert rule](/{{< latest "chronograf" >}}/guides/create-a-kapacitor-alert/).
Some event handlers allow users to customize event handler configurations per [alert rule](/chronograf/v1.7/guides/create-a-kapacitor-alert/).
For example, Chronograf's Slack integration allows users to specify a default channel in the **Configure alert endpoints** section and a different channel for individual alert rules.
### HipChat
@ -87,7 +87,7 @@ The following steps describe how to create the API access token:
Your token appears in the table just above the **Create new token** section:
![HipChat token](/img/{{< latest "chronograf" >}}/g-eventhandlers-hipchattoken.png)
![HipChat token](/img/chronograf/1-6-g-eventhandlers-hipchattoken.png)
### Kafka

10
content/chronograf/v1.7/guides/create-a-dashboard.md
View File

@ -10,7 +10,7 @@ menu:
Chronograf offers a complete dashboard solution for visualizing your data and monitoring your infrastructure:
* View [pre-created dashboards](/{{< latest "chronograf" >}}/guides/using-precreated-dashboards) from the Host List page. Dashboards are available depending on which Telegraf input plugins you have enabled. These pre-created dashboards cannot be cloned or edited.
* View [pre-created dashboards](/chronograf/v1.7/guides/using-precreated-dashboards) from the Host List page. Dashboards are available depending on which Telegraf input plugins you have enabled. These pre-created dashboards cannot be cloned or edited.
* Create custom dashboards from scratch by building queries in the Data Explorer, as described [below](#build-a-dashboard).
* Import dashboard templates when you add or update a connection in Chronograf. See [Dashboard templates](#dashboard-templates) for details.
@ -23,7 +23,7 @@ By the end of this guide, you'll be aware of the tools available to you for crea
To perform the tasks in this guide, you must have a working Chronograf instance that is connected to an InfluxDB source.
Data is accessed using the Telegraf [system ](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/system) input plugins.
For more information, see [Configuring Chronograf](/{{< latest "chronograf" >}}/administration/configuration).
For more information, see [Configuring Chronograf](/chronograf/v1.7/administration/configuration).
## Build a Dashboard
@ -58,7 +58,7 @@ In addition, the time range (`:dashboardTime:`) is [configurable on the dashboar
### Step 4: Choose your visualization type
Chronograf supports many different [visualization types](/{{< latest "chronograf" >}}/guides/visualization-types/). To choose a visualization type, click **Visualization** and select **Step-Plot Graph**.
Chronograf supports many different [visualization types](/chronograf/v1.7/guides/visualization-types/). To choose a visualization type, click **Visualization** and select **Step-Plot Graph**.
![Visualization type](/img/chronograf/1-6-g-dashboard-visualization.png)
@ -80,7 +80,7 @@ Click **Save** (the green checkmark icon) to save your cell.
* **Reset** your cell by double-clicking your mouse in the cell window
> **Note:**
These tips only apply to the line, stacked, step-plot, and line+stat [visualization types](/{{< latest "chronograf" >}}/guides/visualization-types/).
These tips only apply to the line, stacked, step-plot, and line+stat [visualization types](/chronograf/v1.7/guides/visualization-types/).
#### Configure dashboard-wide settings:
* Change the dashboard's *selected time* at the top of the page - the default time is **Local**, which uses your browser's local time. Select **UTC** to use Coordinated Universal Time.
@ -119,4 +119,4 @@ To exit full screen mode, press the Esc key.
### Template variables
Dashboards support template variables.
See the [Dashboard Template Variables](/{{< latest "chronograf" >}}/guides/dashboard-template-variables/) guide for more information.
See the [Dashboard Template Variables](/chronograf/v1.7/guides/dashboard-template-variables/) guide for more information.

8
content/chronograf/v1.7/guides/create-alert-rules.md
View File

@ -10,7 +10,6 @@ menu:
parent: Guides
---
Chronograf provides a user interface for [Kapacitor](/{{< latest "kapacitor" >}}/), InfluxData's processing framework for creating alerts, ETL jobs (running extract, transform, load), and detecting anomalies in your data.
Chronograf alert rules correspond to Kapacitor tasks that trigger alerts whenever certain conditions are met.
Behind the scenes, these tasks are stored as [TICKscripts](/{{< latest "kapacitor" >}}/tick/) that can be edited manually or through Chronograf.
@ -26,13 +25,12 @@ This guide walks through creating a Chronograf alert rule that sends an alert me
## Requirements
[Getting started with Chronograf](/{{< latest "chronograf" >}}/introduction/getting-started/) offers step-by-step instructions for each of the following requirements:
[Getting started with Chronograf](/chronograf/v1.7/introduction/getting-started/) offers step-by-step instructions for each of the following requirements:
* Downloaded and install the entire TICKstack (Telegraf, InfluxDB, Chronograf, and Kapacitor).
* Configure Telegraf to collect data using the InfluxDB [system statistics](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/system) input plugin and write data to your InfluxDB instance.
* [Create a Kapacitor connection in Chronograf](/{{< latest "chronograf" >}}/introduction/getting-started/#4-connect-chronograf-to-kapacitor).
* Slack is available and configured as an [event handler](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#what-kapacitor-event-handlers-are-supported-in-chronograf) in Chronograf.
See the [Configuring Kapacitor Event Handlers](/{{< latest "chronograf" >}}/guides/configuring-alert-endpoints/) guide for detailed configuration instructions.
* [Create a Kapacitor connection in Chronograf](/chronograf/v1.7/introduction/installation/#connect-chronograf-to-kapacitor).
* Slack is available and configured as an event handler in Chronograf. See [Configuring Chronograf alert endpoints](/chronograf/v1.7/guides/configuring-alert-endpoints/) for detailed configuration instructions.
## Configuring Chronograf alert rules

4
content/chronograf/v1.7/guides/monitoring-influxenterprise-clusters.md
View File

@ -23,7 +23,7 @@ See the InfluxEnterprise documentation for
This guide uses an InfluxData Enterprise cluster with three meta nodes and three data nodes; the steps are also applicable to other cluster configurations.
InfluxData recommends using a separate server to store your monitoring data.
It is possible to store the monitoring data in your cluster and [connect the cluster to Chronograf](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#how-do-i-connect-chronograf-to-an-influxenterprise-cluster), but, in general, your monitoring data should live on a separate server.
It is possible to store the monitoring data in your cluster and [connect the cluster to Chronograf](/chronograf/v1.7/troubleshooting/frequently-asked-questions/#how-do-i-connect-chronograf-to-an-influxenterprise-cluster), but, in general, your monitoring data should live on a separate server.
You're working on an Ubuntu installation.
Chronograf and the other components of the TICK stack are supported on several operating systems and hardware architectures. Check out the [downloads page](https://portal.influxdata.com/downloads) for links to the binaries of your choice.
@ -258,6 +258,6 @@ In the image below, the Chronograf query editor is used to visualize the idle CP
![Data Explorer](/img/chronograf/1-6-cluster-de.png)
Create more customized graphs and save them to a dashboard on the Dashboard page in Chronograf.
See the [Creating Chronograf dashboards](/{{< latest "chronograf" >}}/guides/create-a-dashboard/) guide for more information.
See the [Creating Chronograf dashboards](/chronograf/v1.7/guides/create-a-dashboard/) guide for more information.
That's it! You've successfully configured Telegraf to collect and write data, InfluxDB to store those data, and Chonograf to use those data for monitoring and visualization purposes.

4
content/chronograf/v1.7/guides/querying-data.md
View File

@ -7,7 +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](/{{< latest "chronograf" >}}/guides/visualization-types/) for your query.
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.7/guides/visualization-types/) for your query.
To open the **Data Explorer**, click the **Explore** icon in the navigation bar:
@ -66,7 +66,7 @@ Flux is InfluxData's new functional data scripting language designed for queryin
## Visualize your query
Select the **Visualization** tab at the top of the **Data Explorer**. For details about all of the available visualization options, see [Visualization types in Chronograf](/{{< latest "chronograf" >}}/guides/visualization-types/).
Select the **Visualization** tab at the top of the **Data Explorer**. For details about all of the available visualization options, see [Visualization types in Chronograf](/chronograf/v1.7/guides/visualization-types/).
## Add queries to dashboards

4
content/chronograf/v1.7/guides/using-precreated-dashboards.md
View File

@ -13,7 +13,7 @@ menu:
Pre-created dashboards are delivered with Chronograf depending on which Telegraf input plugins you have enabled and are available from the Host List page. These dashboards, which are built in and not editable, include cells with data visualizations for metrics that are relevant to data sources you are likely to be using.
> Note that these pre-created dashboards cannot be cloned or customized. They appear only as part of the Host List view and are associated with metrics gathered from a single host. Dashboard templates are also available and deliver a solid starting point for customizing your own unique dashboards based on the Telegraf plugins enabled and operate across one or more hosts. For details, see [Dashboard templates](/{{< latest "chronograf" >}}/guides/create-a-dashboard/#dashboard-templates).
> Note that these pre-created dashboards cannot be cloned or customized. They appear only as part of the Host List view and are associated with metrics gathered from a single host. Dashboard templates are also available and deliver a solid starting point for customizing your own unique dashboards based on the Telegraf plugins enabled and operate across one or more hosts. For details, see [Dashboard templates](/chronograf/v1.7/guides/create-a-dashboard/#dashboard-templates).
## Requirements
@ -33,7 +33,7 @@ Pre-created dashboards are delivered in Chronograf installations and are ready t
The pre-created dashboards available for use with Chronograf are listed below as Apps and appear in the Apps listing for hosts in the Host List page. The listings for apps (pre-created dashboards) on this page include information about the required Telegraf input plugins, JSON files included in the apps, and listings of the cell titles that are included in each of the JSON files.
The JSON files for the precreated dashboards are delivered on installation in the `/usr/share/chronograf/canned` directory. Information about the configuration option `--canned-path` can be found in the [Chronograf configuration options](/{{< latest "chronograf" >}}/administration/config-options/#) page.
The JSON files for the precreated dashboards are delivered on installation in the `/usr/share/chronograf/canned` directory. Information about the configuration option `--canned-path` can be found in the [Chronograf configuration options](/chronograf/v1.7/administration/config-options/#) page.
You can enable and disable applications in your [Telegraf configuration file](https://github.com/influxdata/telegraf/blob/master/etc/telegraf.conf).
See [Telegraf configuration](https://github.com/influxdata/telegraf/blob/master/docs/CONFIGURATION.md) for details.

3
content/chronograf/v1.7/guides/visualization-types.md
View File

@ -8,7 +8,7 @@ menu:
parent: Guides
---
Chronograf's dashboard views support the following visualization types, which can be selected in the **Visualization Type** selection view of the [Data Explorer](/{{< latest "chronograf" >}}/querying-data) .
Chronograf's dashboard views support the following visualization types, which can be selected in the **Visualization Type** selection view of the [Data Explorer](/chronograf/v1.7/guides/querying-data).
[Visualization Type selector](/img/chronograf/1-6-viz-types-selector.png)
@ -26,7 +26,6 @@ Each of the available visualization types and available user controls are descri
For information on adding and displaying annotations in graph views, see [Adding annotations to Chronograf views](/chronograf/v1.7/guides/annotations/).
### Line Graph
The **Line Graph** view displays a time series in a line graph.

14
content/chronograf/v1.7/introduction/_index.md
View File

@ -10,16 +10,4 @@ menu:
Follow the links below to get acquainted with Chronograf:
## [Downloading Chronograf](https://portal.influxdata.com/downloads)
Chronograf is supported on several operating systems and hardware architectures.
See the [InfluxData downloads page](https://portal.influxdata.com/downloads) page for to the available binaries.
## [Installing Chronograf](/{{< latest "chronograf" >}}/introduction/installation/)
[Installing Chronograf](/{{< latest "chronograf" >}}/introduction/installation/) lists the requirements for installing, starting, and configuring Chronograf.
## Getting Started
[Getting started with Chronograf](/{{< latest "chronograf" >}}/introduction/getting-started/) gets you up and running with Chronograf with as little configuration and code as possible.
By the end of the guide, you will have downloaded, installed, and configured all four packages of the
TICK stack ([Telegraf](https://github.com/influxdata/telegraf), [InfluxDB](https://github.com/influxdata/influxdb), Chronograf, and [Kapacitor](https://github.com/influxdata/kapacitor)), and you will be all set to monitor your infrastructure.
{{< children hlevel="h2" >}}

21
content/chronograf/v1.7/introduction/getting-started.md
View File

@ -1,8 +1,7 @@
---
title: Getting started with Chronograf
aliases:
- /{{< latest "chronograf" >}}/introduction/getting-started/
- /chronograf/v1.7/introduction/getting_started/
- /chronograf/v1.7/introduction/getting_started/
menu:
chronograf_1_7:
name: Getting started
@ -11,18 +10,18 @@ menu:
---
## Overview
Chronograf allows you to quickly see data you have stored in InfluxDB so you can build robust queries and alerts. After your administrator has set up Chronograf as described in [Installing Chronograf](/{{< latest "chronograf" >}}/introduction/installation), get started with key features using the guides below.
Chronograf allows you to quickly see data you have stored in InfluxDB so you can build robust queries and alerts. After your administrator has set up Chronograf as described in [Installing Chronograf](/chronograf/v1.7/introduction/installation), get started with key features using the guides below.
### Data visualization
* Investigate your data by building queries using the [Data Explorer](/{{< latest "chronograf" >}}/guides/querying-data/).
* Use [pre-created dashboards](/{{< latest "chronograf" >}}/guides/using-precreated-dashboards/) to monitor your application data or [create your own dashboards](/{{< latest "chronograf" >}}/guides/create-a-dashboard/).
* Customize dashboards using [template variables](/{{< latest "chronograf" >}}/guides/dashboard-template-variables/).
* Investigate your data by building queries using the [Data Explorer](/chronograf/v1.7/guides/querying-data/).
* Use [pre-created dashboards](/chronograf/v1.7/guides/using-precreated-dashboards/) to monitor your application data or [create your own dashboards](/chronograf/v1.7/guides/create-a-dashboard/).
* Customize dashboards using [template variables](/chronograf/v1.7/guides/dashboard-template-variables/).
### Alerting
* [Create alert rules](/{{< latest "chronograf" >}}/guides/create-alert-rules/) to generate threshold, relative, and deadman alerts on your data.
* [View all active alerts](/{{< latest "chronograf" >}}/guides/create-alert-rules/#step-2-view-the-alerts) on an alert dashboard.
* Use [alert endpoints](/{{< latest "chronograf" >}}/guides/configuring-alert-endpoints/) in Chronograf to send alert messages to specific URLs and applications.
* [Create alert rules](/chronograf/v1.7/guides/create-alert-rules/) to generate threshold, relative, and deadman alerts on your data.
* [View all active alerts](/chronograf/v1.7/guides/create-alert-rules/#step-2-view-the-alerts) on an alert dashboard.
* Use [alert endpoints](/chronograf/v1.7/guides/configuring-alert-endpoints/) in Chronograf to send alert messages to specific URLs and applications.
### Infrastructure monitoring
* [View all hosts](/{{< latest "chronograf" >}}/guides/monitoring-influxenterprise-clusters/#step-4-explore-the-monitoring-data-in-chronograf) and their statuses in your infrastructure.
* [Use pre-created dashboards](/{{< latest "chronograf" >}}/guides/using-precreated-dashboards/) to monitor your applications.
* [View all hosts](/chronograf/v1.7/guides/monitoring-influxenterprise-clusters/#step-4-explore-the-monitoring-data-in-chronograf) and their statuses in your infrastructure.
* [Use pre-created dashboards](/chronograf/v1.7/guides/using-precreated-dashboards/) to monitor your applications.

2
content/chronograf/v1.7/introduction/installation.md
View File

@ -16,7 +16,6 @@ This page describes how to download and install Chronograf.
* [Connect to your InfluxDB instance or InfluxDB Enterprise cluster](#connect-chronograf-to-your-influxdb-instance-or-influxdb-enterprise-cluster)
* [Connect to Kapacitor](#connect-chronograf-to-kapacitor)
## TICK overview
Chronograf is the user interface for InfluxData's [TICK stack](https://www.influxdata.com/time-series-platform/).
@ -67,7 +66,6 @@ sudo yum localinstall chronograf-<version#>.x86_64.rpm
chronograf
```
## Connect Chronograf to your InfluxDB instance or InfluxDB Enterprise cluster
1. Point your web browser to [localhost:8888](http://localhost:8888).

2
content/chronograf/v1.7/troubleshooting/_index.md
View File

@ -9,4 +9,4 @@ menu:
Follow the link below to access Chronograf's FAQ.
## [Frequently Asked Questions](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/)
{{< children hlevel="h2" >}}

2
content/chronograf/v1.7/troubleshooting/frequently-asked-questions.md
View File

@ -19,4 +19,4 @@ Enter the HTTP bind address of one of your cluster's meta nodes into that input
Note that the example above assumes that you do not have authentication enabled.
If you have authentication enabled, the form requires username and password information.
For more details about monitoring an InfluxEnterprise cluster, see the [Monitor an InfluxEnterprise Cluster](/{{< latest "chronograf" >}}/guides/monitoring-influxenterprise-clusters/) guide.
For more details about monitoring an InfluxEnterprise cluster, see the [Monitor an InfluxEnterprise Cluster](/chronograf/v1.7/guides/monitoring-influxenterprise-clusters/) guide.

6
content/chronograf/v1.8/_index.md
View File

@ -1,8 +1,12 @@
---
title: Chronograf 1.8 documentation
description: >
Chronograf is InfluxData's open source web application.
Use Chronograf with the other components of the TICK stack to visualize your
monitoring data and easily create alerting and automation rules.
menu:
chronograf_1_8:
name: Chronograf v1.8
name: Chronograf v1.8
weight: 1
---

18
content/chronograf/v1.8/about_the_project/_index.md
View File

@ -1,6 +1,6 @@
---
title: About the Chronograf project
description: Chronograf is the UI component of the InfluxData time series platform. This section includes documentation about the Chronograf project, release notes and changelogs, what's new, contributing, and licenses.
description: Learn about Chronograf, the user interface (UI) for InfluxDB.
menu:
chronograf_1_8:
name: About the project
@ -10,21 +10,7 @@ Chronograf is the user interface component of the [InfluxData time series platfo
Follow the links below for more information.
## [Chronograf 1.8 release notes](/chronograf/v1.8/about_the_project/release-notes-changelog/)
The [Chronograf 1.8 release notes](/chronograf/v1.8/about_the_project/release-notes-changelog/) includes details about features, bug fixes, and breaking changes for current and earlier Chronograf OSS releases.
## [Contributing to Chronograf](https://github.com/influxdata/chronograf/blob/master/CONTRIBUTING.md)
See [Contributing to InfluxDB OSS](https://github.com/influxdata/chronograf/blob/master/CONTRIBUTING.md) for information about how you can contribute to the InfluxDB OSS GitHub project.
### [InfluxData Contributor License Agreement (CLA)](https://influxdata.com/community/cla/)
In order to begin contributing to InfluxDB OSS project, you need to complete and sign the [InfluxData Contributor License Agreement (CLA)](https://influxdata.com/community/cla/).
## [Open source license for Chronograf](https://github.com/influxdata/chronograf/blob/master/LICENSE/)
See the [open source license for Chronograf](https://github.com/influxdata/chronograf/blob/master/LICENSE/) for conditions and restrictions for the use of the Chronograf source code.
{{< children >}}
Chronograf is released under the GNU Affero General Public License. This Free Software Foundation license is fairly new,
and differs from the more widely known and understood GPL.

3
content/chronograf/v1.8/about_the_project/cla.md
View File

@ -1,6 +1,7 @@
---
title: InfluxData Contributor License Agreement (CLA)
description: Before contributing to the Chronograf project, you need to submit the InfluxData Contributor License Agreement.
description: >
Before contributing to the Chronograf project, submit the InfluxData Contributor License Agreement.
menu:
chronograf_1_8:
weight: 30

5
content/chronograf/v1.8/about_the_project/contributing.md
View File

@ -1,8 +1,9 @@
---
title: Contributing to Chronograf
title: Contribute to Chronograf
description: Contribute to the Chronograf project.
menu:
chronograf_1_8:
name: Contributing
name: Contribute
weight: 20
parent: About the project
url: https://github.com/influxdata/chronograf/blob/master/CONTRIBUTING.md

1
content/chronograf/v1.8/about_the_project/licenses.md
View File

@ -1,5 +1,6 @@
---
title: Open source license for Chronograf
description: Find the open source license for Chronograf.
menu:
chronograf_1_8:
Name: Open source license

39
content/chronograf/v1.8/about_the_project/release-notes-changelog.md
View File

@ -1,6 +1,6 @@
---
title: Chronograf 1.8 release notes
description: Features, breaking features, user interface improvements, and bug fixes for the latest and earlier Chronograf releases for the InfluxData time series platform.
description: Important changes and what's new in each version of Chronograf.
menu:
chronograf_1_8:
name: Release notes
@ -8,6 +8,21 @@ menu:
parent: About the project
---
## v1.8.6 [2020-08-27]
### Features
- Upgrade Dockerfile to use Alpine 3.12.
### Bug Fixes
- Escape tag values in Query Builder.
- Sort namespaces by database and retention policy.
- Make MySQL protoboard more useful by using derivatives for counter values.
- Add HTTP security headers.
- Resolve an issue that caused existing data to be overwritten when there were multiple results for a specific time. Now, all query results are successfully shown in the Table visualization.
- Resolve an issue that prevented boolean field and tag values from being displayed. Now, field and tag values are printed in TICKscript logs.
## v1.8.5 [2020-07-08]
- Fix public-url generic OAuth configuration issue.
@ -920,9 +935,9 @@ menu:
### UI improvements
* When dashboard time range is changed, reset graphs that are zoomed in
* [Bar graph](/{{< latest "chronograf" >}}/guides/visualization-types/#bar-graph) option added to dashboard
* [Bar graph](/chronograf/v1.8/guides/visualization-types/#bar-graph) option added to dashboard
* Redesign source management table to be more intuitive
* Redesign [Line + Single Stat](/{{< latest "chronograf" >}}/guides/visualization-types/#line-graph-single-stat) cells to appear more like a sparkline, and improve legibility
* Redesign [Line + Single Stat](/chronograf/v1.8/guides/visualization-types/#line-graph-single-stat) cells to appear more like a sparkline, and improve legibility
## v1.3.2.0 [2017-06-05]
@ -938,7 +953,7 @@ menu:
### Features
* Add UI to the Data Explorer for [writing data to InfluxDB](/{{< latest "chronograf" >}}/guides/querying-data/)
* Add UI to the Data Explorer for [writing data to InfluxDB](/chronograf/v1.8/guides/querying-data/)
### UI improvements
@ -958,26 +973,26 @@ In versions 1.3.1+, installing a new version of Chronograf automatically clears
### Bug fixes
* Fix infinite spinner when `/chronograf` is a [basepath](/{{< latest "chronograf" >}}/administration/config-options/#p-basepath)
* Fix infinite spinner when `/chronograf` is a [basepath](/chronograf/v1.8/administration/config-options/#basepath-p)
* Remove the query templates dropdown from dashboard cell editor mode
* Fix the backwards sort arrows in table column headers
* Make the logout button consistent with design
* Fix the loading spinner on graphs
* Filter out any template variable values that are empty, whitespace, or duplicates
* Allow users to click the add query button after selecting singleStat as the [visualization type](/{{< latest "chronograf" >}}/guides/visualization-types)
* Allow users to click the add query button after selecting singleStat as the [visualization type](/chronograf/v1.8/guides/visualization-types)
* Add a query for windows uptime - thank you, @brianbaker!
### Features
* Add log event handler- thank you, @mpchadwick!
* Update Go (golang) vendoring to dep and committed vendor directory
* Add autocomplete functionality to [template variable](/{{< latest "chronograf" >}}/guides/dashboard-template-variables) dropdowns
* Add autocomplete functionality to [template variable](/chronograf/v1.8/guides/dashboard-template-variables) dropdowns
### UI improvements
* Refactor scrollbars to support non-webkit browsers
* Increase the query builder's default height in cell editor mode and in the data explorer
* Make the [template variables](/{{< latest "chronograf" >}}/guides/dashboard-template-variables) manager more space efficient
* Make the [template variables](/chronograf/v1.8/guides/dashboard-template-variables) manager more space efficient
* Add page spinners to pages that did not have them
* Denote which source is connected in the sources table
* Use milliseconds in the InfluxDB dashboard instead of nanoseconds
@ -987,25 +1002,25 @@ In versions 1.3.1+, installing a new version of Chronograf automatically clears
### Bug fixes
* Fix the link to home when using the [`--basepath` option](/{{< latest "chronograf" >}}/administration/config-options/#p-basepath)
* Fix the link to home when using the [`--basepath` option](/chronograf/v1.8/administration/config-options/#basepath-p)
* Remove the notification to login on the login page
* Support queries that perform math on functions
* Prevent the creation of blank template variables
* Ensure thresholds for Kapacitor Rule Alerts appear on page load
* Update the Kapacitor configuration page when the configuration changes
* Fix Authentication when using Chronograf with a set [basepath](/{{< latest "chronograf" >}}/administration/config-options/#p-basepath)
* Fix Authentication when using Chronograf with a set [basepath](/chronograf/v1.8/administration/config-options/#basepath-p)
* Show red indicator on Hosts Page for an offline host
* Support escaping from presentation mode in Safari
* Re-implement level colors on the alerts page
* Fix router bug introduced by upgrading to react-router v3.0
* Show legend on [Line+Stat](/{{< latest "chronograf" >}}/guides/visualization-types/#line-graph-single-stat) visualization type
* Show legend on [Line+Stat](/chronograf/v1.8/guides/visualization-types/#line-graph-single-stat) visualization type
* Prevent queries with `:dashboardTime:` from breaking the query builder
### Features
* Add line-protocol proxy for InfluxDB/InfluxEnterprise Cluster data sources
* Add `:dashboardTime:` to support cell-specific time ranges on dashboards
* Add support for enabling and disabling [TICKscripts that were created outside Chronograf](/{{< latest "chronograf" >}}/guides/advanced-kapacitor/#tickscript-management)
* Add support for enabling and disabling [TICKscripts that were created outside Chronograf](/chronograf/v1.8/guides/advanced-kapacitor/#tickscript-management)
* Allow users to delete Kapacitor configurations
### UI improvements

44
content/chronograf/v1.8/administration/_index.md
View File

@ -1,6 +1,7 @@
---
title: Administering Chronograf
description: This section documents Chronograf administration, including configuration, InfluxDB Enterprise clusters, Kapacitor and InfluxDB connections, user and organization management, security, and upgrading.
description: >
Upgrade and configure Chronograf, plus manage connections, users, security, and organizations.
menu:
chronograf_1_8:
name: Administration
@ -10,43 +11,4 @@ menu:
Follow the links below for more information.
## [Upgrading to Chronograf 1.8](/chronograf/v1.8/administration/upgrading/)
See [Upgrading to Chronograf 1.8](/chronograf/v1.8/administration/upgrading/) for details on upgrading to the latest Chronograf release.
## [Configuring Chronograf 1.8](/chronograf/v1.8/administration/configuration/)
See [Configuring Chronograf 1.8](/chronograf/v1.8/administration/configuration/) to information on starting Chronograf, configuring Chronograf, setting custom default Chronograf configuration options, and enabling security, multi-organization, and multi-user support.
## [Configuration options](/chronograf/v1.8/administration/config-options/)
[Configuration options](/chronograf/v1.8/administration/config-options/) includes details on Chronograf configuration options, including command line settings and environment variables, for the Chronograf service, connections for Kapacitor and InfluxDB, and OAuth 2.0 authentication options.
## [Connecting Chronograf to InfluxDB Enterprise clusters](/chronograf/v1.8/administration/chrono-on-clusters/)
[Connecting Chronograf to InfluxDB Enterprise clusters](/chronograf/v1.8/administration/chrono-on-clusters/) covers details on configuring and using Chronograf to monitor and manage your InfluxDB Enterprise clusters.
## [Creating InfluxDB and Kapacitor connections](/chronograf/v1.8/administration/creating-connections/)
[Creating InfluxDB and Kapacitor connections](/chronograf/v1.8/administration/creating-connections/) includes steps for creating InfluxDB and Kapacitor connections for use with Chronograf.
## [Managing InfluxDB users in Chronograf](/chronograf/v1.8/administration/managing-influxdb-users/)
[Managing InfluxDB users in Chronograf](/chronograf/v1.8/administration/managing-influxdb-users/) covers how to use Chronograf to create and manage InfluxDB users, roles, and permissions.
## [Managing Chronograf security](/chronograf/v1.8/administration/managing-security/)
See [Managing Chronograf security](/chronograf/v1.8/administration/managing-security/) for details on configuring OAuth 2.0 authentication providers, authentication duration, and configuring TLS and HTTPS support.
## [Managing Chronograf organizations](/chronograf/v1.8/administration/managing-organizations/)
[Managing Chronograf organizations](/chronograf/v1.8/administration/managing-organizations/) covers use of the Default organization and creating, managing, and removing Chronograf organizations.
## [Managing Chronograf users](/chronograf/v1.8/administration/managing-chronograf-users/)
See [Managing Chronograf users](/chronograf/v1.8/administration/managing-chronograf-users/) for details on managing Chronograf users and roles, organization-bound users, cross-organization SuperAdmin status, and navigating organizations in the Chronograf user interface.
## [Transitioning from InfluxDB's Web Admin Interface](/chronograf/v1.8/guides/transition-web-admin-interface/)
Versions 1.3+ of InfluxDB OSS and InfluxDB Enterprise no longer support the web admin interface, the built-in user interface for writing and querying data in InfluxDB.
Learn how to use Chronograf as a replacement for the web admin interface.
{{< children >}}

4
content/chronograf/v1.8/administration/chrono-on-clusters.md
View File

@ -1,6 +1,6 @@
---
title: Connecting Chronograf to InfluxDB Enterprise clusters
description: Configuration steps for connecting Chronograf to InfluxDB Enterprise clusters and the InfluxData time series platform.
description: Work with InfluxDB Enterprise clusters through the Chronograf UI.
menu:
chronograf_1_8:
name: Connecting Chronograf to InfluxDB Enterprise
@ -19,4 +19,4 @@ Enter the HTTP bind address of one of your cluster's meta nodes into that input
Note that the example above assumes that you do not have authentication enabled.
If you have authentication enabled, the form requires username and password information.
For details about monitoring InfluxEnterprise clusters, see [Monitoring InfluxDB Enterprise clusters](/{{< latest "chronograf" >}}/guides/monitoring-influxenterprise-clusters).
For details about monitoring InfluxEnterprise clusters, see [Monitoring InfluxDB Enterprise clusters](/{{chronograf/v1.8/guides/monitoring-influxenterprise-clusters).

12
content/chronograf/v1.8/administration/config-options.md
View File

@ -1,6 +1,7 @@
---
title: Chronograf configuration options
description: Details on configuration settings (command line options and environment variables) for Chronograf services, Kapacitor and InfluxDB connections, and OAuth 2.0 authentication providers.
description: >
Options available in the Chronograf configuration file and environment variables.
menu:
chronograf_1_8:
name: Configuration options
@ -94,7 +95,7 @@ Environment variable: `$BOLT_PATH`
#### `--canned-path=` | `-c`
The path to the directory of [canned dashboards](/{{< latest "chronograf" >}}/guides/using-precreated-dashboards) files.
The path to the directory of [canned dashboards](/chronograf/v1.8/guides/using-precreated-dashboards) files.
Default value: `/usr/share/chronograf/canned`
@ -135,7 +136,7 @@ $ chronograf -v
## InfluxDB connection options
> InfluxDB connection details specified via command line when starting Chronograf do not persist when Chronograf is shut down.
> To persist connection details, [include them in a `.src` file](/chronograf/v1.8/administration/creating-connections/#managing-influxdb-connections-using-src-files) located in your [`--resources-path`](#resources-path).
> To persist connection details, [include them in a `.src` file](/chronograf/v1.8/administration/creating-connections/#manage-influxdb-connections-using-src-files) located in your [`--resources-path`](#resources-path).
### `--influxdb-url=`
@ -160,7 +161,7 @@ Environment variable: `$INFLUXDB_PASSWORD`
## Kapacitor connection options
> Kapacitor connection details specified via command line when starting Chronograf do not persist when Chronograf is shut down.
> To persist connection details, [include them in a `.kap` file](/chronograf/v1.8/administration/creating-connections/#managing-kapacitor-connections-using-kap-files) located in your [`--resources-path`](#resources-path).
> To persist connection details, [include them in a `.kap` file](/chronograf/v1.8/administration/creating-connections/#manage-kapacitor-connections-using-kap-files) located in your [`--resources-path`](#resources-path).
### `--kapacitor-url=`
@ -399,10 +400,9 @@ Lists are comma-separated.
**Environment variable:** `$HEROKU_ORGS`
### Generic OAuth 2.0 authentication options
See [Configuring Generic authentication](/chronograf/v1.8/administration/managing-security/#configure-generic-authentication) for more information.
See [Configure OAuth 2.0](/chronograf/v1.8/administration/managing-security/#configure-oauth-2-0) for more information.
#### `--generic-name=`

9
content/chronograf/v1.8/administration/configuration.md
View File

@ -1,9 +1,10 @@
---
title: Configuring Chronograf
description: Configuration of Chronograf, including custom default settings, security, multiple users, and multiple organizations.
title: Configure Chronograf
description: >
Configure Chronograf, including security, multiple users, and multiple organizations.
menu:
chronograf_1_8:
name: Configuring
name: Configure
weight: 20
parent: Administration
---
@ -20,7 +21,7 @@ Use one of the following commands to start Chronograf:
- **If you installed Chronograf using an official Debian or RPM package and are running a distro with `systemd`. For example, Ubuntu 15 or later.**
```sh
```sh
systemctl start chronograf
```

2
content/chronograf/v1.8/administration/create-high-availability.md
View File

@ -22,7 +22,7 @@ Have an existing Chronograf configuration store that you want to use with a Chro
## Install and start etcd
1. Download the latest etcd release [from GitHub](https://github.com/etcd-io/etcd/releases/).
(For detailed installation instructions specific to your operating system, see [Install and deploy etcd](http://play.etcd.io/install).)
(For detailed installation instructions specific to your operating system, see [Install and deploy etcd](http://play.etc.io/install).)
2. Extract the `etcd` binary and place it in your system PATH.
3. Start etcd.

12
content/chronograf/v1.8/administration/creating-connections.md
View File

@ -1,9 +1,9 @@
---
title: Creating InfluxDB and Kapacitor connections
description: Creating and managing InfluxDB and Kapacitor connections for use with Chronograf.
title: Create InfluxDB and Kapacitor connections
description: Create and manage InfluxDB and Kapacitor connections in the UI.
menu:
chronograf_1_8:
name: Creating InfluxDB and Kapacitor connections
name: Create InfluxDB and Kapacitor connections
weight: 50
parent: Administration
---
@ -15,7 +15,7 @@ Connections to InfluxDB and Kapacitor can be configured through the Chronograf u
- [Manage Kapacitor connections using the Chronograf UI](#manage-kapacitor-connections-using-the-chronograf-ui)
- [Manage Kapacitor connections using .kap files](#manage-kapacitor-connections-using-kap-files)
> **Note:** Connection details are stored in Chronograf’s internal database `chronograf-v1.db`. You may administer the internal database when [restoring a Chronograf database](/chronograf/v1.8/administration/restoring-chronograf-db/) or when [migrating a Chronograf configuration from BoltDB to etcd](/chronograf/v1.8/administration/migrate-to-high-availability-etcd/).
> **Note:** Connection details are stored in Chronograf’s internal database `chronograf-v1.db`. You may administer the internal database when [restoring a Chronograf database](/chronograf/v1.8/administration/restoring-chronograf-db/) or when [migrating a Chronograf configuration from BoltDB to etcd](/chronograf/v1.8/administration/migrate-to-high-availability/).
## Manage InfluxDB connections using the Chronograf UI
@ -39,7 +39,7 @@ To create an InfluxDB connection in the Chronograf UI:
* **Make this the default connection**: When this option is selected, this InfluxDB connection will be used when Chronograf is launched.
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](/{{< latest "chronograf" >}}/guides/create-a-dashboard).
* 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).
* If the connection cannot be created, the following error message appears:
"Unable to create source: Error contacting source."
If this occurs, ensure all connection credentials are correct and that the InfluxDB instance is running and accessible.
@ -166,7 +166,7 @@ To use Kapacitor in Chronograf, create Kapacitor connections and configure alert
To create a Kapacitor connection using the Chronograf UI:
1. Open Chronograf and click **Configuration** (wrench icon) in the navigation menu.
2. Next to an existing [InfluxDB connection](#managing-influxdb-connections-using-the-chronograf-ui), click **Add Kapacitor Connection** if there are no existing Kapacitor connections or select **Add Kapacitor Connection** in the **Kapacitor Connection** dropdown list.
2. Next to an existing [InfluxDB connection](#manage-influxdb-connections-using-the-chronograf-ui), click **Add Kapacitor Connection** if there are no existing Kapacitor connections or select **Add Kapacitor Connection** in the **Kapacitor Connection** dropdown list.
![Add a new Kapacitor connection in Chronograf](/img/chronograf/1-6-connection-kapacitor.png)
3. In the **Connection Details** section, enter values for the following fields:

14
content/chronograf/v1.8/administration/import-export-dashboards.md
View File

@ -1,6 +1,6 @@
---
title: Importing and exporting Chronograf dashboards
description: A step-by-step guide that walks through both exporting and importing Chrongraf dashboards.
title: Import and export Chronograf dashboards
description: Share dashboard JSON files between Chronograf instances.
menu:
chronograf_1_8:
weight: 120
@ -11,11 +11,11 @@ Chronograf makes it easy to both export and import dashboards.
Dashboard exports are simple JSON files that can be shared and imported into other Chronograf instances.
This allows you to recreate robust dashboards without having to manually configure them from the ground up.
[Exporting a dashboard](#exporting-a-dashboard)
[Importing a dashboard](#importing-a-dashboard)
[Export a dashboard](#export-a-dashboard)
[Import a dashboard](#import-a-dashboard)
[Required user roles](#required-user-roles)
## Exporting a dashboard
## Export a dashboard
1. Go to your "Dashboards" landing page.
2. Hover over the dashboard you would like to export and click the "Export"
button that appears to the right.
@ -28,7 +28,7 @@ cells and cell information such as the query, cell-sizing, color scheme, visuali
> No time series data is exported with a dashboard.
> Exports include only dashboard-related information as mentioned above.
## Importing a dashboard
## Import a dashboard
1. On your "Dashboards" landing page, click the "Import Dashboard" button.
2. Either drag and drop or select the JSON export file to import.
3. Click the "Upload Dashboard" button.
@ -37,7 +37,7 @@ The newly imported dashboard will be included in your list of dashboards.
![Importing a Chronograf dashboard](/img/chronograf/1-6-dashboard-import.gif)
### Reconciling unmatched sources
### Reconcile unmatched sources
If the data sources defined in the imported dashboard JSON file do not match any of your local sources,
you will have to reconcile each of the unmatched sources during the import process.

47
content/chronograf/v1.8/administration/managing-chronograf-users.md
View File

@ -1,16 +1,17 @@
---
title: Managing Chronograf users
description: Managing Chronograf users and roles, SuperAdmin status, and InfluxDB and Kapacitor users.
title: Manage Chronograf users
description: >
Manage users and roles, including SuperAdmin status and organization-bound users.
menu:
chronograf_1_8:
name: Managing Chronograf users
name: Manage Chronograf users
weight: 90
parent: Administration
---
**On this page**
* [Managing Chronograf users and roles](#managing-chronograf-users-and-roles)
* [Manage Chronograf users and roles](#manage-chronograf-users-and-roles)
* [Organization-bound users](#organization-bound-users)
* [InfluxDB and Kapacitor users within Chronograf](#influxdb-and-kapacitor-users-within-chronograf)
* [Chronograf-owned resources](#chronograf-owned-resources)
@ -21,15 +22,15 @@ menu:
* [Admins](#admins-role-admin)
* [Cross-organization SuperAdmin status](#cross-organization-superadmin-status)
* [All New Users are SuperAdmins configuration option](#all-new-users-are-superadmins-configuration-option)
* [Creating users](#creating-users)
* [Updating users](#updating-users)
* [Removing users](#removing-users)
* [Navigating organizations](#navigating-organizations)
* [Logging in and logging out](#logging-in-and-logging-out)
* [Switching the current organization](#switching-the-current-organization)
* [Create users](#create-users)
* [Update users](#update-users)
* [Remove users](#remove-users)
* [Navigate organizations](#navigate-organizations)
* [Log in and log out](#log-in-and-log-out)
* [Switch the current organization](#switch-the-current-organization)
* [Purgatory](#purgatory)
## Managing Chronograf users and roles
## Manage Chronograf users and roles
> ***Note:*** Support for organizations and user roles is available in Chronograf 1.4 or later. First, OAuth 2.0 authentication must be configured (if it is, you'll see the Chronograf Admin tab on the Admin menu). For more information, see [Managing security] (/chronograf/v1.8/administration/managing-security/).
@ -75,14 +76,12 @@ Chronograf-accessed resources include external resources that can be accessed us
- InfluxDB databases, users, queries, and time series data (if using InfluxDB Enterprise, InfluxDB roles can be accessed too)
- Kapacitor alerts and alert rules (called tasks in Kapacitor)
#### Members (role:`member`)
Members are Chronograf users who have been added to organizations but do not have any functional capabilities. Members cannot access any resources within an organization and thus effectively cannot use Chronograf. Instead, a member can only access Purgatory, where the user can [switch into organizations](#navigating-organizations) based on assigned roles.
Members are Chronograf users who have been added to organizations but do not have any functional capabilities. Members cannot access any resources within an organization and thus effectively cannot use Chronograf. Instead, a member can only access Purgatory, where the user can [switch into organizations](#navigate-organizations) based on assigned roles.
By default, new organizations have a default role of `member`. If the Default organization is Public, then anyone who can authenticate, would become a member, but not be able to use Chronograf until an administrator assigns a different role.
#### Viewers (role:`viewer`)
Viewers are Chronograf users with effectively read-only capabilities for Chronograf-owned resources within their current organization:
@ -94,7 +93,7 @@ Viewers are Chronograf users with effectively read-only capabilities for Chronog
- Access InfluxDB resources through the current connection
- View the name of the current Kapacitor connection associated with each InfluxDB connection
- Access Kapacitor resources through the current connection
- [Switch into organizations](#navigating-organizations) where the user has a role
- [Switch into organizations](#navigate-organizations) where the user has a role
For Chronograf-accessed resources, viewers can:
@ -120,7 +119,7 @@ Editors are Chronograf users with limited capabilities for Chronograf-owned reso
- Create, view, edit, and delete Kapacitor connections associated with InfluxDB connections
- Switch current Kapacitor connection to other available connections
- Access Kapacitor resources through the current connection
- [Switch into organizations](#navigating-organizations) where the user has a role
- [Switch into organizations](#navigate-organizations) where the user has a role
For Chronograf-accessed resources, editors can:
@ -147,7 +146,7 @@ Admins are Chronograf users with all capabilities for the following Chronograf-o
- Create, view, edit, and delete Kapacitor connections associated with InfluxDB connections
- Switch current Kapacitor connection to other available connections
- Access Kapacitor resources through the current connection
- [Switch into organizations](#navigating-organizations) where the user has a role
- [Switch into organizations](#navigate-organizations) where the user has a role
For Chronograf-accessed resources, admins can:
@ -168,7 +167,7 @@ SuperAdmin status is a Chronograf status that allows any user, regardless of rol
* Create, view, update, and remove organizations
* Create, view, update, and remove users within an organization
* Grant or revoke the SuperAdmin status of another user
* [Switch into any organization](#navigating-organizations)
* [Switch into any organization](#navigate-organizations)
* Toggle the Public setting of the Default organization
* Toggle the global config setting for [All new users are SuperAdmin](#all-new-users-are-superadmins-configuration-option)
@ -184,7 +183,7 @@ Important SuperAdmin behaviors:
By default, the **Config** setting for "**All new users are SuperAdmins"** is **On**. Any user with SuperAdmin status can toggle this under the **Admin > Chronograf > Organizations** tab. If this setting is **On**, any new user (who is created or who authenticates) will_ automatically have SuperAdmin status. If this setting is **Off**, any new user (who is created or who authenticates) will _not_ have SuperAdmin status unless they are explicitly granted it later by another user with SuperAdmin status.
### Creating users
### Create users
Role required: `admin`
@ -199,7 +198,7 @@ Role required: `admin`
* **Scheme**: Displays `oauth2`, which is the only supported authentication scheme in this release.
4. Click **Save** to finish creating the user.
### Updating users
### Update users
Role required: `admin`
@ -211,7 +210,7 @@ Only a user's role can be updated. A user's username, provider, and scheme canno
2. Click the **Users** tab to display the list of users within the current organization.
3. Select a new role for the user. The update is automatically persisted.
### Removing users
### Remove users
Role required: `admin`
@ -221,17 +220,17 @@ Role required: `admin`
2. Click the **Users** tab to display the list of users.
3. Hover your cursor over the user you want to remove and then click **Remove** and **Confirm**.
### Navigating organizations
### Navigate organizations
Chronograf is always used in the context of an organization. When a user logs in to Chronograf, that user will access only the resources owned by their current organization. The only exception to this is that users with SuperAdmin status will also be able to [manage organizations](/chronograf/v1.8/administration/managing-organizations/) in the Chronograf Admin page.
#### Logging in and logging out
#### Log in and log out
A user can log in from the Chronograf homepage using any configured OAuth 2.0 provider.
A user can log out by hovering over the **User (person icon)** in the left navigation bar and clicking **Log out**.
#### Switching the current organization
#### Switch the current organization
A user's current organization and role is highlighted in the **Switch Organizations** list, which can be found by hovering over the **User (person icon)** in the left navigation bar.

15
content/chronograf/v1.8/administration/managing-influxdb-users.md
View File

@ -1,11 +1,12 @@
---
title: Managing InfluxDB users in Chronograf
description: Using Chronograf to enable authentication and manage InfluxDB OSS and InfluxDB Enterprise users.
title: Manage InfluxDB users in Chronograf
description: >
Enable authentication and manage InfluxDB OSS and InfluxDB Enterprise users in Chronograf.
aliases:
- /chronograf/v1.8/administration/user-management/
menu:
chronograf_1_8:
name: Managing InfluxDB users
name: Manage InfluxDB users
weight: 60
parent: Administration
---
@ -13,15 +14,15 @@ menu:
The **Chronograf Admin** provides InfluxDB user management for InfluxDB OSS and InfluxDB Enterprise users.
> ***Note:*** For details on Chronograf user authentication and management, see [Managing security](/{{< latest "chronograf" >}}/administration/managing-security/).
> ***Note:*** For details on Chronograf user authentication and management, see [Managing security](/chronograf/v1.8/administration/managing-security/).
**On this page:**
* [Enabling authentication](#enabling-authentication)
* [Enable authentication](#enable-authentication)
* [InfluxDB OSS user management](#influxdb-oss-user-management)
* [InfluxDB Enterprise user management](#influxdb-enterprise-user-management)
## Enabling authentication
## Enable authentication
Follow the steps below to enable authentication.
The steps are the same for InfluxDB OSS instances and InfluxEnterprise clusters.
@ -77,7 +78,7 @@ A successful `CREATE USER` query returns a blank result:
### Step 4: Edit the InfluxDB source in Chronograf.
If you've already [connected your database to Chronograf](chronograf/latest/introduction/installation#connect-chronograf-to-your-influxdb-instance-or-influxdb-enterprise-cluster), update the connection configuration in Chronograf with your new username and password.
If you've already [connected your database to Chronograf](/chronograf/v1.8/introduction/installation/#connect-chronograf-to-your-influxdb-instance-or-influxdb-enterprise-cluster), update the connection configuration in Chronograf with your new username and password.
Edit existing InfluxDB database sources by navigating to the Chronograf configuration page and clicking on the name of the source.
## InfluxDB OSS User Management

34
content/chronograf/v1.8/administration/managing-organizations.md
View File

@ -1,9 +1,9 @@
---
title: Managing Chronograf organizations
description: "Managing multiple organizations or groups: creating, configuring, mapping, and removing organizations."
title: Manage Chronograf organizations
description: Create, configure, map, and remove organizations in Chronograf.
menu:
chronograf_1_8:
name: Managing Chronograf organizations
name: Manage Chronograf organizations
weight: 80
parent: Administration
---
@ -11,16 +11,16 @@ menu:
**On this page:**
* [About Chronograf organizations](#about-chronograf-organizations)
* [Using the Default organization](#using-the-default-organization)
* [Creating organizations](#creating-organizations)
* [Configuring organizations](#configuring-organizations)
* [Mapping organizations](#mapping-organizations)
* [Removing organizations](#removing-organizations)
* [Use the default organization](#use-the-default-organization)
* [Create organizations](#create-organizations)
* [Configure organizations](#configure-organizations)
* [Map organizations](#map-organizations)
* [Remove organizations](#remove-organizations)
## About Chronograf organizations
> ***Note:*** Support for organizations and user roles is available in Chronograf 1.4 or later.
> ***Note:*** Support for organizations and user roles is available in Chronograf 1.4 or later.
First, OAuth 2.0 authentication must be configured (if it is, you'll see the Chronograf Admin tab on the Admin menu).
For more information, see [managing security](/chronograf/v1.8/administration/managing-security/).
@ -30,12 +30,12 @@ A Chronograf organization is a collection of Chronograf users who share common C
> ***Note:*** Only users with SuperAdmin status can manage organizations. Admins, editors, viewers, and members cannot manage organizations unless they have SuperAdmin status.
## Using the Default organization
## Use the default organization
>***Note:*** The Default organization can be used to support Chronograf as configured in versions earlier than 1.4.
>***Note:*** The default organization can be used to support Chronograf as configured in versions earlier than 1.4.
> Upon upgrading, any Chronograf resources that existed prior to 1.4 automatically become owned by the Default organization.
Upon installation, the Default organization is ready for use and allows Chronograf to be used as-is.
Upon installation, the default organization is ready for use and allows Chronograf to be used as-is.
## Creating organizations
@ -51,7 +51,7 @@ Your company, organizational units, teams, and projects may require the creation
4) Under **Default Role**, select the default role for new users within that organization. Valid options include `member` (default), `viewer`, `editor`, and `admin`.
5) Click **Save**.
## Configuring organizations
## Configure organizations
**Required status:** SuperAdmin
@ -69,10 +69,10 @@ You can configure existing and new organizations in the **Organizations** tab of
See the following pages for more information about managing Chronograf users and security:
* [Managing Chronograf users](/chronograf/v1.8/administration/managing-chronograf-users/)
* [Managing security](/chronograf/v1.8/administration/managing-security/)
* [Manage Chronograf users](/chronograf/v1.8/administration/managing-chronograf-users/)
* [Manage security](/chronograf/v1.8/administration/managing-security/)
## Mapping organizations
## Map organizations
**To create an organization mapping:**
@ -96,7 +96,7 @@ See the following pages for more information about managing Chronograf users and
2) Click the **Org Mappings** tab to view a list of organization mappings.
3) To remove an organization mapping, click the **Delete** button at the end of the mapping row you want to remove, and then confirm the action.
## Removing organizations
## Remove organizations
When an organization is removed:

10
content/chronograf/v1.8/administration/managing-security.md
View File

@ -1,10 +1,10 @@
---
title: Managing Chronograf security
description: Managing Chronograf security using authentication and authorization with OAuth 2.0 providers (GitHub, Google, Heroku, Okta, and generic). Also covers TLS and HTTPS setup.
title: Manage Chronograf security
description: Manage Chronograf security with OAuth 2.0 providers.
aliases: /chronograf/v1.8/administration/security-best-practices/
menu:
chronograf_1_8:
name: Managing Chronograf security
name: Manage Chronograf security
weight: 70
parent: Administration
---
@ -20,8 +20,8 @@ To enhance security, configure Chronograf to authenticate and authorize with [OA
## Configure OAuth 2.0
> After configuring OAuth 2.0, the Chronograf Admin tab becomes visible.
> You can then set up [multiple organizations](/{{< latest "chronograf" >}}/administration/managing-organizations/)
> and [users](/{{< latest "chronograf" >}}/administration/managing-influxdb-users/).
> You can then set up [multiple organizations](/chronograf/v1.8/administration/managing-organizations/)
> and [users](/chronograf/v1.8/administration/managing-influxdb-users/).
Configure Chronograf to use an OAuth 2.0 provider and JWT (JSON Web Token) to authenticate users and enable role-based access controls.

5
content/chronograf/v1.8/administration/migrate-to-high-availability.md
View File

@ -1,6 +1,7 @@
---
title: Migrate to a Chronograf HA configuration
description: Migrate a Chronograf single instance configuration using BoltDB to a Chronograf high-availability (HA) cluster configuration using etcd.
description: >
Migrate a Chronograf single instance configuration using BoltDB to a Chronograf high-availability (HA) cluster configuration using etcd.
menu:
chronograf_1_8:
weight: 10
@ -20,7 +21,7 @@ Use [`chronoctl`](/chronograf/v1.8/tools/chronoctl/) to migrate your Chronograf
$ chronoctl migrate -f bolt:///path/to/chronograf-v1.db -t etcd://localhost:2379
```
> **Note:**
> **Note:**
If you have authentication on `etcd`, use the standard URI format to define a username and password. For example, `etcd://user:pass@localhost:2379`
5. Update links to Chronograf (for example, from external sources) to reflect your new URLs:

4
content/chronograf/v1.8/administration/prebuilt-dashboards.md
View File

@ -1,6 +1,6 @@
---
title: Prebuilt dashboards in Chronograf
description: Prebuilt dashboards available to import based on Telegraf input plugins.
description: Import prebuilt dashboards into Chronograf based on Telegraf plugins.
menu:
chronograf_1_8:
name: Prebuilt dashboards in Chronograf
@ -9,7 +9,7 @@ menu:
---
Chronograf lets you import a variety of prebuilt dashboards that visualize metrics collect by specific [Telegraf input plugins](/{{< latest "telegraf" >}}/plugins/plugin-list). The following Telegraf-related dashboards templates are available.
For details on how to import dashboards while adding a connection in Chronograf, see [Creating connections](/chronograf/v1.8/administration/creating-connections/#managing-influxdb-connections-using-the-chronograf-ui).
For details on how to import dashboards while adding a connection in Chronograf, see [Creating connections](/chronograf/v1.8/administration/creating-connections/#manage-influxdb-connections-using-the-chronograf-ui).
## Docker

9
content/chronograf/v1.8/administration/restoring-chronograf-db.md
View File

@ -1,6 +1,7 @@
---
title: Restoring a Chronograf database
description: 'An outline of the process required to roll the Chronoraf internal database back to a previous version and/or rerun update migrations.'
title: Restore a Chronograf database
description: >
If you're rolling back to a previous version of Chronograf, restore your internal database.
menu:
chronograf_1_8:
weight: 110
@ -36,7 +37,7 @@ chronograf-working-dir/
└── ...
```
## Rolling back to a previous version
## Roll back to a previous version
If there is an issue during the upgrade process or you simply want/need to roll
back to an earlier version of Chronograf, you must restore the data file
associated with that specific version, then downgrade and restart Chronograf.
@ -73,7 +74,7 @@ page on Github.
Restart the Chronograf server.
Chronograf will use the `chronograf-v1.db` in the current working directory.
## Rerunning update migrations
## Rerun update migrations
This process can also be used to rerun Chronograf update migrations.
Go through steps 1-5, but on [step 3](#3-replace-your-current-database-with-the-backup)
select the backup you want to use as a base for the migrations.

10
content/chronograf/v1.8/administration/upgrading.md
View File

@ -1,19 +1,17 @@
---
title: Upgrading Chronograf
description: Covers upgrading Chronograf to the latest version.
title: Upgrade Chronograf
description: Upgrade to the latest version of Chronograf.
menu:
chronograf_1_8:
name: Upgrading
name: Upgrade
weight: 10
parent: Administration
---
## Upgrading to Chronograf 1.8
If you're upgrading from Chronograf 1.3.x, first install 1.7.x, and then install 1.8.
If you're upgrading from Chronograf 1.4 or later, [download and install](https://portal.influxdata.com/downloads) the most recent version of Chronograf, and then restart Chronograf.
> ***Note:*** Installing a new version of Chronograf automatically clears the localStorage settings.
After upgrading, see [Getting Started](/{{< latest "chronograf" >}}/introduction/getting-started/) to get up and running.
After upgrading, see [Getting Started](/chronograf/v1.8/introduction/getting-started/) to get up and running.

56
content/chronograf/v1.8/guides/_index.md
View File

@ -1,6 +1,6 @@
---
title: Guides for Chronograf
description: The Chronograf guides discuss dashboards, monitoring InfluxDB Enterprise clusters, Kapacitor alerts and event handlers, template variables, visualization types, and TICKscript editing/logging.
description: Step-by-step instructions for using Chronograf's features.
menu:
chronograf_1_8:
name: Guides
@ -9,56 +9,4 @@ menu:
Follow the links below to explore Chronograf's features.
## [Exploring data in Chronograf](/chronograf/v1.8/guides/querying-data)
Use Chronograf's Data Explorer to query and visualize your time series data.
## [Using pre-created dashboards](/chronograf/v1.8/guides/using-precreated-dashboards/)
Pre-created dashboards are available when the required Telegraf input plugins are enabled. These dashboards include cells with data visualizations for metrics that are relevant to data sources you are likely to be using.
## [Using the TICKscript editor](/chronograf/v1.8/guides/tickscript-logging/)
Using the TICKscript editor in Chronograf to create, test, and debug Kapacitor TICKscripts.
## [Creating dashboards](/{{< latest "chronograf" >}}/guides/create-a-dashboard/)
Chronograf offers a complete dashboard solution for visualizing your data and monitoring your infrastructure.
Learn how to create customized dashboards in Chronograf.
## [Cloning dashboards and cells](/chronograf/v1.8/guides/cloning-in-ui/)
Use Chronograf's cloning functionality to make copies of dashboards and cells.
## [Visualization types in Chronograf](/chronograf/v1.8/guides/visualization-types/)
Describes the visualization types available to display in Chronograf views in dashboards.
## [Adding annotations in Chronograf views](/chronograf/v1.8/guides/annotations/)
Describes how to add annotations to Chronograf views with the user interface or using the command line interface.
## [Creating Chronograf alert rules](/chronograf/v1.8/guides/create-alert-rules/)
Learn how to create alert rules in Chronograf.
## [Configuring Chronograf alert endpoints](/chronograf/v1.8/guides/configuring-alert-endpoints/)
Chronograf works with Kapacitor to send alert messages to supported event handlers.
Use Chronograf to send alert messages to specific URLs as well as to applications like Slack and HipChat.
Learn how to set up event handlers in Chronograf.
## [Monitoring InfluxDB Enterprise clusters](/chronograf/v1.8/guides/monitoring-influxenterprise-clusters/)
InfluxDB Enterprise offers high availability and a highly-scalable clustering solution for your time series data needs.
Learn how to use Chronograf to assess your cluster’s health and monitor the infrastructure behind your project.
## [Using dashboard template variables](/chronograf/v1.8/guides/dashboard-template-variables/)
Learn how to use Chronograf's dashboard template variables to interact with your dashboards and gain insights into your data.
## [Advanced Kapacitor usage](/chronograf/v1.8/guides/advanced-kapacitor/)
Chronograf provides a user interface for Kapacitor, InfluxData’s processing framework for creating alerts, running ETL jobs, and detecting anomalies in your data.
Learn how Kapacitor interacts with Chronograf at a lower level and learn about advanced Kapacitor usage within Chronograf.
{{< children >}}

3
content/chronograf/v1.8/guides/advanced-kapacitor.md
View File

@ -1,6 +1,7 @@
---
title: Advanced Kapacitor usage
description: Learn how Kapacitor can be used with Chronograf for alert history and TICKscript management.
description: >
Use Kapacitor with Chronograf to manage alert history and TICKscripts.
menu:
chronograf_1_8:
weight: 100

12
content/chronograf/v1.8/guides/analyzing-logs.md
View File

@ -1,6 +1,6 @@
---
title: Analyzing logs with Chronograf
description: View, search, filter, visualize, and analyze log information using Chronograf and InfluxDB.
title: Analyze logs with Chronograf
description: Analyze log information using Chronograf.
menu:
chronograf_1_8:
weight: 120
@ -15,7 +15,7 @@ Logs data is a first class citizen in InfluxDB and is populated using available
[syslog](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/syslog)
## Viewing logs in Chronograf
## View logs in Chronograf
Chronograf has a dedicated log viewer accessed by clicking the **Log Viewer** button in the left navigation.
<img src="/img/chronograf/1-6-logs-nav-log-viewer.png" alt="Log viewer in the left nav" style="width:100%;max-width:209px;"/>
@ -27,7 +27,7 @@ _Other log inputs and alternate log measurement options will be available in fut
<img src="/img/chronograf/1-7-log-viewer-overview.png" alt="Chronograf log viewer" style="width:100%;max-width:1016px;"/>
### Searching and filtering logs
### Search and filter logs
Search for logs using keywords or regular expressions.
They can also be filtered by clicking values in the log table such as `severity` or `facility`.
Any tag values included with the log entry can be used as a filter.
@ -40,14 +40,14 @@ You can also use search operators to filter your results. For example, if you wa
To remove filters, click the `×` next to the tag key by which you no longer want to filter.
### Selecting specific times
### Select specific times
In the log viewer, you can select time ranges from which to view logs.
By default, logs are streamed and displayed relative to "now," but it is possible to view logs from a past window of time.
timeframe selection allows you to go to to a specific event and see logs for a time window both preceding and following that event. The default window is one minute, meaning the graph shows logs from thirty seconds before and the target time. Click the dropdown menu change the window.
![Selecting time ranges](/img/chronograf/1-7-log-viewer-specific-time.gif)
## Configuring the log viewer
## Configure the log viewer
The log viewer can be customized to fit your specific needs.
Open the log viewer configuration options by clicking the gear button in the top right corner of the log viewer. Once done, click **Save** to apply the changes.

9
content/chronograf/v1.8/guides/annotations.md
View File

@ -1,14 +1,15 @@
---
title: Using annotations in Chronograf views
description: Annotations provide contextual information by adding explanatory notes or comments to Chronograf graph views and charts in the user interface and dashboards.
title: Use annotations in Chronograf views
description: >
Add contextual information to Chronograf dashboards with annotations.
menu:
chronograf_1_8:
name: Using annotations
name: Use annotations
weight: 50
parent: Guides
---
## Using annotations in the Chronograf interface
## Use annotations in the Chronograf interface
Annotations in Chronograf are notes of explanation or comments added to graph views by editors or administrators. Annotations can provide Chronograf users with useful contextual information about single points in time or time intervals. Users can use annotations to correlate the effects of important events, such as system changes or outages across multiple metrics, with Chronograf data.

9
content/chronograf/v1.8/guides/cloning-in-ui.md
View File

@ -1,6 +1,7 @@
---
title: Cloning dashboards and cells
description: Dashboards and their cells can be cloned, or copied, to be used as templates for easily creating new dashboards and cells.
title: Clone dashboards and cells
description: >
Clone a dashboard or a cell and use the copy as a starting point to create new dashboard or cells.
menu:
chronograf_1_8:
weight: 70
@ -9,7 +10,7 @@ menu:
This guide explains how to clone, or duplicate, a dashboard or a cell for use as starting points for creating dashboards or cells using the copy as a template.
## Cloning dashboards
## Clone dashboards
Dashboards in Chronograf can be cloned (or copied) to be used to create a dashboard based on the original. Rather than building a new dashboard from scratch, you can clone a dashboard and make changes to the dashboard copy.
@ -26,7 +27,7 @@ The cloned dashboard opens and displays the name of the original dashboard with
You can now change the dashboard name and customize the dashboard.
## Cloning cells
## Clone cells
Cells in Chronograf dashboards can be cloned, or copied, to quickly create a cell copy that can be edited for another use.

10
content/chronograf/v1.8/guides/configuring-alert-endpoints.md
View File

@ -1,11 +1,11 @@
---
title: Configuring Chronograf alert endpoints
title: Configure Chronograf alert endpoints
aliases:
- /chronograf/v1.8/guides/configure-kapacitor-event-handlers/
description: Use Chronograf alert endpoints to send alert messages using Chronograf support for Alerta, Exec, HipChat, HTTP/Post, Kafka, Log, OpsGenie, PagerDuty, Sensu, Slack, SMTP/email, Talk, Telegram, TCP, and VictorOps.
description: Send alert messages with Chronograf alert endpoints.
menu:
chronograf_1_8:
name: Configuring alert endpoints
name: Configure alert endpoints
weight: 70
parent: Guides
---
@ -50,7 +50,7 @@ You must have a connected Kapacitor instance to access the configurations.
For more information, see [Kapacitor installation instructions](/{{< latest "kapacitor" >}}/introduction/installation/) and how to [connect a Kapacitor instance](/{{< latest "kapacitor" >}}/working/kapa-and-chrono/#add-a-kapacitor-instance) to Chronograf.
Note that the configuration options in the **Configure alert endpoints** section are not all-inclusive.
Some event handlers allow users to customize event handler configurations per [alert rule](/{{< latest "chronograf" >}}/guides/create-a-kapacitor-alert/).
Some event handlers allow users to customize event handler configurations per [alert rule](/chronograf/v1.8/guides/create-a-kapacitor-alert/).
For example, Chronograf's Slack integration allows users to specify a default channel in the **Configure alert endpoints** section and a different channel for individual alert rules.
### HipChat
@ -87,7 +87,7 @@ The following steps describe how to create the API access token:
Your token appears in the table just above the **Create new token** section:
![HipChat token](/img/{{< latest "chronograf" >}}/g-eventhandlers-hipchattoken.png)
![HipChat token](/img/chronograf/1-6-g-eventhandlers-hipchattoken.png)
### Kafka

18
content/chronograf/v1.8/guides/create-a-dashboard.md
View File

@ -1,16 +1,16 @@
---
title: Creating Chronograf dashboards
description: This tutorial guides you quickly through the essential steps required to create custom Chronograf dashboards for use with InfluxDB and the InfluxData Platform.
title: Create Chronograf dashboards
description: Visualize your data with custom Chronograf dashboards.
menu:
chronograf_1_8:
name: Creating dashboards
name: Create dashboards
weight: 30
parent: Guides
---
Chronograf offers a complete dashboard solution for visualizing your data and monitoring your infrastructure:
* View [pre-created dashboards](/{{< latest "chronograf" >}}/guides/using-precreated-dashboards) from the Host List page. Dashboards are available depending on which Telegraf input plugins you have enabled. These pre-created dashboards cannot be cloned or edited.
* View [pre-created dashboards](/chronograf/v1.8/guides/using-precreated-dashboards) from the Host List page. Dashboards are available depending on which Telegraf input plugins you have enabled. These pre-created dashboards cannot be cloned or edited.
* Create custom dashboards from scratch by building queries in the Data Explorer, as described [below](#build-a-dashboard).
* Import dashboard templates when you add or update a connection in Chronograf. See [Dashboard templates](#dashboard-templates) for details.
@ -22,9 +22,9 @@ By the end of this guide, you'll be aware of the tools available to you for crea
To perform the tasks in this guide, you must have a working Chronograf instance that is connected to an InfluxDB source.
Data is accessed using the Telegraf [system ](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/system) input plugins.
For more information, see [Configuring Chronograf](/{{< latest "chronograf" >}}/administration/configuration).
For more information, see [Configuring Chronograf](/chronograf/v1.8/administration/configuration).
## Build a Dashboard
## Build a dashboard
Click **Dashboards** in the navigation bar and then click the **Create Dashboard** button.
A new dashboard is created and ready to begin adding cells.
@ -57,7 +57,7 @@ In addition, the time range (`:dashboardTime:` and `:upperDashboardTime:`) are [
### Step 4: Choose your visualization type
Chronograf supports many different [visualization types](/{{< latest "chronograf" >}}/guides/visualization-types/). To choose a visualization type, click **Visualization** and select **Step-Plot Graph**.
Chronograf supports many different [visualization types](/chronograf/v1.8/guides/visualization-types/). To choose a visualization type, click **Visualization** and select **Step-Plot Graph**.
![Visualization type](/img/chronograf/1-6-g-dashboard-visualization.png)
@ -82,7 +82,7 @@ Click **Save** (the green checkmark icon) to save your cell.
* **Reset** your cell by double-clicking your mouse in the cell window
> **Note:**
These tips only apply to the line, stacked, step-plot, and line+stat [visualization types](/{{< latest "chronograf" >}}/guides/visualization-types/).
These tips only apply to the line, stacked, step-plot, and line+stat [visualization types](/chronograf/v1.8/guides/visualization-types/).
#### Configure dashboard-wide settings
@ -127,4 +127,4 @@ To exit full screen mode, press the Esc key.
### Template variables
Dashboards support template variables.
See the [Dashboard Template Variables](/{{< latest "chronograf" >}}/guides/dashboard-template-variables/) guide for more information.
See the [Dashboard Template Variables](/chronograf/v1.8/guides/dashboard-template-variables/) guide for more information.

18
content/chronograf/v1.8/guides/create-alert-rules.md
View File

@ -1,11 +1,12 @@
---
title: Creating Chronograf alert rules
description: Creating Chronograf alert rules, specifying time series data and thresholds. Example sends alerts to a Slack channel.
title: Create Chronograf alert rules
description: >
Trigger alerts by building Kapacitor alert rules in the Chronograf user interface (UI).
aliases:
- /chronograf/v1.8/guides/create-a-kapacitor-alert/
menu:
chronograf_1_8:
name: Creating alert rules
name: Create alert rules
weight: 60
parent: Guides
---
@ -26,15 +27,14 @@ This guide walks through creating a Chronograf alert rule that sends an alert me
## Requirements
[Getting started with Chronograf](/{{< latest "chronograf" >}}/introduction/getting-started/) offers step-by-step instructions for each of the following requirements:
[Getting started with Chronograf](/chronograf/v1.8/introduction/getting-started/) offers step-by-step instructions for each of the following requirements:
* Downloaded and install the entire TICKstack (Telegraf, InfluxDB, Chronograf, and Kapacitor).
* Configure Telegraf to collect data using the InfluxDB [system statistics](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/system) input plugin and write data to your InfluxDB instance.
* [Create a Kapacitor connection in Chronograf](/{{< latest "chronograf" >}}/introduction/getting-started/#4-connect-chronograf-to-kapacitor).
* Slack is available and configured as an [event handler](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#what-kapacitor-event-handlers-are-supported-in-chronograf) in Chronograf.
See the [Configuring Kapacitor Event Handlers](/{{< latest "chronograf" >}}/guides/configuring-alert-endpoints/) guide for detailed configuration instructions.
* [Create a Kapacitor connection in Chronograf](/chronograf/v1.8/introduction/installation/#connect-chronograf-to-kapacitor).
* Slack is available and configured as an event handler in Chronograf. See [Configuring Chronograf alert endpoints](/chronograf/v1.8/guides/configuring-alert-endpoints/) for detailed configuration instructions.
## Configuring Chronograf alert rules
## Configure Chronograf alert rules
Navigate to the **Manage Tasks** page under **Alerting** in the left navigation, then click **+ Build Alert Rule** in the top right corner.
@ -124,7 +124,7 @@ Notice that you can easily enable and disable the rule by toggling the checkbox
Next, move on to the section below to experience your alert rule in action.
## Viewing alerts in practice
## View alerts in practice
### Step 1: Create some load on your system

21
content/chronograf/v1.8/guides/dashboard-template-variables.md
View File

@ -1,6 +1,7 @@
---
title: Using dashboard template variables
description: Chronograf dashboards support template variables that let you modify queries through simple user interactions. Variable types include databases, measurements, field keys, tag keys, tag values, comma-separated values (CSV), maps, custom meta queries, and text.
title: Use dashboard template variables
description: >
Dashboard variables let you to alter specific components of cells' queries without having to edit the queries, making it easy to interact with your dashboard cells and explore your data.
aliases:
- /chronograf/v1.8/introduction/templating/
- /chronograf/v1.8/templating/
@ -10,10 +11,10 @@ menu:
parent: Guides
---
Chronograf's dashboard template variables allow you to alter specific components of cells' queries
Chronograf's dashboard template variables let you to alter specific components of cells' queries
without having to edit the queries, making it easy to interact with your dashboard cells and explore your data.
## Using template variables
## Use template variables
Template variables are used in cell queries and titles when creating Chronograf dashboards.
Within the query, template variables are referenced by surrounding the variable name with colons (`:`).
@ -283,7 +284,7 @@ The customer names would populate your template variable dropdown rather than th
### Custom Meta Query
Vary part of a query with a customized meta query that pulls a specific array of values from InfluxDB.
These variables allow you to pull a highly customized array of potential values and offer advanced functionality such as [filtering values based on other template variables](#filtering-template-variables-with-other-template-variables).
These variables let you pull a highly customized array of potential values and offer advanced functionality such as [filtering values based on other template variables](#filter-template-variables-with-other-template-variables).
<img src="/img/chronograf/1-6-template-vars-custom-meta-query.png" style="width:100%;max-width:667px;" alt="Custom meta query"/>
@ -306,7 +307,7 @@ They are great when troubleshooting incidents that affect multiple visualized me
## Reserved variable names
The following variable names are reserved and cannot be used when creating template variables.
Chronograf accepts [template variables as URL query parameters](#defining-template-variables-in-the-url)
Chronograf accepts [template variables as URL query parameters](#define-template-variables-in-the-url)
as well as many other parameters that control the display of graphs in your dashboard.
These names are either [predefined variables](#predefined-template-variables) or would
conflict with existing URL query parameters.
@ -319,12 +320,12 @@ conflict with existing URL query parameters.
`:upper:`
`:lower:`
`:zoomedUpper:`
`:zoomedLower:`
`refreshRate:`
`:zoomedLower:`
`refreshRate:`
## Advanced template variable usage
### Filtering template variables with other template variables
### Filter template variables with other template variables
[Custom meta query template variables](#custom-meta-query) allow you to filter the array of potential variable values using other existing template variables.
For example, let's say you want to list all the field keys associated with a measurement, but want to be able to change the measurement:
@ -352,7 +353,7 @@ The resulting dashboard will work like this:
![Custom meta query filtering](/img/chronograf/1-6-custom-meta-query-filtering.gif)
### Defining template variables in the URL
### Define template variables in the URL
Chronograf uses URL query parameters (also known as query string parameters) to set both display options and template variables in the URL.
This makes it easy to share links to dashboards so they load in a specific state with specific template variable values selected.

4
content/chronograf/v1.8/guides/live_leaderboard.md
View File

@ -1,6 +1,6 @@
---
title: Creating a live leaderboard for game scores
description: Tutorial on using Chronograf to build a leaderboard for gamers to be able to see player scores in realtime. Historical data is also available for post-game analysis.
title: Create a live leaderboard for game scores
description: This example uses Chronograf to build a leaderboard for gamers to be able to see player scores in realtime.
menu:
chronograf_1_8:
name: Live leaderboard of game scores

18
content/chronograf/v1.8/guides/monitoring-influxenterprise-clusters.md
View File

@ -1,6 +1,6 @@
---
title: Monitoring InfluxDB Enterprise clusters
description: Use Chronograf dashboards with an InfluxDB OSS server to measure and monitor InfluxDB Enterprise cluster data nodes using Telegraf output plugins and input plugins.
title: Monitor InfluxDB Enterprise clusters
description: Use Chronograf dashboards with an InfluxDB OSS server to measure and monitor InfluxDB Enterprise clusters.
aliases:
- /chronograf/v1.8/guides/monitor-an-influxenterprise-cluster/
menu:
@ -23,7 +23,7 @@ See the InfluxEnterprise documentation for
This guide uses an InfluxData Enterprise cluster with three meta nodes and three data nodes; the steps are also applicable to other cluster configurations.
InfluxData recommends using a separate server to store your monitoring data.
It is possible to store the monitoring data in your cluster and [connect the cluster to Chronograf](/{{< latest "chronograf" >}}/troubleshooting/frequently-asked-questions/#how-do-i-connect-chronograf-to-an-influxenterprise-cluster), but, in general, your monitoring data should live on a separate server.
It is possible to store the monitoring data in your cluster and [connect the cluster to Chronograf](/chronograf/v1.8/troubleshooting/frequently-asked-questions/#how-do-i-connect-chronograf-to-an-influxenterprise-cluster), but, in general, your monitoring data should live on a separate server.
You're working on an Ubuntu installation.
Chronograf and the other components of the TICK stack are supported on several operating systems and hardware architectures. Check out the [downloads page](https://portal.influxdata.com/downloads) for links to the binaries of your choice.
@ -99,11 +99,11 @@ A successful `CREATE USER` query returns a blank result:
Perform the following steps on each data node in your cluster.
You'll return to your InfluxDB instance at the end of this section.
#### Step 1: Download and install Telegraf.
#### Step 1: Download and install Telegraf
Telegraf can be downloaded from the [InfluxData downloads page](https://portal.influxdata.com/downloads).
#### Step 2: Configure Telegraf.
#### Step 2: Configure Telegraf
Configure Telegraf to write monitoring data to your InfluxDB OSS instance.
The Telegraf configuration file is located in `/etc/telegraf/telegraf.conf`.
@ -160,7 +160,7 @@ Enabled input plugins are configured in the `INPUT PLUGINS` section of the confi
collect_cpu_time = false
```
#### Step 3: Restart the Telegraf service.
#### Step 3: Restart the Telegraf service
Restart the Telegraf service so that your configuration changes take effect:
@ -184,7 +184,7 @@ systemctl restart telegraf
Repeat steps one through four for each data node in your cluster.
#### Step 4: Confirm the Telegraf setup.
#### Step 4: Confirm the Telegraf setup
To verify Telegraf is successfully collecting and writing data, use one of the following methods to query your InfluxDB OSS instance:
@ -284,6 +284,6 @@ In the image below, the Chronograf query editor is used to visualize the idle CP
![Data Explorer](/img/chronograf/1-6-cluster-de.png)
Create more customized graphs and save them to a dashboard on the Dashboard page in Chronograf.
See the [Creating Chronograf dashboards](/{{< latest "chronograf" >}}/guides/create-a-dashboard/) guide for more information.
See the [Creating Chronograf dashboards](/chronograf/v1.8/guides/create-a-dashboard/) guide for more information.
That's it! You've successfully configured Telegraf to collect and write data, InfluxDB to store those data, and Chonograf to use those data for monitoring and visualization purposes.
That's it! You've successfully configured Telegraf to collect and write data, InfluxDB to store those data, and Chronograf to use those data for monitoring and visualization purposes.

8
content/chronograf/v1.8/guides/presentation-mode.md
View File

@ -1,23 +1,23 @@
---
title: Viewing Chronograf dashboards in presentation mode
title: View Chronograf dashboards in presentation mode
description: View dashboards in full screen using presentation mode.
menu:
chronograf_1_8:
name: Viewing dashboards in presentation mode
name: View dashboards in presentation mode
weight: 130
parent: Guides
---
Presentation mode allows you to view Chronograf in full screen, hiding the left and top navigation menus so only the cells appear. This mode might be helpful, for example, for stationary screens dedicated to monitoring visualizations.
## Entering presentation mode manually
## Enter presentation mode manually
To enter presentation mode manually, click the icon in the upper right:
<img src="/img/chronograf/1-6-presentation-mode.png" style="width:100%; max-width:500px"/>
To exit presentation mode, press `ESC`.
## Using the URL query parameter
## Use the URL query parameter
To load the dashboard in presentation mode, add URL query parameter `present=true` to your dashboard URL. For example, your URL might look like this:
`http://example.com:8888/sources/1/dashboards/2?present=true`

8
content/chronograf/v1.8/guides/querying-data.md
View File

@ -3,11 +3,11 @@ title: Explore data in Chronograf
description: Query and visualize data in the Data Explorer.
menu:
chronograf_1_8:
name: Exploring data in Chronograf
name: Explore data in Chronograf
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](/{{< latest "chronograf" >}}/guides/visualization-types/) for your query.
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:
@ -17,7 +17,7 @@ To open the **Data Explorer**, click the **Explore** icon in the navigation bar:
- In the upper-right corner of the page, select the time to view metrics and events by clicking one of the following:
- **UTC** for Coordinated Universal Time
- **Local** for the local time reported by your browser
- **Local** for the local time reported by your browser
> **Note:** If your organization spans multiple time zones, we recommend using UTC (Coordinated Universal Time) to ensure that everyone sees metrics and events for the same time.
@ -66,7 +66,7 @@ Flux is InfluxData's new functional data scripting language designed for queryin
## Visualize your query
Select the **Visualization** tab at the top of the **Data Explorer**. For details about all of the available visualization options, see [Visualization types in Chronograf](/{{< latest "chronograf" >}}/guides/visualization-types/).
Select the **Visualization** tab at the top of the **Data Explorer**. For details about all of the available visualization options, see [Visualization types in Chronograf](/chronograf/v1.8/guides/visualization-types/).
## Add queries to dashboards

5
content/chronograf/v1.8/guides/tickscript-logging.md
View File

@ -1,6 +1,6 @@
---
title: Editing TICKscripts in Chronograf
description: Editing and viewing TICKscript logs in Chronograf
title: Edit TICKscripts in Chronograf
description: View and edit TICKscript logs in Chronograf.
menu:
chronograf_1_8:
weight: 20
@ -10,6 +10,5 @@ menu:
TICKscript logs data to a log file for debugging purposes.
Notes:
* TICKscript logs data to a log file for debugging purposes. We have a bunch of hosts which post data to an external endpoint. the payload is logged before being sent.
A feature to show the list of hosts , and an ability to see the logs for each of them.

17
content/chronograf/v1.8/guides/using-precreated-dashboards.md
View File

@ -1,9 +1,10 @@
---
title: Using pre-created dashboards in Chronograf
description: Preconfigured dashboards can quickly be used to display metrics for popular applications, including Apache, Consul, Docker, Elasticsearch, InfluxDB, Mesos, MySQL, NGINX, PostgreSQL, RabbitMQ, Redis, and more
title: Use pre-created dashboards in Chronograf
description: >
Display metrics for popular third-party applications with preconfigured dashboards in Chronograf.
menu:
chronograf_1_8:
name: Using pre-created dashboards
name: Use pre-created dashboards
weight: 10
parent: Guides
---
@ -13,13 +14,13 @@ menu:
Pre-created dashboards are delivered with Chronograf depending on which Telegraf input plugins you have enabled and are available from the Host List page. These dashboards, which are built in and not editable, include cells with data visualizations for metrics that are relevant to data sources you are likely to be using.
> Note that these pre-created dashboards cannot be cloned or customized. They appear only as part of the Host List view and are associated with metrics gathered from a single host. Dashboard templates are also available and deliver a solid starting point for customizing your own unique dashboards based on the Telegraf plugins enabled and operate across one or more hosts. For details, see [Dashboard templates](/{{< latest "chronograf" >}}/guides/create-a-dashboard/#dashboard-templates).
> Note that these pre-created dashboards cannot be cloned or customized. They appear only as part of the Host List view and are associated with metrics gathered from a single host. Dashboard templates are also available and deliver a solid starting point for customizing your own unique dashboards based on the Telegraf plugins enabled and operate across one or more hosts. For details, see [Dashboard templates](/chronograf/v1.8/guides/create-a-dashboard/#dashboard-templates).
## Requirements
The pre-created dashboards automatically appear in the Host List page to the right of hosts based on which Telegraf input plugins you have enabled. Check the list below for applications that you are interested in using and make sure that you have the required Telegraf input plugins enabled.
## Using pre-created dashboards
## Use pre-created dashboards
Pre-created dashboards are delivered in Chronograf installations and are ready to be used when you have the required Telegraf input plugins enabled.
@ -29,7 +30,7 @@ Pre-created dashboards are delivered in Chronograf installations and are ready t
2. Select an application listed under **Apps**. By default, the system `app` should be listed next to a host listing. Other apps appear depending on the Telegraf input plugins that you have enabled.
The selected application appears showing pre-created cells, based on available measurements.
## Creating or editing dashboards
## Create or edit dashboards
Find a list of apps (pre-created dashboards) available to use with Chronograf below. For each app, you'll find:
@ -37,9 +38,9 @@ Find a list of apps (pre-created dashboards) available to use with Chronograf be
- JSON files included in the app
- Cell titles included in each JSON file
The JSON files for apps are included in the `/usr/share/chronograf/canned` directory. Find information about the configuration option `--canned-path` on the [Chronograf configuration options](/{{< latest "chronograf" >}}/administration/config-options/) page.
The JSON files for apps are included in the `/usr/share/chronograf/canned` directory. Find information about the configuration option `--canned-path` on the [Chronograf configuration options](/chronograf/v1.8/administration/config-options/) page.
Enable and disable apps in your [Telegraf configuration file](by default, `/etc/telegraf/telegraf.conf`). See [Configuring Telegraf](/telegraf/v1.13/administration/configuration/) for details.
Enable and disable apps in your Telegraf configuration file (by default, `/etc/telegraf/telegraf.conf`). See [Configuring Telegraf](/telegraf/v1.13/administration/configuration/) for details.
## Apps (pre-created dashboards):

7
content/chronograf/v1.8/guides/visualization-types.md
View File

@ -1,6 +1,7 @@
---
title: Visualization types in Chronograf
descriptions: Chronograf dashboards and views support graphs and other visualization types, including line graphs, stacked graphs, step-plot graphs, single statistics, bar graphs, gauges, and tables.
descriptions: >
Chronograf provides multiple visualization types to visualize your data in a format that makes to the most sense for your use case.
menu:
chronograf_1_8:
name: Visualization types
@ -8,7 +9,7 @@ menu:
parent: Guides
---
Chronograf's dashboard views support the following visualization types, which can be selected in the **Visualization Type** selection view of the [Data Explorer](/{{< latest "chronograf" >}}/querying-data) .
Chronograf's dashboard views support the following visualization types, which can be selected in the **Visualization Type** selection view of the [Data Explorer](/chronograf/v1.8/guides/querying-data).
[Visualization Type selector](/img/chronograf/1-6-viz-types-selector.png)
@ -26,7 +27,6 @@ Each of the available visualization types and available user controls are descri
For information on adding and displaying annotations in graph views, see [Adding annotations to Chronograf views](/chronograf/v1.8/guides/annotations/).
### Line Graph
The **Line Graph** view displays a time series in a line graph.
@ -51,7 +51,6 @@ Use the **Line Graph Controls** to specify the following:
* **Scale**: Toggle between **Linear** and **Logarithmic**.
* **Static Legend**: Toggle between **Show** and **Hide**.
#### Line Graph example
![Line Graph example](/img/chronograf/1-6-viz-line-graph-example.png)

19
content/chronograf/v1.8/introduction/_index.md
View File

@ -1,6 +1,7 @@
---
title: Introducing Chronograf
description: An introduction to Chronograf, the user interface and data visualization component for the InfluxData Platform. Includes documentation on getting started, installation, and downloading.
title: Introduction to Chronograf
description: >
An introduction to Chronograf, the user interface and data visualization component for the InfluxData Platform. Includes documentation on getting started, installation, and downloading.
menu:
chronograf_1_8:
@ -10,16 +11,4 @@ menu:
Follow the links below to get acquainted with Chronograf:
## [Downloading Chronograf](https://portal.influxdata.com/downloads)
Chronograf is supported on several operating systems and hardware architectures.
See the [InfluxData downloads page](https://portal.influxdata.com/downloads) page for to the available binaries.
## [Installing Chronograf](/{{< latest "chronograf" >}}/introduction/installation/)
[Installing Chronograf](/{{< latest "chronograf" >}}/introduction/installation/) lists the requirements for installing, starting, and configuring Chronograf.
## Getting Started
[Getting started with Chronograf](/{{< latest "chronograf" >}}/introduction/getting-started/) gets you up and running with Chronograf with as little configuration and code as possible.
By the end of the guide, you will have downloaded, installed, and configured all four packages of the
TICK stack ([Telegraf](https://github.com/influxdata/telegraf), [InfluxDB](https://github.com/influxdata/influxdb), Chronograf, and [Kapacitor](https://github.com/influxdata/kapacitor)), and you will be all set to monitor your infrastructure.
{{< children >}}

Some files were not shown because too many files have changed in this diff Show More