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

Merge branch 'alpha-8' into alpha-8-orgs-move

pull/153/head
Nora 2019-04-10 11:06:34 -07:00
parent 5a5c597506 c219818121
commit cdf8ceb268
20 changed files with 518 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@ -379,8 +379,10 @@ Below is a list of available icons (some are aliases):
- add-label
- alert
- calendar
- chat
- checkmark
- clone
- cloud
- cog
- config
- copy
@ -392,6 +394,7 @@ Below is a list of available icons (some are aliases):
- edit
- expand
- export
- feedback
- fullscreen
- gear
- graph

4
assets/styles/layouts/_layout-article.scss
View File

@ -280,6 +280,10 @@
border-style: solid;
border-radius: 0 $border-radius $border-radius 0;
font-size: .95rem;
ul,ol {
&:last-child { margin-bottom: 1.85rem; }
}
}
blockquote {

12
content/v2.0/cloud/about/_index.md Normal file
View File

@ -0,0 +1,12 @@
---
title: About InfluxDB Cloud 2
description: Important information about InfluxDB Cloud 2 including release notes and known issues.
weight: 10
menu:
v2_0_cloud:
name: About InfluxDB Cloud
---
Important information about InfluxDB Cloud 2 including known issues and release notes.
{{< children >}}

19
content/v2.0/cloud/about/known-issues.md Normal file
View File

@ -0,0 +1,19 @@
---
title: Known issues in InfluxDB Cloud
description: Information related to known issues in InfluxDB Cloud 2.
weight: 102
menu:
v2_0_cloud:
name: Known issues
parent: About InfluxDB Cloud
---
The following issues currently exist in {{< cloud-name >}}:
- Usage statistics on the Usage page may show incorrect values (still in development).
- Existing tasks may have duration specified in nanoseconds and need to be resubmitted.
- IDPE-2860: Additional user shows up as owner under Cloud 2 organization.
- IDPE 2868: User must not be able to delete token with an active Telegraf configuration pointed to it.
- IDPE-2869: As a Cloud 2.0 user, I cannot use any CLI tools to interact with my Cloud 2 tenant.
- [TELEGRAF-5600](https://github.com/influxdata/telegraf/issues/5600): Improve error message in Telegraf when bucket it's reporting to is not found.
- [INFLUXDB-12687](https://github.com/influxdata/influxdb/issues/12687): Create org should display only for the create org permission.

49
content/v2.0/cloud/about/release-notes.md Normal file
View File

@ -0,0 +1,49 @@
---
title: InfluxDB Cloud release notes
description: Important changes and notes introduced in each InfluxDB Cloud 2 update.
weight: 101
menu:
v2_0_cloud:
parent: About InfluxDB Cloud
name: Release notes
---
## v2.0 [2019-04-05]
### Features
* Insert Flux function near cursor in Flux Editor.
* Enable the use of variables in the Data Explorer and Cell Editor Overlay.
* Add a variable control bar to dashboards to select values for variables.
* Add ability to add variable to script from the side menu.
* Use time range for meta queries in Data Explorer and Cell Editor Overlay.
* Fix screen tearing bug in raw data view.
* Add copy to clipboard button to export overlays.
* Enable copying error messages to the clipboard from dashboard cells.
* Add the ability to update token's status in token list.
* Allow variables to be re-ordered within control bar on a dashboard.
* Add the ability to delete a template.
* Save user preference for variable control bar visibility and default to visible.
* Add the ability to clone a template
* Add the ability to import a variable.
### Bug Fixes
* Logout works in Cloud 2.0 UI.
* Single sign-on works between https://cloud2.influxdata.com and https://us-west-2-1.aws.cloud2.influxdata.com.
* Able to copy error message from UI.
* Able to change a task from every to cron.
* Able to create a new bucket when switching between periodically and never (retention options).
* Fix mismatch in bucket row and header.
* Allows user to edit note on cell.
* Fix empty state styles in scrapers in org view.
* Fix bucket creation error when changing rentention rules types.
* Fix task creation error when switching schedule types.
* Fix hidden horizontal scrollbars in flux raw data view.
* Fix screen tearing bug in raw data View.
* Fix routing loop.
### UI Improvements
* Move bucket selection in the query builder to the first card in the list.
* Ensure editor is automatically focused in Note Editor.
* Add ability to edit a template's name.

20
content/v2.0/cloud/get-started.md
View File

@ -54,19 +54,7 @@ Once you've set up {{< cloud-name "short" >}} to collect data with Telegraf, you
* Query data using Flux, the UI, and the `influx` command line interface. See [Query data](https://v2.docs.influxdata.com/v2.0/query-data/).
* Build custom dashboards to visualize your data. See [Visualize data](https://v2.docs.influxdata.com/v2.0/visualize-data/).
## Known issues and disabled features
The following issues currently exist in {{< cloud-name >}}:
* IDPE-2860: Additional user shows up as owner under Cloud 2 organization.
* IDPE 2868: User must not be able to delete token with an active Telegraf configuration pointed to it.
* IDPE-2869: As a Cloud 2.0 user, I cannot use any CLI tools to interact with my Cloud 2 tenant.
* IDPE-2896: Logout does not work in Cloud 2.0 UI.
* IDPE-2897: Single sign on does not work between `https://cloud2.influxdata.com` and `https://us-west-2-
1.aws.cloud2.influxdata.com`.
* [TELEGRAF-5600](https://github.com/influxdata/telegraf/issues/5600): Improve error message in Telegraf when bucket it's reporting to is not found.
* [INFLUXDB-12686](https://github.com/influxdata/influxdb/issues/12686): Unable to copy error message from UI.
* [INFLUXDB-12690](https://github.com/influxdata/influxdb/issues/12690): Impossible to change a task from `every` to `cron`.
* [INFLUXDB-12688](https://github.com/influxdata/influxdb/issues/12688): Create bucket switching between periodically and never fails to create bucket.
* [INFLUXDB-12687](https://github.com/influxdata/influxdb/issues/12687): Create org should display only for the create org permission.
{{% note %}}
#### Known issues and disabled features
_See [Known issues](/v2.0/cloud/about/known-issues/) for information regarding all known issues in InfluxDB Cloud._
{{% /note %}}

14
content/v2.0/get-started.md
View File

@ -203,6 +203,20 @@ the `influx` command line interface (CLI).
InfluxDB is now initialized with a primary user, organization, and bucket.
You are ready to [collect data](/v2.0/collect-data).
{{% note %}}
#### Using the influx CLI after setting up InfluxDB through the UI
To use the [`influx` CLI](/v2.0/reference/cli/influx) after setting up InfluxDB through the UI,
use one of the following methods to provide your [authentication token](/v2.0/users/tokens/) to the CLI:
1. Pass your token to the `influx` CLI using the `-t` or `--token` flag.
2. Set the `INFLUX_TOKEN` environment variable using your token.
3. Store your token in `~/.influxdbv2/credentials`.
_The content of the `credentials` file should be only your token._
_See [View tokens](/v2.0/users/tokens/view-tokens/) for information about
retrieving authentication tokens._
{{% /note %}}
{{% /tab-content %}}
<!-------------------------------- END UI Setup ------------------------------->

15
content/v2.0/process-data/_index.md
View File

@ -11,17 +11,14 @@ weight: 5
v2.0/tags: [tasks]
---
InfluxDB's _**task engine**_ is designed for processing and analyzing data.
A task is a scheduled Flux query that take a stream of input data, modify or
analyze it in some way, then perform an action.
Examples include data downsampling, anomaly detection _(Coming)_, alerting _(Coming)_, etc.
Process and analyze your data with tasks in the InfluxDB _**task engine**. Use tasks (scheduled Flux queries)
to input a data stream and then analyze, modify, and act on the data accordingly.
Discover how to configure and build tasks using the InfluxDB user interface (UI) and the `influx` command line interface (CLI).
Find examples of data downsampling, anomaly detection_(Coming)_, alerting _(Coming)_, and other common tasks.
{{% note %}}
Tasks are a replacement for InfluxDB v1.x's continuous queries.
Tasks replace InfluxDB v1.x's continuous queries.
{{% /note %}}
The following articles explain how to configure and build tasks using the InfluxDB user interface (UI)
and via raw Flux scripts with the `influx` command line interface (CLI).
They also provide examples of commonly used tasks.
{{< children >}}

21
content/v2.0/reference/cli/influx/_index.md
View File

@ -21,6 +21,27 @@ influx [flags]
influx [command]
```
{{% note %}}
#### Store your InfluxDB authentication token
To avoid having to pass your InfluxDB [authentication token](/v2.0/users/tokens/)
with each `influx` command, use one of the following methods to store your token:
1. Set the `INFLUX_TOKEN` environment variable using your token.
```bash
export INFLUX_TOKEN=oOooYourAuthTokenOoooOoOO==
```
2. Store your token in `~/.influxdbv2/credentials`.
_The content of the `credentials` file should be only your token._
_**Note:** If you [set up InfluxDB using the CLI](/v2.0/reference/cli/influx/setup),
InfluxDB stores your token in the credentials files automatically._
_See [View tokens](/v2.0/users/tokens/view-tokens/) for information about
retrieving authentication tokens._
{{% /note %}}
## Commands
| Command | Description |
|:------- |:----------- |

2
content/v2.0/reference/cli/influx/setup/_index.md
View File

@ -1,5 +1,5 @@
---
title: influx setup – Run the initial Influx DB setup
title: influx setup – Run the initial InfluxDB setup
description: >
The 'influx setup' command walks through the initial InfluxDB setup process,
creating a default user, organization, and bucket.

9
content/v2.0/reference/cli/influxd/_index.md
View File

@ -1,6 +1,5 @@
---
title: influxd - InfluxDB daemon
seotitle: influxd - InfluxDB daemon
description: The influxd daemon starts and runs all the processes necessary for InfluxDB to function.
v2.0/tags: [influxd, cli]
menu:
@ -21,9 +20,11 @@ influxd [command]
## Commands
| Command | Description |
|:------- |:----------- |
| [run](/v2.0/reference/cli/influxd/run) | Start the influxd server (default) |
| Command | Description |
|:------- |:----------- |
| [generate](/v2.0/reference/cli/influxd/generate) | Generate time series data sets using TOML schema. |
| [inspect](/v2.0/reference/cli/influxd/inspect) | Inspect on-disk database data. |
| [run](/v2.0/reference/cli/influxd/run) | Start the influxd server _**(default)**_ |
## Flags

46
content/v2.0/reference/cli/influxd/generate/_index.md Normal file
View File

@ -0,0 +1,46 @@
---
title: influxd generate
description: >
The `influxd generate` command generates time series data direct to disk using
a schema defined in a TOML file.
v2.0/tags: [sample-data]
menu:
v2_0_ref:
parent: influxd
weight: 201
---
The `influxd generate` command generates time series data direct to disk using a schema defined in a TOML file.
{{% note %}}
#### Important notes
- `influxd generate` cannot run while the `influxd` server is running.
The `generate` command modifies index and Time-Structured Merge Tree (TSM) data.
- Use `influxd generate` for **development and testing purposes only**.
Do not run it on a production server.
{{% /note %}}
## Usage
```sh
influxd generate <schema.toml> [flags]
influxd generate [subcommand]
```
## Subcommands
| Subcommand | Description |
|:------- |:----------- |
| [help-schema](/v2.0/reference/cli/influxd/generate/help-schema) | Print a documented example TOML schema to stdout. |
| [simple](/v2.0/reference/cli/influxd/generate/simple) | Generate simple data sets using defaults and CLI flags. |
## Flags
| Flag | Description | Input Type |
|:---- |:----------- |:----------:|
| `--print` | Print data spec and exit | |
| `--org` | Name of organization | string |
| `--bucket` | Name of bucket | string |
| `--start-time` | Start time (`YYYY-MM-DDT00:00:00Z`) (default is 00:00:00 of one week ago) | string |
| `--end-time` | End time (`YYYY-MM-DDT00:00:00Z`) (default is 00:00:00 of current day) | string |
| `--clean` | Clean time series data files (`none`, `tsm` or `all`) (default `none`) | string |
| `--cpuprofile` | Collect a CPU profile | string |
| `--memprofile` | Collect a memory profile | string |
| `-h`, `--help` | Help for `generate` | |

206
content/v2.0/reference/cli/influxd/generate/help-schema.md Normal file
View File

@ -0,0 +1,206 @@
---
title: influxd generate help-schema
description: >
The `influxd generate help-schema` command outputs an example TOML schema to stdout
that includes documentation describing the available options.
v2.0/tags: [sample-data]
menu:
v2_0_ref:
parent: influxd generate
weight: 301
---
The `influxd generate help-schema` command outputs an example TOML schema to stdout that includes
descriptions of available options. _See [example output](#example-output) below_.
Use custom TOML schema files to generate sample data sets with
[`influxd generate`](/v2.0/reference/cli/influxd/generate).
## Usage
```sh
influxd generate help-schema [flags]
```
## Flags
| Flag | Description | Input Type |
|:---- |:----------- |:----------:|
| `--print` | Print data spec and exit | |
| `--org` | Name of organization | string |
| `--bucket` | Name of bucket | string |
| `--start-time` | Start time (`YYYY-MM-DDT00:00:00Z`) (default is 00:00:00 of one week ago) | string |
| `--end-time` | End time (`YYYY-MM-DDT00:00:00Z`) (default is 00:00:00 of current day) | string |
| `--clean` | Clean time series data files (`none`, `tsm` or `all`) (default `none`) | string |
| `--cpuprofile` | Collect a CPU profile | string |
| `--memprofile` | Collect a memory profile | string |
| `-h`, `--help` | Help for `generate help-schema` | |
## Example output
{{% truncate %}}
```toml
title = "Documented schema"
# limit the maximum number of series generated across all measurements
#
# series-limit: integer, optional (default: unlimited)
[[measurements]]
# name of measurement
#
# NOTE:
# Multiple definitions of the same measurement name are allowed and
# will be merged together.
name = "cpu"
# sample: float; where 0 < sample ≤ 1.0 (default: 0.5)
# sample a subset of the tag set
#
# sample 25% of the tags
#
sample = 0.25
# Keys for defining a tag
#
# name: string, required
# Name of field
#
# source: array<string> or object
#
# A literal array of string values defines the tag values.
#
# An object defines more complex generators. The type key determines the
# type of generator.
#
# source types:
#
# type: "sequence"
# generate a sequence of tag values
#
# format: string
# a format string for the values (default: "value%s")
# start: int (default: 0)
# beginning value
# count: int, required
# ending value
#
# type: "file"
# generate a sequence of tag values from a file source.
# The data in the file is sorted, deduplicated and verified is valid UTF-8
#
# path: string
# absolute path or relative path to current toml file
tags = [
# example sequence tag source. The range of values are automatically
# prefixed with 0s
# to ensure correct sort behavior.
{ name = "host", source = { type = "sequence", format = "host-%s", start = 0, count = 5 } },
# tags can also be sourced from a file. The path is relative to the
# schema.toml.
# Each value must be on a new line. The file is also sorted, deduplicated
# and UTF-8 validated.
{ name = "rack", source = { type = "file", path = "files/racks.txt" } },
# Example string array source, which is also deduplicated and sorted
{ name = "region", source = ["us-west-01","us-west-02","us-east"] },
]
# Keys for defining a field
#
# name: string, required
# Name of field
#
# count: int, required
# The maximum number of values to generate. When multiple fields
# have the same count and time-spec, they will share timestamps.
#
# A time-spec can be either time-precision or time-interval, which
# determines how timestamps are generated and may also influence
# the time range and number of values generated.
#
# time-precision: string [ns, us, ms, s, m, h] (default: ms)
# Specifies the precision (rounding) for generated timestamps.
#
# If the precision results in fewer than "count" intervals for the
# given time range, the number of values will be reduced.
#
# Example:
# count = 1000, start = 0s, end = 100s, time-precison = s
# 100 values will be generated at [0s, 1s, 2s, ..., 99s]
#
# If the precision results in greater than "count" intervals for the
# given time range, the interval will be rounded to the nearest multiple of
# time-precision.
#
# Example:
# count = 10, start = 0s, end = 100s, time-precison = s
# 100 values will be generated at [0s, 10s, 20s, ..., 90s]
#
# time-interval: Go duration string (eg 90s, 1h30m)
# Specifies the delta between generated timestamps.
#
# If the delta results in fewer than "count" intervals for the
# given time range, the number of values will be reduced.
#
# Example:
# count = 100, start = 0s, end = 100s, time-interval = 10s
# 10 values will be generated at [0s, 10s, 20s, ..., 90s]
#
# If the delta results in greater than "count" intervals for the
# given time range, the start-time will be adjusted to ensure "count" values.
#
# Example:
# count = 20, start = 0s, end = 1000s, time-interval = 10s
# 20 values will be generated at [800s, 810s, ..., 900s, ..., 990s]
#
# source: int, float, boolean, string, array or object
#
# A literal int, float, boolean or string will produce
# a constant value of the same data type.
#
# A literal array of homogeneous values will generate a repeating
# sequence.
#
# An object defines more complex generators. The type key determines the
# type of generator.
#
# source types:
#
# type: "rand<float>"
# generate random float values
# seed: seed to random number generator (default: 0)
# min: minimum value (default: 0.0)
# max: maximum value (default: 1.0)
#
# type: "zipf<integer>"
# generate random integer values using a Zipf distribution
# The generator generates values k ∈ [0, imax] such that P(k)
# is proportional to (v + k) ** (-s). Requirements: s > 1 and v ≥ 1.
# See https://golang.org/pkg/math/rand/#NewZipf for more information.
#
# seed: seed to random number generator (default: 0)
# s: float > 1 (required)
# v: float ≥ 1 (required)
# imax: integer (required)
#
fields = [
# Example constant float
{ name = "system", count = 5000, source = 2.5 },
# Example random floats
{ name = "user", count = 5000, source = { type = "rand<float>", seed = 10, min = 0.0, max = 1.0 } },
]
# Multiple measurements may be defined.
[[measurements]]
name = "mem"
tags = [
{ name = "host", source = { type = "sequence", format = "host-%s", start = 0, count = 5 } },
{ name = "region", source = ["us-west-01","us-west-02","us-east"] },
]
fields = [
# An example of a sequence of integer values
{ name = "free", count = 100, source = [10,15,20,25,30,35,30], time-precision = "ms" },
{ name = "low_mem", count = 100, source = [false,true,true], time-precision = "ms" },
]
```
{{% /truncate %}}

40
content/v2.0/reference/cli/influxd/generate/simple.md Normal file
View File

@ -0,0 +1,40 @@
---
title: influxd generate simple
description: >
The `influxd generate simple` command generates and writes a simple data set using
reasonable defaults and CLI flags.
v2.0/tags: [sample-data]
menu:
v2_0_ref:
parent: influxd generate
weight: 301
---
The `influxd generate simple` command generates and writes a simple data set using
reasonable defaults and command line interface (CLI) [flags](#flags).
{{% note %}}
#### Important notes
- `influxd generate simple` cannot run while the `influxd` server is running.
The `generate` command modifies index and Time-Structured Merge Tree (TSM) data.
- Use `influxd generate simple` for **development and testing purposes only**.
Do not run it on a production server.
{{% /note %}}
## Usage
```sh
influxd generate simple [flags]
```
## Flags
| Flag | Description | Input Type |
|:---- |:----------- |:----------:|
| `--print` | Print data spec and exit | |
| `--org` | Name of organization | string |
| `--bucket` | Name of bucket | string |
| `--start-time` | Start time (`YYYY-MM-DDT00:00:00Z`) (default is 00:00:00 of one week ago) | string |
| `--end-time` | End time (`YYYY-MM-DDT00:00:00Z`) (default is 00:00:00 of current day) | string |
| `--clean` | Clean time series data files (`none`, `tsm` or `all`) (default `none`) | string |
| `--cpuprofile` | Collect a CPU profile | string |
| `--memprofile` | Collect a memory profile | string |
| `-h`, `--help` | Help for `generate simple` | |

26
content/v2.0/reference/cli/influxd/inspect/_index.md Normal file
View File

@ -0,0 +1,26 @@
---
title: influxd inspect
description: The `influxd inspect` commands and subcommands inspecting on-disk InfluxDB time series data.
v2.0/tags: [inspect]
menu:
v2_0_ref:
parent: influxd
weight: 201
---
The `influxd inspect` commands and subcommands inspecting on-disk InfluxDB time series data.
## Usage
```sh
influxd inspect [command]
```
## Subcommands
| Subcommand | Description |
|:---------- |:----------- |
| [report-tsm](/v2.0/reference/cli/influxd/inspect/report-tsm/) | Run TSM report |
## Flags
| Flag | Description |
|:---- |:----------- |
| `-h`, `--help` | help for inspect |

57
content/v2.0/reference/cli/influxd/inspect/report-tsm.md Normal file
View File

@ -0,0 +1,57 @@
---
title: influxd inspect report-tsm
description: >
The `influxd inspect report-tsm` command analyzes Time-Structured Merge Tree (TSM)
files within a storage engine directory and reports the cardinality within the files
and the time range the data covers.
v2.0/tags: [tsm, cardinality, inspect]
menu:
v2_0_ref:
parent: influxd inspect
weight: 301
---
The `influxd inspect report-tsm` command analyzes Time-Structured Merge Tree (TSM)
files within a storage engine directory and reports the cardinality within the files
and the time range the data covers.
This command only interrogates the index within each file.
It does not read any block data.
To reduce heap requirements, by default `report-tsm` estimates the overall
cardinality in the file set by using the HLL++ algorithm.
Determine exact cardinalities by using the `--exact` flag.
## Usage
```sh
influxd inspect report-tsm [flags]
```
## Output details
`influxd inspect report-tsm` outputs the following for each file:
- The full file name.
- The series cardinality within the file.
- The number of series first encountered within the file.
- The minimum and maximum timestamp associated with TSM data in the file.
- The time to load the TSM index and apply any tombstones.
The summary section then outputs the total time range and series cardinality for
the file set. Depending on the `--detailed` flag, series cardinality is segmented
in the following ways:
- Series cardinality for each organization.
- Series cardinality for each bucket.
- Series cardinality for each measurement.
- Number of field keys for each measurement.
- Number of tag values for each tag key.
## Flags
| Flag | Description | Input Type |
|:---- |:----------- |:----------:|
| `--bucket-id` | Process only data belonging to bucket ID. _Requires `org-id` flag to be set._ | string |
| `--data-dir` | Use provided data directory (defaults to ~/.influxdbv2/engine/data). | string |
| `--detailed` | Emit series cardinality segmented by measurements, tag keys, and fields. _**May take a while**_. | |
| `--exact` | Calculate an exact cardinality count. _**May use significant memory**_. | |
| `-h`, `--help` | Help for `report-tsm`. | |
| `--org-id` | Process only data belonging to organization ID. | string |
| `--pattern` | Only process TSM files containing pattern. | string |

1
content/v2.0/reference/cli/influxd/run.md
View File

@ -4,7 +4,6 @@ description: The `influxd run` command is the default `influxd` command and star
v2.0/tags: [influxd, cli]
menu:
v2_0_ref:
name: run
parent: influxd
weight: 201
---

2
layouts/_default/list.html
View File

@ -13,7 +13,7 @@
{{ range .Pages }}
<h3><a href="{{.RelPermalink}}">{{ .Title }}</a></h3>
{{ if .Description }}
<p>{{ .Description }}</p>
<p>{{ .Description | markdownify }}</p>
{{ end }}
{{ end }}

4
layouts/shortcodes/icon.html
View File

@ -50,7 +50,9 @@
<span class="inline icon-ui-triangle middle"></span>
{{ else if eq $icon "cloud" }}
<span class="inline icon-ui-cloud large"></span>
{{ else if or (eq $icon "feedback") (eq $icon "chat") (eq $icon "bubble") }}
{{ else if eq $icon "feedback" }}
<span class="inline icon-ui-nav-chat large"></span>
{{ else if eq $icon "chat" }}
<span class="inline icon-ui-chat large"></span>
{{ else if eq $icon "add-label" }}
<span class="inline add-btn-round">&#59696;</span>

2
layouts/shortcodes/nav-icon.html
View File

@ -18,7 +18,7 @@
{{ .Scratch.Set "icon" "wrench-2" }}
{{ .Scratch.Set "title" "Settings" }}
{{ else if or (eq $navIcon "feedback") }}
{{ .Scratch.Set "icon" "chat" }}
{{ .Scratch.Set "icon" "nav-chat" }}
{{ .Scratch.Set "title" "Feedback" }}
{{ else if or (eq $navIcon "cloud") }}
{{ .Scratch.Set "icon" "cloud" }}