Menu
Open source

Tempo CLI

Tempo CLI is a separate executable that contains utility functions related to the Tempo software. Although it is not required for a working installation, Tempo CLI can be helpful for deeper analysis or for troubleshooting.

Tempo CLI command syntax

The general syntax for commands in Tempo CLI is:

bash
tempo-cli command [subcommand] [options] [arguments...]

--help or -h displays the help for a command or subcommand.

Example:

bash
tempo-cli -h
tempo-cli command [subcommand] -h

Run Tempo CLI

Tempo CLI is currently available as source code. A working Go installation is required to build it. It can be compiled to a native binary and executed normally, or it can be executed using the go run command. It can be packaged as a Docker container using make docker-tempo-cli.

Example:

bash
./tempo-cli [arguments...]
go run ./cmd/tempo-cli [arguments...]
bash
make docker-tempo-cli
docker run docker.io/grafana/tempo-cli [arguments...]

Backend options

Tempo CLI connects directly to the storage backend for some commands, meaning that it requires the ability to read from S3, GCS, Azure or file-system storage. The backend can be configured in a few ways:

  • Load an existing tempo configuration file using the --config-file (-c) option. This is the recommended option for frequent usage. Refer to Configuration documentation for more information.
  • Specify individual settings:
    • --backend <value> The storage backend type, one of s3, gcs, azure, and local.
    • --bucket <value> The bucket name. The meaning of this value is backend-specific. Refer to Configuration documentation for more information.
    • --s3-endpoint <value> The S3 API endpoint (i.e. s3.dualstack.us-east-2.amazonaws.com).
    • --s3-user <value>, --s3-password <value> The S3 user name and password (or access key and secret key). Optional, as Tempo CLI supports the same authentication mechanisms as Tempo. See S3 permissions documentation for more information.

Each option applies only to the command in which it is used. For example, --backend <value> does not permanently change where Tempo stores data. It only changes it for command in which you apply the option.

Query API command

Trace ID

Call the Tempo API and retrieve a trace by ID.

bash
tempo-cli query api trace-id <api-endpoint> <trace-id>

Arguments:

  • api-endpoint URL for tempo API.
  • trace-id Trace ID as a hexadecimal string.

Options:

  • --org-id <value> Organization ID (for use in multi-tenant setup).

Example:

bash
tempo-cli query api trace-id http://tempo:3200 f1cfe82a8eef933b

Call the Tempo API and search using TraceQL.

bash
tempo-cli query api search <host-port> <trace-ql> <start> <end>

Arguments:

  • host-port A host/port combination for Tempo. The scheme will be inferred based on the options provided.
  • trace-ql TraceQL query.
  • start Start of the time range to search: (YYYY-MM-DDThh:mm:ss)
  • end End of the time range to search: (YYYY-MM-DDThh:mm:ss)

Options:

  • --org-id <value> Organization ID (for use in multi-tenant setup).
  • --use-grpc Use GRPC streaming
  • --use-ws Use HTTP/Websocket streaming
  • --spss <value> Number of spans to return for each spanset
  • --limit <value> Number of results to return
  • --path-prefix <value> String to prefix search paths with

Note

Streaming over HTTP requires the stream_over_http_enabled flag to be set. For more information, refer to Tempo GRPC API documentation.

Query blocks command

Iterate over all backend blocks and dump all data found for a given trace id.

bash
tempo-cli query blocks <trace-id> <tenant-id>

Note

This can be intense as it downloads every bloom filter and some percentage of indexes/trace data.

Arguments:

  • trace-id Trace ID as a hexadecimal string.
  • tenant-id Tenant to search.

Options: See backend options above.

Example:

bash
tempo-cli query blocks f1cfe82a8eef933b single-tenant

Query trace summary command

Iterate over all backend blocks and dump a summary for a given trace id.

The summary includes:

  • number of blocks the trace is found in
  • span count
  • trace size
  • trace duration
  • root service name
  • root span info
  • top frequent service names
bash
tempo-cli query trace-summary <trace-id> <tenant-id>

Note: can be intense as it downloads every bloom filter and some percentage of indexes/trace data.

Arguments:

  • trace-id Trace ID as a hexadecimal string.
  • tenant-id Tenant to search.

Options: See backend options above.

Example:

bash
tempo-cli query trace-summary f1cfe82a8eef933b single-tenant

