diff --git a/content/v2.0/reference/cli/influxd/inspect/_index.md b/content/v2.0/reference/cli/influxd/inspect/_index.md index 41ad6bbdc..834a4a675 100644 --- a/content/v2.0/reference/cli/influxd/inspect/_index.md +++ b/content/v2.0/reference/cli/influxd/inspect/_index.md @@ -12,16 +12,18 @@ The `influxd inspect` commands and subcommands inspecting on-disk InfluxDB time ## Usage ```sh -influxd inspect [command] +influxd inspect [subcommand] ``` ## Subcommands -| Subcommand | Description | -|:---------- |:----------- | -| [report-tsm](/v2.0/reference/cli/influxd/inspect/report-tsm/) | Run TSM report | -| [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-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 | -|:---- |:----------- | -| `-h`, `--help` | help for inspect | +| Flag | Description | +|:---- |:----------- | +| `-h`, `--help` | Help for `inspect` | diff --git a/content/v2.0/reference/cli/influxd/inspect/export-blocks.md b/content/v2.0/reference/cli/influxd/inspect/export-blocks.md new file mode 100644 index 000000000..dbd848b26 --- /dev/null +++ b/content/v2.0/reference/cli/influxd/inspect/export-blocks.md @@ -0,0 +1,24 @@ +--- +title: influxd inspect export-blocks +description: > + The `influxd inspect export-blocks` command exports all blocks in one or more + TSM1 files to another format for easier inspection and debugging. +v2.0/tags: [wal, inspect] +menu: + v2_0_ref: + parent: influxd inspect +weight: 301 +--- + +The `influxd inspect export-blocks` command exports all blocks in one or more +TSM1 files to another format for easier inspection and debugging. + +## Usage +```sh +influxd inspect export-blocks [flags] +``` + +## Flags +| Flag | Description | +|:---- |:----------- | +| `-h`, `--help` | Help for `export-blocks`. | diff --git a/content/v2.0/reference/cli/influxd/inspect/verify-tsm.md b/content/v2.0/reference/cli/influxd/inspect/verify-tsm.md new file mode 100644 index 000000000..cd8ad2f4b --- /dev/null +++ b/content/v2.0/reference/cli/influxd/inspect/verify-tsm.md @@ -0,0 +1,34 @@ +--- +title: influxd inspect verify-tsm +description: > + The `influxd inspect verify-tsm` command analyzes a set of TSM files for inconsistencies + between the TSM index and the blocks. +v2.0/tags: [wal, inspect] +menu: + v2_0_ref: + parent: influxd inspect +weight: 301 +--- + +The `influxd inspect verify-tsm` command analyzes a set of TSM files for inconsistencies +between the TSM index and the blocks. It performs the following checks: + +- Ensures CRC-32 checksums match for each block. +- Ensures the minimum and maximum timestamps in the TSM index match the decoded data. + +## Usage +```sh +influxd inspect verify-tsm ... [flags] +``` + +## Arguments + +### pathspec +A list of files or directories in which to search for TSM files. + +## Flags +| Flag | Description | Input Type | +|:---- |:----------- |:----------:| +| `--bucket-id` | Limit analysis to a specific bucket ID. _Optional._ | string | +| `-h`, `--help` | Help for `verify-tsm`. | | +| `--org-id` | Limit analysis to a specific organization ID. _Optional._ | string | diff --git a/content/v2.0/reference/cli/influxd/inspect/verify-wal.md b/content/v2.0/reference/cli/influxd/inspect/verify-wal.md index db3cd524a..815ff481c 100644 --- a/content/v2.0/reference/cli/influxd/inspect/verify-wal.md +++ b/content/v2.0/reference/cli/influxd/inspect/verify-wal.md @@ -10,7 +10,7 @@ menu: weight: 301 --- -The `influxd inspect verify-wal` command analyze the Write-Ahead Log (WAL) +The `influxd inspect verify-wal` command analyzes the Write-Ahead Log (WAL) to check if there are any corrupt files. If it finds corrupt files, the command returns the names of those files. It also returns the total number of entries in each scanned WAL file.