Files
d1df5c56ca Improve information architecture for Tempo docs (#5463)
* Migrate changes from Tempo PR

Signed-off-by: Jack Baldry <[email protected]>

* Updates to resolve conflicts

* Move getting started files

* Fix aliases

* Merge remote-tracking branch 'origin/master' into jdb/2025-07-tempo-set-up-restructure

Signed-off-by: Jack Baldry <[email protected]>

* Discard changes to content/docs/tempo/next/sync.json

* Add aliases

Signed-off-by: Jack Baldry <[email protected]>

* Fix some aliases

Signed-off-by: Jack Baldry <[email protected]>

* Updates from rebase

* Apply suggestions from code review

Co-authored-by: Jack Baldry <[email protected]>

* Apply suggestions from code review

Co-authored-by: Jack Baldry <[email protected]>

* Update content/docs/tempo/next/set-up-for-tracing/instrument-send/set-up-collector/tail-sampling/policies-strategies.md

Co-authored-by: Jack Baldry <[email protected]>

* Fix links on tile page and test page

* Fix links and update missing content

* Fix links

* Fix links

* Fix links and collector text

* Updates from Alex's feedback

* Link fixes

* Fix links in deploy

* Fix links

* More link fixes

* Fix yet more links

* Fix more links

* Apply suggestions from code review

Co-authored-by: Jack Baldry <[email protected]>

* Update content/docs/tempo/next/set-up-for-tracing/setup-tempo/test/set-up-test-app.md

* Update content/docs/tempo/next/set-up-for-tracing/setup-tempo/test/set-up-test-app.md

* Apply suggestions from code review

* Add deploy preview workflow

Signed-off-by: Jack Baldry <[email protected]>

* Updates for Tiffany's suggested edits

* Update manifest according to PR instructions

---------

Signed-off-by: Jack Baldry <[email protected]>
Co-authored-by: Kim Nylander <[email protected]>
2025-07-31 19:50:31 +05:30

3.4 KiB

title, menuTitle, description, weight, aliases
title menuTitle description weight aliases
Command line flags Command line flags Reference for Tempo command line flags 900
../../setup/command-line-flags/

Command line flags

Tempo provides various command-line flags to configure its behavior when starting the binary. This document serves as a reference for these flags.

Global flags

Flag Description Default
--version Print this build's version information and exit false
--mem-ballast-size-mbs Size of memory ballast to allocate in MBs 0
--mutex-profile-fraction Override default mutex profiling fraction 0
--block-profile-threshold Override default block profiling threshold 0
--config.file Configuration file to load
--config.expand-env Whether to expand environment variables in config file false
--config.verify Verify configuration and exit false

Target flag

The deployment mode is determined by the runtime configuration target, or by using the -target flag on the command line. The default target is all, which is the monolithic deployment mode.

Flag Description Default
--target Target module to run all

Refer to the Plan your Tempo deployment documentation for information on deployment modes.

Authentication and multitenancy

Flag Description Default
--auth.enabled Set to true to enable auth (deprecated: use multitenancy.enabled) false
--multitenancy.enabled Set to true to enable multitenancy false

HTTP and API settings

Flag Description Default
--http-api-prefix String prefix for all HTTP API endpoints ""
--enable-go-runtime-metrics Set to true to enable all Go runtime metrics false
--shutdown-delay How long to wait between SIGTERM and shutdown 0

Server settings

Flag Description Default
--server.http-listen-port HTTP server listen port 80
--server.grpc-listen-port gRPC server listen port 9095

Memberlist settings

Flag Description Default
--memberlist.host-port Host port to connect to memberlist cluster
--memberlist.bind-port Port for memberlist to communicate on 7946
--memberlist.message-history-buffer-bytes Size in bytes for the message history buffer 0

Module configuration

You can use additional flags to configuring individual Tempo modules, such as the distributor, ingester, querier, and their components. These flags follow a pattern like --<module>.<setting> and are extensively documented in the configuration file format.

Use the configuration file approach described in the Configuration documentation. The documentation has a comprehensive list of all configuration options.

Usage examples

Start Tempo with a configuration file:

tempo --config.file=/etc/tempo/config.yaml

Start Tempo with a specific target:

tempo --target=distributor --config.file=/etc/tempo/config.yaml

Verify configuration without starting Tempo:

tempo --config.file=/etc/tempo/config.yaml --config.verify

Print version information:

tempo --version