Documentation

influxd inspect report-tsm

This page documents an earlier version of InfluxDB OSS. InfluxDB 3 Core is the latest stable version.

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 reports on the index within each TSM 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

influxd inspect report-tsm [flags]

Output details

influxd inspect report-tsm outputs the following for each TSM 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

FlagDescriptionInput Type
--data-pathPath to data directory (defaults to ~/.influxdbv2/engine/data).string
--detailedEmit series cardinality segmented by measurements, tag keys, and fields. May take a while.
--exactCalculate an exact cardinality count. May use significant memory.
-h--helpHelp for the report-tsm command.
--patternOnly process TSM files containing pattern.string

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

New in InfluxDB 3.2

Key enhancements in InfluxDB 3.2 and the InfluxDB 3 Explorer UI is now generally available.

See the Blog Post

InfluxDB 3.2 is now available for both Core and Enterprise, bringing the general availability of InfluxDB 3 Explorer, a new UI that simplifies how you query, explore, and visualize data. On top of that, InfluxDB 3.2 includes a wide range of performance improvements, feature updates, and bug fixes including automated data retention and more.

For more information, check out: