updated influxd inspect and generate commands based on feedback

pull/141/head
Scott Anderson 2019-04-09 16:45:38 -06:00
parent 9a94221fa8
commit 4f8a22c53f
4 changed files with 13 additions and 13 deletions

View File

@ -15,9 +15,9 @@ The `influxd generate` command generates time series data direct to disk using a
{{% note %}}
#### Important notes
- `influxd generate` cannot run while the `influxd` server is running.
It modifies the index and Time-Structured Merge Tree (TSM) data.
- This tool is intended for development and testing purposes only and
**should not** be run on a production server.
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

View File

@ -11,7 +11,7 @@ weight: 301
---
The `influxd generate help-schema` command outputs an example TOML schema to stdout that includes
documentation describing the available options. _See [example output](#example-output) below_.
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).
@ -121,7 +121,7 @@ tags = [
# 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.
# given time range, the number of values will be reduced.
#
# Example:
# count = 1000, start = 0s, end = 100s, time-precison = s
@ -139,7 +139,7 @@ tags = [
# 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.
# given time range, the number of values will be reduced.
#
# Example:
# count = 100, start = 0s, end = 100s, time-interval = 10s

View File

@ -16,9 +16,9 @@ reasonable defaults and command line interface (CLI) [flags](#flags).
{{% note %}}
#### Important notes
- `influxd generate simple` cannot run while the `influxd` server is running.
It modifies the index and Time-Structured Merge Tree (TSM) data.
- This tool is intended for development and testing purposes only and
**should not** be run on a production server.
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

View File

@ -3,7 +3,7 @@ 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
as well as the time range that the point data covers.
and the time range the data covers.
v2.0/tags: [tsm, cardinality, inspect]
menu:
v2_0_ref:
@ -13,7 +13,7 @@ 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
as well as the time range that the point data covers.
and the time range the data covers.
This command only interrogates the index within each file.
It does not read any block data.
@ -29,11 +29,11 @@ influxd inspect report-tsm [flags]
## Output details
`influxd inspect report-tsm` outputs the following for each file:
- The full filename.
- 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 taken to load the TSM index and apply any tombstones.
- 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