|
| 1 | +--- |
| 2 | +title: Command line flags |
| 3 | +menuTitle: Command line flags |
| 4 | +description: Reference for Tempo command line flags |
| 5 | +weight: 650 |
| 6 | +--- |
| 7 | + |
| 8 | +# Command line flags |
| 9 | + |
| 10 | +Tempo provides various command-line flags to configure its behavior when starting the binary. This document serves as a reference for these flags. |
| 11 | + |
| 12 | +## Global flags |
| 13 | + |
| 14 | +| Flag | Description | Default | |
| 15 | +| --- | --- | --- | |
| 16 | +| `--version` | Print this build's version information and exit | `false` | |
| 17 | +| `--mem-ballast-size-mbs` | Size of memory ballast to allocate in MBs | `0` | |
| 18 | +| `--mutex-profile-fraction` | Override default mutex profiling fraction | `0` | |
| 19 | +| `--block-profile-threshold` | Override default block profiling threshold | `0` | |
| 20 | +| `--config.file` | Configuration file to load | | |
| 21 | +| `--config.expand-env` | Whether to expand environment variables in config file | `false` | |
| 22 | +| `--config.verify` | Verify configuration and exit | `false` | |
| 23 | + |
| 24 | +## Target flag |
| 25 | + |
| 26 | +| Flag | Description | Default | |
| 27 | +| --- | --- | --- | |
| 28 | +| `--target` | Target module to run | `all` | |
| 29 | + |
| 30 | +## Authentication and multitenancy |
| 31 | + |
| 32 | +| Flag | Description | Default | |
| 33 | +| --- | --- | --- | |
| 34 | +| `--auth.enabled` | Set to true to enable auth (deprecated: use multitenancy.enabled) | `false` | |
| 35 | +| `--multitenancy.enabled` | Set to true to enable multitenancy | `false` | |
| 36 | + |
| 37 | +## HTTP and API settings |
| 38 | + |
| 39 | +| Flag | Description | Default | |
| 40 | +| --- | --- | --- | |
| 41 | +| `--http-api-prefix` | String prefix for all HTTP API endpoints | `""` | |
| 42 | +| `--enable-go-runtime-metrics` | Set to true to enable all Go runtime metrics | `false` | |
| 43 | +| `--shutdown-delay` | How long to wait between SIGTERM and shutdown | `0` | |
| 44 | + |
| 45 | +## Server settings |
| 46 | + |
| 47 | +| Flag | Description | Default | |
| 48 | +| --- | --- | --- | |
| 49 | +| `--server.http-listen-port` | HTTP server listen port | `80` | |
| 50 | +| `--server.grpc-listen-port` | gRPC server listen port | `9095` | |
| 51 | + |
| 52 | +## Memberlist settings |
| 53 | + |
| 54 | +| Flag | Description | Default | |
| 55 | +| --- | --- | --- | |
| 56 | +| `--memberlist.host-port` | Host port to connect to memberlist cluster | | |
| 57 | +| `--memberlist.bind-port` | Port for memberlist to communicate on | `7946` | |
| 58 | +| `--memberlist.message-history-buffer-bytes` | Size in bytes for the message history buffer | `0` | |
| 59 | + |
| 60 | +## Module configuration |
| 61 | + |
| 62 | +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. |
| 63 | + |
| 64 | +Use the configuration file approach described in the [Configuration documentation](../configuration/). |
| 65 | +The documentation has a comprehensive list of all configuration options. |
| 66 | + |
| 67 | +## Usage examples |
| 68 | + |
| 69 | +Start Tempo with a configuration file: |
| 70 | + |
| 71 | +```bash |
| 72 | +tempo --config.file=/etc/tempo/config.yaml |
| 73 | +``` |
| 74 | + |
| 75 | +Start Tempo with a specific target: |
| 76 | + |
| 77 | +```bash |
| 78 | +tempo --target=distributor --config.file=/etc/tempo/config.yaml |
| 79 | +``` |
| 80 | + |
| 81 | +Verify configuration without starting Tempo: |
| 82 | + |
| 83 | +```bash |
| 84 | +tempo --config.file=/etc/tempo/config.yaml --config.verify |
| 85 | +``` |
| 86 | + |
| 87 | +Print version information: |
| 88 | + |
| 89 | +```bash |
| 90 | +tempo --version |
| 91 | +``` |
| 92 | + |
0 commit comments