List blocks

Lists information about all blocks for the given tenant, and optionally perform integrity checks on indexes for duplicate records.

bash
tempo-cli list blocks <tenant-id>

Arguments:

  • tenant-id The tenant ID. Use single-tenant for single tenant setups.

Options:

  • --include-compacted Include blocks that have been compacted. Default behavior is to display only active blocks.

Output: Explanation of output:

  • ID Block ID.
  • Lvl Compaction level of the block.
  • Objects Number of objects stored in the block.
  • Size Data size of the block after any compression.
  • Encoding Block encoding (compression algorithm).
  • Vers Block version.
  • Window The window of time that was considered for compaction purposes.
  • Start The earliest timestamp stored in the block.
  • End The latest timestamp stored in the block.
  • DurationDuration between the start and end time.
  • Age The age of the block.
  • Cmp Whether the block has been compacted (present when –include-compacted is specified).

Example:

bash
tempo-cli list blocks -c ./tempo.yaml single-tenant

List block

Lists information about a single block, and optionally, scan its contents.

bash
tempo-cli list block <tenant-id> <block-id>

Arguments:

  • tenant-id The tenant ID. Use single-tenant for single tenant setups.
  • block-id The block ID as UUID string.

Options:

  • --scan Also load the block data, perform integrity check for duplicates, and collect statistics. Note: can be intense.

Example:

bash
tempo-cli list block -c ./tempo.yaml single-tenant ca314fba-efec-4852-ba3f-8d2b0bbf69f1

List compaction summary

Summarizes information about all blocks for the given tenant based on compaction level. This command is useful to analyze or troubleshoot compactor behavior.

bash
tempo-cli list compaction-summary <tenant-id>

Arguments:

  • tenant-id The tenant ID. Use single-tenant for single tenant setups.

Example:

bash
tempo-cli list compaction-summary -c ./tempo.yaml single-tenant

List cache summary

Prints information about the number of bloom filter shards per day per compaction level. This command is useful to estimate and fine-tune cache storage. Read the caching topic for more information.

bash
tempo-cli list cache-summary <tenant-id>

Arguments:

  • tenant-id The tenant ID. Use single-tenant for single tenant setups.

Example:

bash
tempo-cli list cache-summary -c ./tempo.yaml single-tenant

List index

Lists basic index info for the given block.

bash
tempo-cli list index <tenant-id> <block-id>

Arguments:

  • tenant-id The tenant ID. Use single-tenant for single tenant setups.
  • block-id The block ID as UUID string.

Example:

bash
tempo-cli list index -c ./tempo.yaml single-tenant ca314fba-efec-4852-ba3f-8d2b0bbf69f1

View index

View the index contents for the given block.

bash
tempo-cli view index <tenant-id> <block-id>

Arguments:

  • tenant-id The tenant ID. Use single-tenant for single tenant setups.
  • block-id The block ID as UUID string.

Example:

bash
tempo-cli view index -c ./tempo.yaml single-tenant ca314fba-efec-4852-ba3f-8d2b0bbf69f1

Generate bloom filter

To generate the bloom filter for a block if the files were deleted/corrupted.

Note: ensure that the block is in a local backend in the expected directory hierarchy, i.e. path / tenant / blocks.

Arguments:

  • tenant-id The tenant ID. Use single-tenant for single tenant setups.
  • block-id The block ID as UUID string.
  • bloom-fp The false positive to be used for the bloom filter.
  • bloom-shard-size The shard size to be used for the bloom filter.

Example:

bash
tempo-cli gen bloom --backend=local --bucket=./cmd/tempo-cli/test-data/ single-tenant b18beca6-4d7f-4464-9f72-f343e688a4a0 0.05 100000

The bloom filter will be generated at the required location under the block folder.

Generate index

To generate the index/bloom for a block if the files were deleted/corrupted.

Note: ensure that the block is in a local backend in the expected directory hierarchy, i.e. path / tenant / blocks.

Arguments:

  • tenant-id The tenant ID. Use single-tenant for single tenant setups.
  • block-id The block ID as UUID string.

Example:

bash
tempo-cli gen index --backend=local --bucket=./cmd/tempo-cli/test-data/ single-tenant b18beca6-4d7f-4464-9f72-f343e688a4a0

The index will be generated at the required location under the block folder.

Search blocks command

Search blocks in a given time range for a specific key/value pair.

