From 4ba04ad1b7237b6c01f81a53f77905764fd3233f Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 7 Aug 2019 17:12:57 -0600 Subject: [PATCH] added influxd report-tsi doc, resolves #359 --- .../reference/cli/influxd/inspect/_index.md | 13 +++--- .../cli/influxd/inspect/report-tsi.md | 45 +++++++++++++++++++ 2 files changed, 52 insertions(+), 6 deletions(-) create mode 100644 content/v2.0/reference/cli/influxd/inspect/report-tsi.md diff --git a/content/v2.0/reference/cli/influxd/inspect/_index.md b/content/v2.0/reference/cli/influxd/inspect/_index.md index 834a4a675..b7e37e496 100644 --- a/content/v2.0/reference/cli/influxd/inspect/_index.md +++ b/content/v2.0/reference/cli/influxd/inspect/_index.md @@ -16,12 +16,13 @@ influxd inspect [subcommand] ``` ## Subcommands -| Subcommand | Description | -|:---------- |:----------- | -| [export-blocks](/v2.0/reference/cli/influxd/inspect/export-blocks/) | Export block data | -| [report-tsm](/v2.0/reference/cli/influxd/inspect/report-tsm/) | Run TSM report | -| [verify-tsm](/v2.0/reference/cli/influxd/inspect/verify-tsm/) | Check the consistency of TSM files | -| [verify-wal](/v2.0/reference/cli/influxd/inspect/verify-wal/) | Check for corrupt WAL files | +| Subcommand | Description | +|:---------- |:----------- | +| [export-blocks](/v2.0/reference/cli/influxd/inspect/export-blocks/) | Export block data | +| [report-tsi](/v2.0/reference/cli/influxd/inspect/report-tsi/) | Report the cardinality of TSI files | +| [report-tsm](/v2.0/reference/cli/influxd/inspect/report-tsm/) | Run TSM report | +| [verify-tsm](/v2.0/reference/cli/influxd/inspect/verify-tsm/) | Check the consistency of TSM files | +| [verify-wal](/v2.0/reference/cli/influxd/inspect/verify-wal/) | Check for corrupt WAL files | ## Flags | Flag | Description | diff --git a/content/v2.0/reference/cli/influxd/inspect/report-tsi.md b/content/v2.0/reference/cli/influxd/inspect/report-tsi.md new file mode 100644 index 000000000..126ff324f --- /dev/null +++ b/content/v2.0/reference/cli/influxd/inspect/report-tsi.md @@ -0,0 +1,45 @@ +--- +title: influxd inspect report-tsi +description: > + The `influxd inspect report-tsi` command analyzes Time Series Index (TSI) files + in a storage directory and reports the cardinality of data stored in the files. +v2.0/tags: [tsi, cardinality, inspect] +menu: + v2_0_ref: + parent: influxd inspect +weight: 301 +--- + +The `influxd inspect report-tsi` command analyzes Time Series Index (TSI) files +in a storage directory and reports the cardinality of data stored in the files. +The report is divided into organization and bucket cardinalities. + +## Output details +`influxd inspect report-tsi` outputs the following: + +- All organizations and buckets in the index. +- The series cardinality within each organization and bucket. +- The time taken to read the index. + +When the `--measurements` flag is included, series cardinality is segmented in +the following ways: + +- Series cardinality for each organization. +- Series cardinality for each bucket. +- Series cardinality for each measurement. + +## Usage +```sh +influxd inspect report-tsi [flags] +``` + +## Flags +| Flag | Description | Input Type | +|:---- |:----------- |:----------:| +| `--bucket-id` | Process only data belonging to bucket ID. _Requires `org-id` flag to be set._ | string | +| `-h`, `--help` | Help for `report-tsi`. | | +| `-m`, `--measurements` | Segment cardinality by measurements. | | +| `-o`, `--org-id` | Process only data belonging to organization ID. | string | +| `--path` | Path to index. Defaults to `~/.influxdbv2/engine/index`. | string | +| `--series-file` | Path to series file. Defaults to `~/.influxdbv2/engine/_series`. | string | +| `-t`, `-top` | Limit results to the top n. | integer |