bash
tempo-cli search blocks <name> <value> <start> <end> <tenant-id>

Note: can be intense as it downloads all relevant blocks and iterates through them.

Arguments:

  • name Name of the attribute to search for e.g. http.post
  • value Value of the attribute to search for e.g. GET
  • start Start of the time range to search: (YYYY-MM-DDThh:mm:ss)
  • end End of the time range to search: (YYYY-MM-DDThh:mm:ss)
  • tenant-id Tenant to search.

Options: See backend options above.

Example:

bash
tempo-cli search blocks http.post GET 2021-09-21T00:00:00 2021-09-21T00:05:00 single-tenant --backend=gcs --bucket=tempo-trace-data

Parquet convert command

Converts a parquet file from its existing schema to the one currently in the repository. This utility command is useful when attempting to determine the impact of changing compression or encoding of columns.

bash
tempo-cli parquet convert <in file> <out file>

Arguments:

  • in file Filename of an existing parquet file containing Tempo trace data
  • out file File to write to. (Existing file is overwritten.)

Example:

bash
tempo-cli parquet convert data.parquet out.parquet

Parquet convert 2 to 3 command

Converts a vParquet2 file (actual data.parquet) to a vParquet3 block with an optional list of dedicated attribute columns. This utility command is useful when testing the impact of different combinations of dedicated columns. Currently, all listed columns are assumed to be at the span scope.

bash
tempo-cli parquet convert-2-to-3 <in file> <out path> <list of dedicated columns>

Arguments:

  • in file Filename of an existing vParquet2 file containing Tempo trace data
  • out path Path to write the vParquet3 block to.
  • list of dedicated columns Additional params indicating which columns to make dedicated. Max 10. Dedicated columns should be named using TraceQL syntax with scope. i.e. span.db.statement or resource.namespace.

Example:

bash
tempo-cli parquet convert-2-to-3 data.parquet ./out db.statement db.name

Migrate tenant command

Copy blocks from one backend and tenant to another. Blocks can be copied within the same backend or between two different backends. Data format will not be converted but tenant ID in meta.json will be rewritten.

bash
tempo-cli migrate tenant <source tenant> <dest tenant>

Arguments:

  • source tenant Tenant to copy blocks from
  • dest tenant Tenant to copy blocks into

Options:

  • --source-config-file <value> Configuration file for the source backend
  • --config-file <value> Configuration file for the destination backend

Example:

bash
tempo-cli migrate tenant --source-config source.yaml --config-file dest.yaml my-tenant my-other-tenant

Migrate overrides config command

Migrate overrides config from inline format (legacy) to idented YAML format (new).

bash
tempo-cli migrate overrides-config <source config file>

Arguments:

  • source config file Configuration file to migrate

Options:

  • --config-dest <value> Destination file for the migrated config. If not specified, config is printed to stdout.
  • --overrides-dest <value> Destination file for the migrated overrides. If not specified, overrides are printed to stdout.

Example:

bash
tempo-cli migrate overrides-config config.yaml --config-dest config-tmp.yaml --overrides-dest overrides-tmp.yaml

Analyse block

Analyses a block and outputs a summary of the block’s generic attributes. It’s of particular use when trying to determine candidates for dedicated attribute columns in vParquet3.

Arguments:

  • tenant-id The tenant ID. Use single-tenant for single tenant setups.
  • block-id The block ID as UUID string.

Options:

  • Backend options
  • --num-attr <value> Number of attributes to output (default: 10)

Example:

bash
tempo-cli analyse block --backend=local --bucket=./cmd/tempo-cli/test-data/ single-tenant b18beca6-4d7f-4464-9f72-f343e688a4a0

Analyse blocks

Analyses all blocks in a given time range and outputs a summary of the blocks’ generic attributes. It’s of particular use when trying to determine candidates for dedicated attribute columns in vParquet3.

Arguments:

  • tenant-id The tenant ID. Use single-tenant for single-tenant setups.

Options:

  • Backend options
  • --num-attr <value> Number of attributes to output (default: 10)
  • --min-compaction-level <value> Minimum compaction level to include in the analysis (default: 3)
  • --max-blocks <value> Maximum number of blocks to analyze (default: 10)

Example:

bash
tempo-cli analyse blocks --backend=local --bucket=./cmd/tempo-cli/test-data/ single-tenant