We stand with our friends and colleagues in Ukraine.
To support Ukraine in their time of need
CLI flags
This is auto-generated documentation for CLI flags supported by Jaeger binaries.
- CLI flags for some binaries change depending on the
SPAN_STORAGE_TYPEenvironment variable. Relevant variations are included below. - Some binaries support commands (mostly informational), such as
env,docs,version, andstatus. These commands are not included here. - All parameters can be provided via environment variables, by changing all letters to upper-case and replacing all punctuation characters with the underscore
_. For example, the value for the flag--cassandra.connections-per-hostcan be provided via theCASSANDRA_CONNECTIONS_PER_HOSTenvironment variable.
The CLI flags for the following binaries are documented below:
jaeger-all-in-one
Jaeger all-in-one distribution with collector and query. Use with caution: this version by default uses only in-memory database.
jaeger-all-in-one can be used with these storage backends:
- jaeger-all-in-one with
cassandra - jaeger-all-in-one with
elasticsearch - jaeger-all-in-one with
memory - jaeger-all-in-one with
badger
(Experimental) jaeger-all-in-one can be used with these metrics storage types:
jaeger-all-in-one with cassandra storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14269 |
| The host:port (e.g. 127.0.0.1:14269 or :14269) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--cassandra-archive.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra-archive.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra-archive.connections-per-host | 0 |
| The number of Cassandra connections from a single backend instance | |
--cassandra-archive.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra-archive.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra-archive.enabled | false |
| Enable extra storage | |
--cassandra-archive.keyspace | |
| The Cassandra keyspace for Jaeger data | |
--cassandra-archive.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra-archive.max-retry-attempts | 0 |
| The number of attempts when reading from Cassandra | |
--cassandra-archive.password | |
| Password for password authentication for Cassandra | |
--cassandra-archive.port | 0 |
| The port for cassandra | |
--cassandra-archive.proto-version | 0 |
| The Cassandra protocol version | |
--cassandra-archive.reconnect-interval | 0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra-archive.servers | |
| The comma-separated list of Cassandra servers | |
--cassandra-archive.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra-archive.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra-archive.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra-archive.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra-archive.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra-archive.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra-archive.username | |
| Username for password authentication for Cassandra | |
--cassandra.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra.connections-per-host | 2 |
| The number of Cassandra connections from a single backend instance | |
--cassandra.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra.index.logs | true |
| Controls log field indexing. Set to false to disable. | |
--cassandra.index.process-tags | true |
| Controls process tag indexing. Set to false to disable. | |
--cassandra.index.tag-blacklist | |
| The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option. | |
--cassandra.index.tag-whitelist | |
| The comma-separated list of span tags to whitelist for being indexed. All other tags will not be indexed. Mutually exclusive with the blacklist option. | |
--cassandra.index.tags | true |
| Controls tag indexing. Set to false to disable. | |
--cassandra.keyspace | jaeger_dc1 |
| The Cassandra keyspace for Jaeger data | |
--cassandra.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra.max-retry-attempts | 3 |
| The number of attempts when reading from Cassandra | |
--cassandra.password | |
| Password for password authentication for Cassandra | |
--cassandra.port | 9042 |
| The port for cassandra | |
--cassandra.proto-version | 4 |
| The Cassandra protocol version | |
--cassandra.reconnect-interval | 1m0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra.servers | 127.0.0.1 |
| The comma-separated list of Cassandra servers | |
--cassandra.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra.span-store-write-cache-ttl | 12h0m0s |
| The duration to wait before rewriting an existing service or operation name | |
--cassandra.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra.username | |
| Username for password authentication for Cassandra | |
--collector.enable-span-size-metrics | false |
| Enables metrics based on processed span size, which are more expensive to calculate. | |
--collector.grpc-server.host-port | :14250 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.grpc-server.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http-server.host-port | :14268 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.http-server.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.num-workers | 50 |
| The number of workers pulling items from the queue | |
--collector.otlp.enabled | true |
| Enables OpenTelemetry OTLP receiver on dedicated HTTP and gRPC ports | |
--collector.otlp.grpc.host-port | :4317 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.otlp.grpc.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.otlp.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.otlp.http.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.otlp.http.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.otlp.http.host-port | :4318 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.otlp.http.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.queue-size | 2000 |
| The queue size of the collector | |
--collector.queue-size-memory | 0 |
| (experimental) The max memory size in MiB to use for the dynamic queue. | |
--collector.tags | |
| One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue} | |
--collector.zipkin.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.zipkin.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.zipkin.host-port | |
| The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's Zipkin server (disabled by default) | |
--collector.zipkin.keep-alive | true |
| KeepAlive configures allow Keep-Alive for Zipkin HTTP server (enabled by default) | |
--collector.zipkin.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.zipkin.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.zipkin.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.zipkin.tls.enabled | false |
| Enable TLS on the server | |
--collector.zipkin.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.zipkin.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.zipkin.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--help | false |
| help for jaeger-all-in-one | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--query.additional-headers | [] |
| Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value" | |
--query.base-path | / |
| The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy. See https://github.com/jaegertracing/jaeger/blob/main/examples/reverse-proxy/README.md | |
--query.bearer-token-propagation | false |
| Allow propagation of bearer token to be used by storage plugins | |
--query.enable-tracing | false |
| Enables emitting jaeger-query traces | |
--query.grpc-server.host-port | :16685 |
| The host:port (e.g. 127.0.0.1:14250 or :14250) of the query's gRPC server | |
--query.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.grpc.tls.enabled | false |
| Enable TLS on the server | |
--query.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http-server.host-port | :16686 |
| The host:port (e.g. 127.0.0.1:14268 or :14268) of the query's HTTP server | |
--query.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.http.tls.enabled | false |
| Enable TLS on the server | |
--query.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.log-static-assets-access | false |
| Log when static assets are accessed (for debugging) | |
--query.max-clock-skew-adjustment | 0s |
| The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments | |
--query.static-files | |
| The directory path override for the static assets for the UI | |
--query.ui-config | |
| The path to the UI configuration file in JSON format | |
--sampling.strategies-file | |
| The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file | |
--sampling.strategies-reload-interval | 0s |
| Reload interval to check and reload sampling strategies file. Zero value means no reloading | |
--sampling.strategies.bugfix-5270 | false |
| Include default operation level strategies for Ratesampling type service level strategy. Cf. https://github.com/jaegertracing/jaeger/issues/5270 | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-all-in-one with elasticsearch storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14269 |
| The host:port (e.g. 127.0.0.1:14269 or :14269) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.enable-span-size-metrics | false |
| Enables metrics based on processed span size, which are more expensive to calculate. | |
--collector.grpc-server.host-port | :14250 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.grpc-server.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http-server.host-port | :14268 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.http-server.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.num-workers | 50 |
| The number of workers pulling items from the queue | |
--collector.otlp.enabled | true |
| Enables OpenTelemetry OTLP receiver on dedicated HTTP and gRPC ports | |
--collector.otlp.grpc.host-port | :4317 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.otlp.grpc.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.otlp.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.otlp.http.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.otlp.http.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.otlp.http.host-port | :4318 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.otlp.http.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.queue-size | 2000 |
| The queue size of the collector | |
--collector.queue-size-memory | 0 |
| (experimental) The max memory size in MiB to use for the dynamic queue. | |
--collector.tags | |
| One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue} | |
--collector.zipkin.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.zipkin.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.zipkin.host-port | |
| The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's Zipkin server (disabled by default) | |
--collector.zipkin.keep-alive | true |
| KeepAlive configures allow Keep-Alive for Zipkin HTTP server (enabled by default) | |
--collector.zipkin.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.zipkin.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.zipkin.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.zipkin.tls.enabled | false |
| Enable TLS on the server | |
--collector.zipkin.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.zipkin.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.zipkin.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--es-archive.adaptive-sampling.lookback | 72h0m0s |
| How far back to look for the latest adaptive sampling probabilities | |
--es-archive.bulk.actions | 1000 |
| The number of requests that can be enqueued before the bulk processor decides to commit | |
--es-archive.bulk.flush-interval | 200ms |
| A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled. | |
--es-archive.bulk.size | 5000000 |
| The number of bytes that the bulk requests can take up before the bulk processor decides to commit | |
--es-archive.bulk.workers | 1 |
| The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch | |
--es-archive.create-index-templates | true |
| Create index templates at application startup. Set to false when templates are installed manually. | |
--es-archive.enabled | false |
| Enable extra storage | |
--es-archive.index-date-separator | - |
| Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20". | |
--es-archive.index-prefix | |
| Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*". | |
--es-archive.index-rollover-frequency-adaptive-sampling | day |
| Rotates jaeger-sampling indices over the given period. For example "day" creates "jaeger-sampling-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.index-rollover-frequency-services | day |
| Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.index-rollover-frequency-spans | day |
| Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.log-level | error |
| The Elasticsearch client log-level. Valid levels: [debug, info, error] | |
--es-archive.max-doc-count | 10000 |
| The maximum document count to return from an Elasticsearch query. This will also apply to aggregations. | |
--es-archive.num-replicas | 1 |
| The number of replicas per index in Elasticsearch | |
--es-archive.num-shards | 5 |
| The number of shards per index in Elasticsearch | |
--es-archive.password | |
| The password required by Elasticsearch | |
--es-archive.password-file | |
| Path to a file containing password. This file is watched for changes. | |
--es-archive.prioirity-dependencies-template | 0 |
| Priority of jaeger-dependecies index template (ESv8 only) | |
--es-archive.prioirity-service-template | 0 |
| Priority of jaeger-service index template (ESv8 only) | |
--es-archive.prioirity-span-template | 0 |
| Priority of jaeger-span index template (ESv8 only) | |
--es-archive.remote-read-clusters | |
| Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api. | |
--es-archive.send-get-body-as | |
| HTTP verb for requests that contain a body [GET, POST]. | |
--es-archive.server-urls | http://127.0.0.1:9200 |
| The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200 | |
--es-archive.service-cache-ttl | 0s |
| The TTL for the cache of known service names | |
--es-archive.sniffer | false |
| The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required | |
--es-archive.sniffer-tls-enabled | false |
| Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default | |
--es-archive.tags-as-fields.all | false |
| (experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects. | |
--es-archive.tags-as-fields.config-file | |
| (experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include | |
--es-archive.tags-as-fields.dot-replacement | @ |
| (experimental) The character used to replace dots (".") in tag keys stored as object fields. | |
--es-archive.tags-as-fields.include | |
| (experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file | |
--es-archive.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--es-archive.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--es-archive.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--es-archive.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--es-archive.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--es-archive.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--es-archive.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--es-archive.token-file | |
| Path to a file containing bearer token. This flag also loads CA if it is specified. | |
--es-archive.use-aliases | false |
| Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times. | |
--es-archive.use-ilm | false |
| (experimental) Option to enable ILM for jaeger span & service indices. Use this option with es-archive.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+. | |
--es-archive.username | |
| The username required by Elasticsearch. The basic authentication also loads CA if it is specified. | |
--es-archive.version | 0 |
| The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch. | |
--es.adaptive-sampling.lookback | 72h0m0s |
| How far back to look for the latest adaptive sampling probabilities | |
--es.bulk.actions | 1000 |
| The number of requests that can be enqueued before the bulk processor decides to commit | |
--es.bulk.flush-interval | 200ms |
| A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled. | |
--es.bulk.size | 5000000 |
| The number of bytes that the bulk requests can take up before the bulk processor decides to commit | |
--es.bulk.workers | 1 |
| The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch | |
--es.create-index-templates | true |
| Create index templates at application startup. Set to false when templates are installed manually. | |
--es.index-date-separator | - |
| Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20". | |
--es.index-prefix | |
| Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*". | |
--es.index-rollover-frequency-adaptive-sampling | day |
| Rotates jaeger-sampling indices over the given period. For example "day" creates "jaeger-sampling-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.index-rollover-frequency-services | day |
| Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.index-rollover-frequency-spans | day |
| Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.log-level | error |
| The Elasticsearch client log-level. Valid levels: [debug, info, error] | |
--es.max-doc-count | 10000 |
| The maximum document count to return from an Elasticsearch query. This will also apply to aggregations. | |
--es.max-span-age | 72h0m0s |
| The maximum lookback for spans in Elasticsearch | |
--es.num-replicas | 1 |
| The number of replicas per index in Elasticsearch | |
--es.num-shards | 5 |
| The number of shards per index in Elasticsearch | |
--es.password | |
| The password required by Elasticsearch | |
--es.password-file | |
| Path to a file containing password. This file is watched for changes. | |
--es.prioirity-dependencies-template | 0 |
| Priority of jaeger-dependecies index template (ESv8 only) | |
--es.prioirity-service-template | 0 |
| Priority of jaeger-service index template (ESv8 only) | |
--es.prioirity-span-template | 0 |
| Priority of jaeger-span index template (ESv8 only) | |
--es.remote-read-clusters | |
| Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api. | |
--es.send-get-body-as | |
| HTTP verb for requests that contain a body [GET, POST]. | |
--es.server-urls | http://127.0.0.1:9200 |
| The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200 | |
--es.service-cache-ttl | 0s |
| The TTL for the cache of known service names | |
--es.sniffer | false |
| The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required | |
--es.sniffer-tls-enabled | false |
| Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default | |
--es.tags-as-fields.all | false |
| (experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects. | |
--es.tags-as-fields.config-file | |
| (experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include | |
--es.tags-as-fields.dot-replacement | @ |
| (experimental) The character used to replace dots (".") in tag keys stored as object fields. | |
--es.tags-as-fields.include | |
| (experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file | |
--es.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--es.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--es.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--es.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--es.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--es.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--es.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--es.token-file | |
| Path to a file containing bearer token. This flag also loads CA if it is specified. | |
--es.use-aliases | false |
| Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times. | |
--es.use-ilm | false |
| (experimental) Option to enable ILM for jaeger span & service indices. Use this option with es.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+. | |
--es.username | |
| The username required by Elasticsearch. The basic authentication also loads CA if it is specified. | |
--es.version | 0 |
| The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch. | |
--help | false |
| help for jaeger-all-in-one | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--query.additional-headers | [] |
| Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value" | |
--query.base-path | / |
| The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy. See https://github.com/jaegertracing/jaeger/blob/main/examples/reverse-proxy/README.md | |
--query.bearer-token-propagation | false |
| Allow propagation of bearer token to be used by storage plugins | |
--query.enable-tracing | false |
| Enables emitting jaeger-query traces | |
--query.grpc-server.host-port | :16685 |
| The host:port (e.g. 127.0.0.1:14250 or :14250) of the query's gRPC server | |
--query.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.grpc.tls.enabled | false |
| Enable TLS on the server | |
--query.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http-server.host-port | :16686 |
| The host:port (e.g. 127.0.0.1:14268 or :14268) of the query's HTTP server | |
--query.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.http.tls.enabled | false |
| Enable TLS on the server | |
--query.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.log-static-assets-access | false |
| Log when static assets are accessed (for debugging) | |
--query.max-clock-skew-adjustment | 0s |
| The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments | |
--query.static-files | |
| The directory path override for the static assets for the UI | |
--query.ui-config | |
| The path to the UI configuration file in JSON format | |
--sampling.strategies-file | |
| The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file | |
--sampling.strategies-reload-interval | 0s |
| Reload interval to check and reload sampling strategies file. Zero value means no reloading | |
--sampling.strategies.bugfix-5270 | false |
| Include default operation level strategies for Ratesampling type service level strategy. Cf. https://github.com/jaegertracing/jaeger/issues/5270 | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-all-in-one with memory storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14269 |
| The host:port (e.g. 127.0.0.1:14269 or :14269) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.enable-span-size-metrics | false |
| Enables metrics based on processed span size, which are more expensive to calculate. | |
--collector.grpc-server.host-port | :14250 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.grpc-server.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http-server.host-port | :14268 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.http-server.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.num-workers | 50 |
| The number of workers pulling items from the queue | |
--collector.otlp.enabled | true |
| Enables OpenTelemetry OTLP receiver on dedicated HTTP and gRPC ports | |
--collector.otlp.grpc.host-port | :4317 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.otlp.grpc.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.otlp.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.otlp.http.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.otlp.http.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.otlp.http.host-port | :4318 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.otlp.http.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.queue-size | 2000 |
| The queue size of the collector | |
--collector.queue-size-memory | 0 |
| (experimental) The max memory size in MiB to use for the dynamic queue. | |
--collector.tags | |
| One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue} | |
--collector.zipkin.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.zipkin.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.zipkin.host-port | |
| The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's Zipkin server (disabled by default) | |
--collector.zipkin.keep-alive | true |
| KeepAlive configures allow Keep-Alive for Zipkin HTTP server (enabled by default) | |
--collector.zipkin.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.zipkin.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.zipkin.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.zipkin.tls.enabled | false |
| Enable TLS on the server | |
--collector.zipkin.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.zipkin.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.zipkin.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--help | false |
| help for jaeger-all-in-one | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--memory.max-traces | 0 |
| The maximum amount of traces to store in memory. The default number of traces is unbounded. | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--query.additional-headers | [] |
| Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value" | |
--query.base-path | / |
| The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy. See https://github.com/jaegertracing/jaeger/blob/main/examples/reverse-proxy/README.md | |
--query.bearer-token-propagation | false |
| Allow propagation of bearer token to be used by storage plugins | |
--query.enable-tracing | false |
| Enables emitting jaeger-query traces | |
--query.grpc-server.host-port | :16685 |
| The host:port (e.g. 127.0.0.1:14250 or :14250) of the query's gRPC server | |
--query.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.grpc.tls.enabled | false |
| Enable TLS on the server | |
--query.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http-server.host-port | :16686 |
| The host:port (e.g. 127.0.0.1:14268 or :14268) of the query's HTTP server | |
--query.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.http.tls.enabled | false |
| Enable TLS on the server | |
--query.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.log-static-assets-access | false |
| Log when static assets are accessed (for debugging) | |
--query.max-clock-skew-adjustment | 0s |
| The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments | |
--query.static-files | |
| The directory path override for the static assets for the UI | |
--query.ui-config | |
| The path to the UI configuration file in JSON format | |
--sampling.strategies-file | |
| The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file | |
--sampling.strategies-reload-interval | 0s |
| Reload interval to check and reload sampling strategies file. Zero value means no reloading | |
--sampling.strategies.bugfix-5270 | false |
| Include default operation level strategies for Ratesampling type service level strategy. Cf. https://github.com/jaegertracing/jaeger/issues/5270 | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-all-in-one with badger storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14269 |
| The host:port (e.g. 127.0.0.1:14269 or :14269) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--badger.consistency | false |
| If all writes should be synced immediately to physical disk. This will impact write performance. | |
--badger.directory-key | /go/bin/data/keys |
| Path to store the keys (indexes), this directory should reside in SSD disk. Set ephemeral to false if you want to define this setting. | |
--badger.directory-value | /go/bin/data/values |
| Path to store the values (spans). Set ephemeral to false if you want to define this setting. | |
--badger.ephemeral | true |
| Mark this storage ephemeral, data is stored in tmpfs. | |
--badger.maintenance-interval | 5m0s |
| How often the maintenance thread for values is ran. Format is time.Duration (https://golang.org/pkg/time/#Duration) | |
--badger.metrics-update-interval | 10s |
| How often the badger metrics are collected by Jaeger. Format is time.Duration (https://golang.org/pkg/time/#Duration) | |
--badger.read-only | false |
| Allows to open badger database in read only mode. Multiple instances can open same database in read-only mode. Values still in the write-ahead-log must be replayed before opening. | |
--badger.span-store-ttl | 72h0m0s |
| How long to store the data. Format is time.Duration (https://golang.org/pkg/time/#Duration) | |
--collector.enable-span-size-metrics | false |
| Enables metrics based on processed span size, which are more expensive to calculate. | |
--collector.grpc-server.host-port | :14250 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.grpc-server.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http-server.host-port | :14268 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.http-server.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.num-workers | 50 |
| The number of workers pulling items from the queue | |
--collector.otlp.enabled | true |
| Enables OpenTelemetry OTLP receiver on dedicated HTTP and gRPC ports | |
--collector.otlp.grpc.host-port | :4317 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.otlp.grpc.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.otlp.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.otlp.http.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.otlp.http.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.otlp.http.host-port | :4318 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.otlp.http.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.queue-size | 2000 |
| The queue size of the collector | |
--collector.queue-size-memory | 0 |
| (experimental) The max memory size in MiB to use for the dynamic queue. | |
--collector.tags | |
| One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue} | |
--collector.zipkin.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.zipkin.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.zipkin.host-port | |
| The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's Zipkin server (disabled by default) | |
--collector.zipkin.keep-alive | true |
| KeepAlive configures allow Keep-Alive for Zipkin HTTP server (enabled by default) | |
--collector.zipkin.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.zipkin.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.zipkin.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.zipkin.tls.enabled | false |
| Enable TLS on the server | |
--collector.zipkin.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.zipkin.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.zipkin.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--help | false |
| help for jaeger-all-in-one | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--query.additional-headers | [] |
| Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value" | |
--query.base-path | / |
| The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy. See https://github.com/jaegertracing/jaeger/blob/main/examples/reverse-proxy/README.md | |
--query.bearer-token-propagation | false |
| Allow propagation of bearer token to be used by storage plugins | |
--query.enable-tracing | false |
| Enables emitting jaeger-query traces | |
--query.grpc-server.host-port | :16685 |
| The host:port (e.g. 127.0.0.1:14250 or :14250) of the query's gRPC server | |
--query.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.grpc.tls.enabled | false |
| Enable TLS on the server | |
--query.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http-server.host-port | :16686 |
| The host:port (e.g. 127.0.0.1:14268 or :14268) of the query's HTTP server | |
--query.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.http.tls.enabled | false |
| Enable TLS on the server | |
--query.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.log-static-assets-access | false |
| Log when static assets are accessed (for debugging) | |
--query.max-clock-skew-adjustment | 0s |
| The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments | |
--query.static-files | |
| The directory path override for the static assets for the UI | |
--query.ui-config | |
| The path to the UI configuration file in JSON format | |
--sampling.strategies-file | |
| The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file | |
--sampling.strategies-reload-interval | 0s |
| Reload interval to check and reload sampling strategies file. Zero value means no reloading | |
--sampling.strategies.bugfix-5270 | false |
| Include default operation level strategies for Ratesampling type service level strategy. Cf. https://github.com/jaegertracing/jaeger/issues/5270 | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-all-in-one with prometheus metrics storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14269 |
| The host:port (e.g. 127.0.0.1:14269 or :14269) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.enable-span-size-metrics | false |
| Enables metrics based on processed span size, which are more expensive to calculate. | |
--collector.grpc-server.host-port | :14250 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.grpc-server.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http-server.host-port | :14268 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.http-server.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.num-workers | 50 |
| The number of workers pulling items from the queue | |
--collector.otlp.enabled | true |
| Enables OpenTelemetry OTLP receiver on dedicated HTTP and gRPC ports | |
--collector.otlp.grpc.host-port | :4317 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.otlp.grpc.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.otlp.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.otlp.http.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.otlp.http.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.otlp.http.host-port | :4318 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.otlp.http.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.queue-size | 2000 |
| The queue size of the collector | |
--collector.queue-size-memory | 0 |
| (experimental) The max memory size in MiB to use for the dynamic queue. | |
--collector.tags | |
| One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue} | |
--collector.zipkin.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.zipkin.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.zipkin.host-port | |
| The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's Zipkin server (disabled by default) | |
--collector.zipkin.keep-alive | true |
| KeepAlive configures allow Keep-Alive for Zipkin HTTP server (enabled by default) | |
--collector.zipkin.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.zipkin.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.zipkin.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.zipkin.tls.enabled | false |
| Enable TLS on the server | |
--collector.zipkin.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.zipkin.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.zipkin.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--help | false |
| help for jaeger-all-in-one | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--memory.max-traces | 0 |
| The maximum amount of traces to store in memory. The default number of traces is unbounded. | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--prometheus.connect-timeout | 30s |
| The period to wait for a connection to Prometheus when executing queries. | |
--prometheus.query.duration-unit | ms |
| The units used for the "latency" histogram. It can be either "ms" or "s" and should be consistent with the histogram unit value set in the spanmetrics connector (see: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/connector/spanmetricsconnector#configurations). This also helps jaeger-query determine the metric name when querying for "latency" metrics. | |
--prometheus.query.namespace | traces_span_metrics |
| The metric namespace that is prefixed to the metric name. A '.' separator will be added between the namespace and the metric name. | |
--prometheus.query.normalize-calls | false |
| Whether to normalize the "calls" metric name according to https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/translator/prometheus/README.md. For example: "calls" (not normalized) -> "calls_total" (normalized), | |
--prometheus.query.normalize-duration | false |
| Whether to normalize the "duration" metric name according to https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/translator/prometheus/README.md. For example: "duration_bucket" (not normalized) -> "duration_milliseconds_bucket (normalized)" | |
--prometheus.server-url | http://localhost:9090 |
| The Prometheus server's URL, must include the protocol scheme e.g. http://localhost:9090 | |
--prometheus.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--prometheus.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--prometheus.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--prometheus.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--prometheus.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--prometheus.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--prometheus.token-file | |
| The path to a file containing the bearer token which will be included when executing queries against the Prometheus API. | |
--prometheus.token-override-from-context | true |
| Whether the bearer token should be overridden from context (incoming request) | |
--query.additional-headers | [] |
| Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value" | |
--query.base-path | / |
| The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy. See https://github.com/jaegertracing/jaeger/blob/main/examples/reverse-proxy/README.md | |
--query.bearer-token-propagation | false |
| Allow propagation of bearer token to be used by storage plugins | |
--query.enable-tracing | false |
| Enables emitting jaeger-query traces | |
--query.grpc-server.host-port | :16685 |
| The host:port (e.g. 127.0.0.1:14250 or :14250) of the query's gRPC server | |
--query.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.grpc.tls.enabled | false |
| Enable TLS on the server | |
--query.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http-server.host-port | :16686 |
| The host:port (e.g. 127.0.0.1:14268 or :14268) of the query's HTTP server | |
--query.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.http.tls.enabled | false |
| Enable TLS on the server | |
--query.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.log-static-assets-access | false |
| Log when static assets are accessed (for debugging) | |
--query.max-clock-skew-adjustment | 0s |
| The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments | |
--query.static-files | |
| The directory path override for the static assets for the UI | |
--query.ui-config | |
| The path to the UI configuration file in JSON format | |
--sampling.strategies-file | |
| The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file | |
--sampling.strategies-reload-interval | 0s |
| Reload interval to check and reload sampling strategies file. Zero value means no reloading | |
--sampling.strategies.bugfix-5270 | false |
| Include default operation level strategies for Ratesampling type service level strategy. Cf. https://github.com/jaegertracing/jaeger/issues/5270 | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-collector
Jaeger collector receives traces and runs them through a processing pipeline.
jaeger-collector can be used with these storage backends:
jaeger-collector can be used with these sampling types:
jaeger-collector with cassandra storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14269 |
| The host:port (e.g. 127.0.0.1:14269 or :14269) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--cassandra-archive.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra-archive.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra-archive.connections-per-host | 0 |
| The number of Cassandra connections from a single backend instance | |
--cassandra-archive.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra-archive.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra-archive.enabled | false |
| Enable extra storage | |
--cassandra-archive.keyspace | |
| The Cassandra keyspace for Jaeger data | |
--cassandra-archive.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra-archive.max-retry-attempts | 0 |
| The number of attempts when reading from Cassandra | |
--cassandra-archive.password | |
| Password for password authentication for Cassandra | |
--cassandra-archive.port | 0 |
| The port for cassandra | |
--cassandra-archive.proto-version | 0 |
| The Cassandra protocol version | |
--cassandra-archive.reconnect-interval | 0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra-archive.servers | |
| The comma-separated list of Cassandra servers | |
--cassandra-archive.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra-archive.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra-archive.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra-archive.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra-archive.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra-archive.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra-archive.username | |
| Username for password authentication for Cassandra | |
--cassandra.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra.connections-per-host | 2 |
| The number of Cassandra connections from a single backend instance | |
--cassandra.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra.index.logs | true |
| Controls log field indexing. Set to false to disable. | |
--cassandra.index.process-tags | true |
| Controls process tag indexing. Set to false to disable. | |
--cassandra.index.tag-blacklist | |
| The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option. | |
--cassandra.index.tag-whitelist | |
| The comma-separated list of span tags to whitelist for being indexed. All other tags will not be indexed. Mutually exclusive with the blacklist option. | |
--cassandra.index.tags | true |
| Controls tag indexing. Set to false to disable. | |
--cassandra.keyspace | jaeger_dc1 |
| The Cassandra keyspace for Jaeger data | |
--cassandra.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra.max-retry-attempts | 3 |
| The number of attempts when reading from Cassandra | |
--cassandra.password | |
| Password for password authentication for Cassandra | |
--cassandra.port | 9042 |
| The port for cassandra | |
--cassandra.proto-version | 4 |
| The Cassandra protocol version | |
--cassandra.reconnect-interval | 1m0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra.servers | 127.0.0.1 |
| The comma-separated list of Cassandra servers | |
--cassandra.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra.span-store-write-cache-ttl | 12h0m0s |
| The duration to wait before rewriting an existing service or operation name | |
--cassandra.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra.username | |
| Username for password authentication for Cassandra | |
--collector.enable-span-size-metrics | false |
| Enables metrics based on processed span size, which are more expensive to calculate. | |
--collector.grpc-server.host-port | :14250 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.grpc-server.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http-server.host-port | :14268 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.http-server.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.num-workers | 50 |
| The number of workers pulling items from the queue | |
--collector.otlp.enabled | true |
| Enables OpenTelemetry OTLP receiver on dedicated HTTP and gRPC ports | |
--collector.otlp.grpc.host-port | :4317 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.otlp.grpc.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.otlp.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.otlp.http.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.otlp.http.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.otlp.http.host-port | :4318 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.otlp.http.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.queue-size | 2000 |
| The queue size of the collector | |
--collector.queue-size-memory | 0 |
| (experimental) The max memory size in MiB to use for the dynamic queue. | |
--collector.tags | |
| One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue} | |
--collector.zipkin.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.zipkin.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.zipkin.host-port | |
| The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's Zipkin server (disabled by default) | |
--collector.zipkin.keep-alive | true |
| KeepAlive configures allow Keep-Alive for Zipkin HTTP server (enabled by default) | |
--collector.zipkin.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.zipkin.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.zipkin.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.zipkin.tls.enabled | false |
| Enable TLS on the server | |
--collector.zipkin.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.zipkin.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.zipkin.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--help | false |
| help for jaeger-collector | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--sampling.strategies-file | |
| The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file | |
--sampling.strategies-reload-interval | 0s |
| Reload interval to check and reload sampling strategies file. Zero value means no reloading | |
--sampling.strategies.bugfix-5270 | false |
| Include default operation level strategies for Ratesampling type service level strategy. Cf. https://github.com/jaegertracing/jaeger/issues/5270 | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-collector with elasticsearch storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14269 |
| The host:port (e.g. 127.0.0.1:14269 or :14269) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.enable-span-size-metrics | false |
| Enables metrics based on processed span size, which are more expensive to calculate. | |
--collector.grpc-server.host-port | :14250 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.grpc-server.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http-server.host-port | :14268 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.http-server.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.num-workers | 50 |
| The number of workers pulling items from the queue | |
--collector.otlp.enabled | true |
| Enables OpenTelemetry OTLP receiver on dedicated HTTP and gRPC ports | |
--collector.otlp.grpc.host-port | :4317 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.otlp.grpc.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.otlp.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.otlp.http.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.otlp.http.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.otlp.http.host-port | :4318 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.otlp.http.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.queue-size | 2000 |
| The queue size of the collector | |
--collector.queue-size-memory | 0 |
| (experimental) The max memory size in MiB to use for the dynamic queue. | |
--collector.tags | |
| One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue} | |
--collector.zipkin.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.zipkin.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.zipkin.host-port | |
| The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's Zipkin server (disabled by default) | |
--collector.zipkin.keep-alive | true |
| KeepAlive configures allow Keep-Alive for Zipkin HTTP server (enabled by default) | |
--collector.zipkin.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.zipkin.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.zipkin.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.zipkin.tls.enabled | false |
| Enable TLS on the server | |
--collector.zipkin.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.zipkin.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.zipkin.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--es-archive.adaptive-sampling.lookback | 72h0m0s |
| How far back to look for the latest adaptive sampling probabilities | |
--es-archive.bulk.actions | 1000 |
| The number of requests that can be enqueued before the bulk processor decides to commit | |
--es-archive.bulk.flush-interval | 200ms |
| A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled. | |
--es-archive.bulk.size | 5000000 |
| The number of bytes that the bulk requests can take up before the bulk processor decides to commit | |
--es-archive.bulk.workers | 1 |
| The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch | |
--es-archive.create-index-templates | true |
| Create index templates at application startup. Set to false when templates are installed manually. | |
--es-archive.enabled | false |
| Enable extra storage | |
--es-archive.index-date-separator | - |
| Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20". | |
--es-archive.index-prefix | |
| Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*". | |
--es-archive.index-rollover-frequency-adaptive-sampling | day |
| Rotates jaeger-sampling indices over the given period. For example "day" creates "jaeger-sampling-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.index-rollover-frequency-services | day |
| Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.index-rollover-frequency-spans | day |
| Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.log-level | error |
| The Elasticsearch client log-level. Valid levels: [debug, info, error] | |
--es-archive.max-doc-count | 10000 |
| The maximum document count to return from an Elasticsearch query. This will also apply to aggregations. | |
--es-archive.num-replicas | 1 |
| The number of replicas per index in Elasticsearch | |
--es-archive.num-shards | 5 |
| The number of shards per index in Elasticsearch | |
--es-archive.password | |
| The password required by Elasticsearch | |
--es-archive.password-file | |
| Path to a file containing password. This file is watched for changes. | |
--es-archive.prioirity-dependencies-template | 0 |
| Priority of jaeger-dependecies index template (ESv8 only) | |
--es-archive.prioirity-service-template | 0 |
| Priority of jaeger-service index template (ESv8 only) | |
--es-archive.prioirity-span-template | 0 |
| Priority of jaeger-span index template (ESv8 only) | |
--es-archive.remote-read-clusters | |
| Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api. | |
--es-archive.send-get-body-as | |
| HTTP verb for requests that contain a body [GET, POST]. | |
--es-archive.server-urls | http://127.0.0.1:9200 |
| The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200 | |
--es-archive.service-cache-ttl | 0s |
| The TTL for the cache of known service names | |
--es-archive.sniffer | false |
| The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required | |
--es-archive.sniffer-tls-enabled | false |
| Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default | |
--es-archive.tags-as-fields.all | false |
| (experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects. | |
--es-archive.tags-as-fields.config-file | |
| (experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include | |
--es-archive.tags-as-fields.dot-replacement | @ |
| (experimental) The character used to replace dots (".") in tag keys stored as object fields. | |
--es-archive.tags-as-fields.include | |
| (experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file | |
--es-archive.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--es-archive.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--es-archive.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--es-archive.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--es-archive.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--es-archive.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--es-archive.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--es-archive.token-file | |
| Path to a file containing bearer token. This flag also loads CA if it is specified. | |
--es-archive.use-aliases | false |
| Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times. | |
--es-archive.use-ilm | false |
| (experimental) Option to enable ILM for jaeger span & service indices. Use this option with es-archive.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+. | |
--es-archive.username | |
| The username required by Elasticsearch. The basic authentication also loads CA if it is specified. | |
--es-archive.version | 0 |
| The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch. | |
--es.adaptive-sampling.lookback | 72h0m0s |
| How far back to look for the latest adaptive sampling probabilities | |
--es.bulk.actions | 1000 |
| The number of requests that can be enqueued before the bulk processor decides to commit | |
--es.bulk.flush-interval | 200ms |
| A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled. | |
--es.bulk.size | 5000000 |
| The number of bytes that the bulk requests can take up before the bulk processor decides to commit | |
--es.bulk.workers | 1 |
| The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch | |
--es.create-index-templates | true |
| Create index templates at application startup. Set to false when templates are installed manually. | |
--es.index-date-separator | - |
| Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20". | |
--es.index-prefix | |
| Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*". | |
--es.index-rollover-frequency-adaptive-sampling | day |
| Rotates jaeger-sampling indices over the given period. For example "day" creates "jaeger-sampling-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.index-rollover-frequency-services | day |
| Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.index-rollover-frequency-spans | day |
| Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.log-level | error |
| The Elasticsearch client log-level. Valid levels: [debug, info, error] | |
--es.max-doc-count | 10000 |
| The maximum document count to return from an Elasticsearch query. This will also apply to aggregations. | |
--es.max-span-age | 72h0m0s |
| The maximum lookback for spans in Elasticsearch | |
--es.num-replicas | 1 |
| The number of replicas per index in Elasticsearch | |
--es.num-shards | 5 |
| The number of shards per index in Elasticsearch | |
--es.password | |
| The password required by Elasticsearch | |
--es.password-file | |
| Path to a file containing password. This file is watched for changes. | |
--es.prioirity-dependencies-template | 0 |
| Priority of jaeger-dependecies index template (ESv8 only) | |
--es.prioirity-service-template | 0 |
| Priority of jaeger-service index template (ESv8 only) | |
--es.prioirity-span-template | 0 |
| Priority of jaeger-span index template (ESv8 only) | |
--es.remote-read-clusters | |
| Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api. | |
--es.send-get-body-as | |
| HTTP verb for requests that contain a body [GET, POST]. | |
--es.server-urls | http://127.0.0.1:9200 |
| The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200 | |
--es.service-cache-ttl | 0s |
| The TTL for the cache of known service names | |
--es.sniffer | false |
| The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required | |
--es.sniffer-tls-enabled | false |
| Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default | |
--es.tags-as-fields.all | false |
| (experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects. | |
--es.tags-as-fields.config-file | |
| (experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include | |
--es.tags-as-fields.dot-replacement | @ |
| (experimental) The character used to replace dots (".") in tag keys stored as object fields. | |
--es.tags-as-fields.include | |
| (experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file | |
--es.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--es.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--es.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--es.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--es.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--es.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--es.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--es.token-file | |
| Path to a file containing bearer token. This flag also loads CA if it is specified. | |
--es.use-aliases | false |
| Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times. | |
--es.use-ilm | false |
| (experimental) Option to enable ILM for jaeger span & service indices. Use this option with es.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+. | |
--es.username | |
| The username required by Elasticsearch. The basic authentication also loads CA if it is specified. | |
--es.version | 0 |
| The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch. | |
--help | false |
| help for jaeger-collector | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--sampling.strategies-file | |
| The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file | |
--sampling.strategies-reload-interval | 0s |
| Reload interval to check and reload sampling strategies file. Zero value means no reloading | |
--sampling.strategies.bugfix-5270 | false |
| Include default operation level strategies for Ratesampling type service level strategy. Cf. https://github.com/jaegertracing/jaeger/issues/5270 | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-collector with kafka storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14269 |
| The host:port (e.g. 127.0.0.1:14269 or :14269) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.enable-span-size-metrics | false |
| Enables metrics based on processed span size, which are more expensive to calculate. | |
--collector.grpc-server.host-port | :14250 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.grpc-server.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http-server.host-port | :14268 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.http-server.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.num-workers | 50 |
| The number of workers pulling items from the queue | |
--collector.otlp.enabled | true |
| Enables OpenTelemetry OTLP receiver on dedicated HTTP and gRPC ports | |
--collector.otlp.grpc.host-port | :4317 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.otlp.grpc.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.otlp.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.otlp.http.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.otlp.http.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.otlp.http.host-port | :4318 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.otlp.http.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.queue-size | 2000 |
| The queue size of the collector | |
--collector.queue-size-memory | 0 |
| (experimental) The max memory size in MiB to use for the dynamic queue. | |
--collector.tags | |
| One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue} | |
--collector.zipkin.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.zipkin.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.zipkin.host-port | |
| The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's Zipkin server (disabled by default) | |
--collector.zipkin.keep-alive | true |
| KeepAlive configures allow Keep-Alive for Zipkin HTTP server (enabled by default) | |
--collector.zipkin.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.zipkin.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.zipkin.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.zipkin.tls.enabled | false |
| Enable TLS on the server | |
--collector.zipkin.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.zipkin.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.zipkin.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--help | false |
| help for jaeger-collector | |
--kafka.producer.authentication | none |
| Authentication type used to authenticate with kafka cluster. e.g. none, kerberos, tls, plaintext | |
--kafka.producer.batch-linger | 0s |
| (experimental) Time interval to wait before sending records to Kafka. Higher value reduce request to Kafka but increase latency and the possibility of data loss in case of process restart. See https://kafka.apache.org/documentation/ | |
--kafka.producer.batch-max-messages | 0 |
| (experimental) Maximum number of message to batch before sending records to Kafka | |
--kafka.producer.batch-min-messages | 0 |
| (experimental) The best-effort minimum number of messages needed to send a batch of records to Kafka. Higher value reduce request to Kafka but increase latency and the possibility of data loss in case of process restart. See https://kafka.apache.org/documentation/ | |
--kafka.producer.batch-size | 0 |
| (experimental) Number of bytes to batch before sending records to Kafka. Higher value reduce request to Kafka but increase latency and the possibility of data loss in case of process restart. See https://kafka.apache.org/documentation/ | |
--kafka.producer.brokers | 127.0.0.1:9092 |
| The comma-separated list of kafka brokers. i.e. '127.0.0.1:9092,0.0.0:1234' | |
--kafka.producer.compression | none |
| (experimental) Type of compression (none, gzip, snappy, lz4, zstd) to use on messages | |
--kafka.producer.compression-level | 0 |
| (experimental) compression level to use on messages. gzip = 1-9 (default = 6), snappy = none, lz4 = 1-17 (default = 9), zstd = -131072 - 22 (default = 3) | |
--kafka.producer.encoding | protobuf |
| Encoding of spans ("json" or "protobuf") sent to kafka. | |
--kafka.producer.kerberos.config-file | /etc/krb5.conf |
| Path to Kerberos configuration. i.e /etc/krb5.conf | |
--kafka.producer.kerberos.disable-fast-negotiation | false |
| Disable FAST negotiation when not supported by KDC's like Active Directory. See https://github.com/jcmturner/gokrb5/blob/master/USAGE.md#active-directory-kdc-and-fast-negotiation. | |
--kafka.producer.kerberos.keytab-file | /etc/security/kafka.keytab |
| Path to keytab file. i.e /etc/security/kafka.keytab | |
--kafka.producer.kerberos.password | |
| The Kerberos password used for authenticate with KDC | |
--kafka.producer.kerberos.realm | |
| Kerberos realm | |
--kafka.producer.kerberos.service-name | kafka |
| Kerberos service name | |
--kafka.producer.kerberos.use-keytab | false |
| Use of keytab instead of password, if this is true, keytab file will be used instead of password | |
--kafka.producer.kerberos.username | |
| The Kerberos username used for authenticate with KDC | |
--kafka.producer.max-message-bytes | 1000000 |
| (experimental) The maximum permitted size of a message. Should be set equal to or smaller than the broker's `message.max.bytes`. | |
--kafka.producer.plaintext.mechanism | PLAIN |
| The plaintext Mechanism for SASL/PLAIN authentication, e.g. 'SCRAM-SHA-256' or 'SCRAM-SHA-512' or 'PLAIN' | |
--kafka.producer.plaintext.password | |
| The plaintext Password for SASL/PLAIN authentication | |
--kafka.producer.plaintext.username | |
| The plaintext Username for SASL/PLAIN authentication | |
--kafka.producer.protocol-version | |
| Kafka protocol version - must be supported by kafka server | |
--kafka.producer.required-acks | local |
| (experimental) Required kafka broker acknowledgement. i.e. noack, local, all | |
--kafka.producer.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--kafka.producer.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--kafka.producer.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--kafka.producer.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--kafka.producer.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--kafka.producer.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--kafka.producer.topic | jaeger-spans |
| The name of the kafka topic | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--sampling.strategies-file | |
| The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file | |
--sampling.strategies-reload-interval | 0s |
| Reload interval to check and reload sampling strategies file. Zero value means no reloading | |
--sampling.strategies.bugfix-5270 | false |
| Include default operation level strategies for Ratesampling type service level strategy. Cf. https://github.com/jaegertracing/jaeger/issues/5270 | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-collector with adaptive sampling
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14269 |
| The host:port (e.g. 127.0.0.1:14269 or :14269) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--cassandra-archive.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra-archive.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra-archive.connections-per-host | 0 |
| The number of Cassandra connections from a single backend instance | |
--cassandra-archive.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra-archive.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra-archive.enabled | false |
| Enable extra storage | |
--cassandra-archive.keyspace | |
| The Cassandra keyspace for Jaeger data | |
--cassandra-archive.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra-archive.max-retry-attempts | 0 |
| The number of attempts when reading from Cassandra | |
--cassandra-archive.password | |
| Password for password authentication for Cassandra | |
--cassandra-archive.port | 0 |
| The port for cassandra | |
--cassandra-archive.proto-version | 0 |
| The Cassandra protocol version | |
--cassandra-archive.reconnect-interval | 0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra-archive.servers | |
| The comma-separated list of Cassandra servers | |
--cassandra-archive.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra-archive.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra-archive.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra-archive.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra-archive.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra-archive.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra-archive.username | |
| Username for password authentication for Cassandra | |
--cassandra.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra.connections-per-host | 2 |
| The number of Cassandra connections from a single backend instance | |
--cassandra.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra.index.logs | true |
| Controls log field indexing. Set to false to disable. | |
--cassandra.index.process-tags | true |
| Controls process tag indexing. Set to false to disable. | |
--cassandra.index.tag-blacklist | |
| The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option. | |
--cassandra.index.tag-whitelist | |
| The comma-separated list of span tags to whitelist for being indexed. All other tags will not be indexed. Mutually exclusive with the blacklist option. | |
--cassandra.index.tags | true |
| Controls tag indexing. Set to false to disable. | |
--cassandra.keyspace | jaeger_dc1 |
| The Cassandra keyspace for Jaeger data | |
--cassandra.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra.max-retry-attempts | 3 |
| The number of attempts when reading from Cassandra | |
--cassandra.password | |
| Password for password authentication for Cassandra | |
--cassandra.port | 9042 |
| The port for cassandra | |
--cassandra.proto-version | 4 |
| The Cassandra protocol version | |
--cassandra.reconnect-interval | 1m0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra.servers | 127.0.0.1 |
| The comma-separated list of Cassandra servers | |
--cassandra.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra.span-store-write-cache-ttl | 12h0m0s |
| The duration to wait before rewriting an existing service or operation name | |
--cassandra.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra.username | |
| Username for password authentication for Cassandra | |
--collector.enable-span-size-metrics | false |
| Enables metrics based on processed span size, which are more expensive to calculate. | |
--collector.grpc-server.host-port | :14250 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.grpc-server.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http-server.host-port | :14268 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.http-server.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.num-workers | 50 |
| The number of workers pulling items from the queue | |
--collector.otlp.enabled | true |
| Enables OpenTelemetry OTLP receiver on dedicated HTTP and gRPC ports | |
--collector.otlp.grpc.host-port | :4317 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.otlp.grpc.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.otlp.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.otlp.http.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.otlp.http.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.otlp.http.host-port | :4318 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.otlp.http.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.queue-size | 2000 |
| The queue size of the collector | |
--collector.queue-size-memory | 0 |
| (experimental) The max memory size in MiB to use for the dynamic queue. | |
--collector.tags | |
| One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue} | |
--collector.zipkin.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.zipkin.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.zipkin.host-port | |
| The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's Zipkin server (disabled by default) | |
--collector.zipkin.keep-alive | true |
| KeepAlive configures allow Keep-Alive for Zipkin HTTP server (enabled by default) | |
--collector.zipkin.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.zipkin.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.zipkin.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.zipkin.tls.enabled | false |
| Enable TLS on the server | |
--collector.zipkin.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.zipkin.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.zipkin.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--help | false |
| help for jaeger-collector | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--sampling.aggregation-buckets | 10 |
| Amount of historical data to keep in memory. | |
--sampling.buckets-for-calculation | 1 |
| This determines how much of the previous data is used in calculating the weighted QPS, ie. if BucketsForCalculation is 1, only the most recent data will be used in calculating the weighted QPS. | |
--sampling.calculation-interval | 1m0s |
| How often new sampling probabilities are calculated. Recommended to be greater than the polling interval of your clients. | |
--sampling.delay | 2m0s |
| Determines how far back the most recent state is. Use this if you want to add some buffer time for the aggregation to finish. | |
--sampling.delta-tolerance | 0.3 |
| The acceptable amount of deviation between the observed samples-per-second and the desired (target) samples-per-second, expressed as a ratio. | |
--sampling.follower-lease-refresh-interval | 1m0s |
| The duration to sleep if this processor is a follower. | |
--sampling.initial-sampling-probability | 0.001 |
| The initial sampling probability for all new operations. | |
--sampling.leader-lease-refresh-interval | 5s |
| The duration to sleep if this processor is elected leader before attempting to renew the lease on the leader lock. This should be less than follower-lease-refresh-interval to reduce lock thrashing. | |
--sampling.min-samples-per-second | 0.016666666666666666 |
| The minimum number of traces that are sampled per second. | |
--sampling.min-sampling-probability | 1e-05 |
| The minimum sampling probability for all operations. | |
--sampling.target-samples-per-second | 1 |
| The global target rate of samples per operation. | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-collector with file sampling
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14269 |
| The host:port (e.g. 127.0.0.1:14269 or :14269) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--cassandra-archive.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra-archive.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra-archive.connections-per-host | 0 |
| The number of Cassandra connections from a single backend instance | |
--cassandra-archive.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra-archive.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra-archive.enabled | false |
| Enable extra storage | |
--cassandra-archive.keyspace | |
| The Cassandra keyspace for Jaeger data | |
--cassandra-archive.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra-archive.max-retry-attempts | 0 |
| The number of attempts when reading from Cassandra | |
--cassandra-archive.password | |
| Password for password authentication for Cassandra | |
--cassandra-archive.port | 0 |
| The port for cassandra | |
--cassandra-archive.proto-version | 0 |
| The Cassandra protocol version | |
--cassandra-archive.reconnect-interval | 0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra-archive.servers | |
| The comma-separated list of Cassandra servers | |
--cassandra-archive.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra-archive.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra-archive.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra-archive.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra-archive.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra-archive.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra-archive.username | |
| Username for password authentication for Cassandra | |
--cassandra.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra.connections-per-host | 2 |
| The number of Cassandra connections from a single backend instance | |
--cassandra.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra.index.logs | true |
| Controls log field indexing. Set to false to disable. | |
--cassandra.index.process-tags | true |
| Controls process tag indexing. Set to false to disable. | |
--cassandra.index.tag-blacklist | |
| The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option. | |
--cassandra.index.tag-whitelist | |
| The comma-separated list of span tags to whitelist for being indexed. All other tags will not be indexed. Mutually exclusive with the blacklist option. | |
--cassandra.index.tags | true |
| Controls tag indexing. Set to false to disable. | |
--cassandra.keyspace | jaeger_dc1 |
| The Cassandra keyspace for Jaeger data | |
--cassandra.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra.max-retry-attempts | 3 |
| The number of attempts when reading from Cassandra | |
--cassandra.password | |
| Password for password authentication for Cassandra | |
--cassandra.port | 9042 |
| The port for cassandra | |
--cassandra.proto-version | 4 |
| The Cassandra protocol version | |
--cassandra.reconnect-interval | 1m0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra.servers | 127.0.0.1 |
| The comma-separated list of Cassandra servers | |
--cassandra.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra.span-store-write-cache-ttl | 12h0m0s |
| The duration to wait before rewriting an existing service or operation name | |
--cassandra.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra.username | |
| Username for password authentication for Cassandra | |
--collector.enable-span-size-metrics | false |
| Enables metrics based on processed span size, which are more expensive to calculate. | |
--collector.grpc-server.host-port | :14250 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.grpc-server.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.grpc-server.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http-server.host-port | :14268 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.http-server.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http-server.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.num-workers | 50 |
| The number of workers pulling items from the queue | |
--collector.otlp.enabled | true |
| Enables OpenTelemetry OTLP receiver on dedicated HTTP and gRPC ports | |
--collector.otlp.grpc.host-port | :4317 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server | |
--collector.otlp.grpc.max-connection-age | 0s |
| The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-connection-age-grace | 0s |
| The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters | |
--collector.otlp.grpc.max-message-size | 4194304 |
| The maximum receivable message size for the collector's gRPC server | |
--collector.otlp.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.grpc.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.grpc.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.otlp.http.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.otlp.http.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.otlp.http.host-port | :4318 |
| The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server | |
--collector.otlp.http.idle-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-header-timeout | 2s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.read-timeout | 0s |
| See https://pkg.go.dev/net/http#Server | |
--collector.otlp.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.otlp.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.otlp.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.otlp.http.tls.enabled | false |
| Enable TLS on the server | |
--collector.otlp.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.otlp.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.otlp.http.tls.reload-interval | 0s |
| The duration after which the certificate will be reloaded (0s means will not be reloaded) | |
--collector.queue-size | 2000 |
| The queue size of the collector | |
--collector.queue-size-memory | 0 |
| (experimental) The max memory size in MiB to use for the dynamic queue. | |
--collector.tags | |
| One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue} | |
--collector.zipkin.cors.allowed-headers | |
| Comma-separated CORS allowed headers. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers | |
--collector.zipkin.cors.allowed-origins | |
| Comma-separated CORS allowed origins. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin | |
--collector.zipkin.host-port | |
| The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's Zipkin server (disabled by default) | |
--collector.zipkin.keep-alive | true |
| KeepAlive configures allow Keep-Alive for Zipkin HTTP server (enabled by default) | |
--collector.zipkin.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--collector.zipkin.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--collector.zipkin.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--collector.zipkin.tls.enabled | false |
| Enable TLS on the server | |
--collector.zipkin.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--collector.zipkin.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--collector.zipkin.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--help | false |
| help for jaeger-collector | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--sampling.strategies-file | |
| The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file | |
--sampling.strategies-reload-interval | 0s |
| Reload interval to check and reload sampling strategies file. Zero value means no reloading | |
--sampling.strategies.bugfix-5270 | false |
| Include default operation level strategies for Ratesampling type service level strategy. Cf. https://github.com/jaegertracing/jaeger/issues/5270 | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-ingester
Jaeger ingester consumes spans from a particular Kafka topic and writes them to a configured storage.
jaeger-ingester can be used with these storage backends:
jaeger-ingester with cassandra storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14270 |
| The host:port (e.g. 127.0.0.1:14270 or :14270) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--cassandra-archive.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra-archive.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra-archive.connections-per-host | 0 |
| The number of Cassandra connections from a single backend instance | |
--cassandra-archive.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra-archive.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra-archive.enabled | false |
| Enable extra storage | |
--cassandra-archive.keyspace | |
| The Cassandra keyspace for Jaeger data | |
--cassandra-archive.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra-archive.max-retry-attempts | 0 |
| The number of attempts when reading from Cassandra | |
--cassandra-archive.password | |
| Password for password authentication for Cassandra | |
--cassandra-archive.port | 0 |
| The port for cassandra | |
--cassandra-archive.proto-version | 0 |
| The Cassandra protocol version | |
--cassandra-archive.reconnect-interval | 0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra-archive.servers | |
| The comma-separated list of Cassandra servers | |
--cassandra-archive.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra-archive.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra-archive.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra-archive.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra-archive.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra-archive.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra-archive.username | |
| Username for password authentication for Cassandra | |
--cassandra.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra.connections-per-host | 2 |
| The number of Cassandra connections from a single backend instance | |
--cassandra.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra.index.logs | true |
| Controls log field indexing. Set to false to disable. | |
--cassandra.index.process-tags | true |
| Controls process tag indexing. Set to false to disable. | |
--cassandra.index.tag-blacklist | |
| The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option. | |
--cassandra.index.tag-whitelist | |
| The comma-separated list of span tags to whitelist for being indexed. All other tags will not be indexed. Mutually exclusive with the blacklist option. | |
--cassandra.index.tags | true |
| Controls tag indexing. Set to false to disable. | |
--cassandra.keyspace | jaeger_dc1 |
| The Cassandra keyspace for Jaeger data | |
--cassandra.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra.max-retry-attempts | 3 |
| The number of attempts when reading from Cassandra | |
--cassandra.password | |
| Password for password authentication for Cassandra | |
--cassandra.port | 9042 |
| The port for cassandra | |
--cassandra.proto-version | 4 |
| The Cassandra protocol version | |
--cassandra.reconnect-interval | 1m0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra.servers | 127.0.0.1 |
| The comma-separated list of Cassandra servers | |
--cassandra.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra.span-store-write-cache-ttl | 12h0m0s |
| The duration to wait before rewriting an existing service or operation name | |
--cassandra.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra.username | |
| Username for password authentication for Cassandra | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--help | false |
| help for jaeger-ingester | |
--ingester.deadlockInterval | 0s |
| Interval to check for deadlocks. If no messages gets processed in given time, ingester app will exit. Value of 0 disables deadlock check. | |
--ingester.parallelism | 1000 |
| The number of messages to process in parallel | |
--kafka.consumer.authentication | none |
| Authentication type used to authenticate with kafka cluster. e.g. none, kerberos, tls, plaintext | |
--kafka.consumer.brokers | 127.0.0.1:9092 |
| The comma-separated list of kafka brokers. i.e. '127.0.0.1:9092,0.0.0:1234' | |
--kafka.consumer.client-id | jaeger-ingester |
| The Consumer Client ID that ingester will use | |
--kafka.consumer.encoding | protobuf |
| The encoding of spans ("json", "protobuf", "zipkin-thrift") consumed from kafka | |
--kafka.consumer.fetch-max-message-bytes | 1048576 |
| The maximum number of message bytes to fetch from the broker in a single request. So you must be sure this is at least as large as your largest message. | |
--kafka.consumer.group-id | jaeger-ingester |
| The Consumer Group that ingester will be consuming on behalf of | |
--kafka.consumer.kerberos.config-file | /etc/krb5.conf |
| Path to Kerberos configuration. i.e /etc/krb5.conf | |
--kafka.consumer.kerberos.disable-fast-negotiation | false |
| Disable FAST negotiation when not supported by KDC's like Active Directory. See https://github.com/jcmturner/gokrb5/blob/master/USAGE.md#active-directory-kdc-and-fast-negotiation. | |
--kafka.consumer.kerberos.keytab-file | /etc/security/kafka.keytab |
| Path to keytab file. i.e /etc/security/kafka.keytab | |
--kafka.consumer.kerberos.password | |
| The Kerberos password used for authenticate with KDC | |
--kafka.consumer.kerberos.realm | |
| Kerberos realm | |
--kafka.consumer.kerberos.service-name | kafka |
| Kerberos service name | |
--kafka.consumer.kerberos.use-keytab | false |
| Use of keytab instead of password, if this is true, keytab file will be used instead of password | |
--kafka.consumer.kerberos.username | |
| The Kerberos username used for authenticate with KDC | |
--kafka.consumer.plaintext.mechanism | PLAIN |
| The plaintext Mechanism for SASL/PLAIN authentication, e.g. 'SCRAM-SHA-256' or 'SCRAM-SHA-512' or 'PLAIN' | |
--kafka.consumer.plaintext.password | |
| The plaintext Password for SASL/PLAIN authentication | |
--kafka.consumer.plaintext.username | |
| The plaintext Username for SASL/PLAIN authentication | |
--kafka.consumer.protocol-version | |
| Kafka protocol version - must be supported by kafka server | |
--kafka.consumer.rack-id | |
| Rack identifier for this client. This can be any string value which indicates where this client is located. It corresponds with the broker config `broker.rack` | |
--kafka.consumer.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--kafka.consumer.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--kafka.consumer.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--kafka.consumer.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--kafka.consumer.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--kafka.consumer.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--kafka.consumer.topic | jaeger-spans |
| The name of the kafka topic to consume from | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-ingester with elasticsearch storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :14270 |
| The host:port (e.g. 127.0.0.1:14270 or :14270) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--downsampling.hashsalt | |
| Salt used when hashing trace id for downsampling. | |
--downsampling.ratio | 1 |
| Ratio of spans passed to storage after downsampling (between 0 and 1), e.g ratio = 0.3 means we are keeping 30% of spans and dropping 70% of spans; ratio = 1.0 disables downsampling. | |
--es-archive.adaptive-sampling.lookback | 72h0m0s |
| How far back to look for the latest adaptive sampling probabilities | |
--es-archive.bulk.actions | 1000 |
| The number of requests that can be enqueued before the bulk processor decides to commit | |
--es-archive.bulk.flush-interval | 200ms |
| A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled. | |
--es-archive.bulk.size | 5000000 |
| The number of bytes that the bulk requests can take up before the bulk processor decides to commit | |
--es-archive.bulk.workers | 1 |
| The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch | |
--es-archive.create-index-templates | true |
| Create index templates at application startup. Set to false when templates are installed manually. | |
--es-archive.enabled | false |
| Enable extra storage | |
--es-archive.index-date-separator | - |
| Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20". | |
--es-archive.index-prefix | |
| Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*". | |
--es-archive.index-rollover-frequency-adaptive-sampling | day |
| Rotates jaeger-sampling indices over the given period. For example "day" creates "jaeger-sampling-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.index-rollover-frequency-services | day |
| Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.index-rollover-frequency-spans | day |
| Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.log-level | error |
| The Elasticsearch client log-level. Valid levels: [debug, info, error] | |
--es-archive.max-doc-count | 10000 |
| The maximum document count to return from an Elasticsearch query. This will also apply to aggregations. | |
--es-archive.num-replicas | 1 |
| The number of replicas per index in Elasticsearch | |
--es-archive.num-shards | 5 |
| The number of shards per index in Elasticsearch | |
--es-archive.password | |
| The password required by Elasticsearch | |
--es-archive.password-file | |
| Path to a file containing password. This file is watched for changes. | |
--es-archive.prioirity-dependencies-template | 0 |
| Priority of jaeger-dependecies index template (ESv8 only) | |
--es-archive.prioirity-service-template | 0 |
| Priority of jaeger-service index template (ESv8 only) | |
--es-archive.prioirity-span-template | 0 |
| Priority of jaeger-span index template (ESv8 only) | |
--es-archive.remote-read-clusters | |
| Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api. | |
--es-archive.send-get-body-as | |
| HTTP verb for requests that contain a body [GET, POST]. | |
--es-archive.server-urls | http://127.0.0.1:9200 |
| The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200 | |
--es-archive.service-cache-ttl | 0s |
| The TTL for the cache of known service names | |
--es-archive.sniffer | false |
| The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required | |
--es-archive.sniffer-tls-enabled | false |
| Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default | |
--es-archive.tags-as-fields.all | false |
| (experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects. | |
--es-archive.tags-as-fields.config-file | |
| (experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include | |
--es-archive.tags-as-fields.dot-replacement | @ |
| (experimental) The character used to replace dots (".") in tag keys stored as object fields. | |
--es-archive.tags-as-fields.include | |
| (experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file | |
--es-archive.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--es-archive.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--es-archive.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--es-archive.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--es-archive.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--es-archive.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--es-archive.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--es-archive.token-file | |
| Path to a file containing bearer token. This flag also loads CA if it is specified. | |
--es-archive.use-aliases | false |
| Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times. | |
--es-archive.use-ilm | false |
| (experimental) Option to enable ILM for jaeger span & service indices. Use this option with es-archive.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+. | |
--es-archive.username | |
| The username required by Elasticsearch. The basic authentication also loads CA if it is specified. | |
--es-archive.version | 0 |
| The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch. | |
--es.adaptive-sampling.lookback | 72h0m0s |
| How far back to look for the latest adaptive sampling probabilities | |
--es.bulk.actions | 1000 |
| The number of requests that can be enqueued before the bulk processor decides to commit | |
--es.bulk.flush-interval | 200ms |
| A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled. | |
--es.bulk.size | 5000000 |
| The number of bytes that the bulk requests can take up before the bulk processor decides to commit | |
--es.bulk.workers | 1 |
| The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch | |
--es.create-index-templates | true |
| Create index templates at application startup. Set to false when templates are installed manually. | |
--es.index-date-separator | - |
| Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20". | |
--es.index-prefix | |
| Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*". | |
--es.index-rollover-frequency-adaptive-sampling | day |
| Rotates jaeger-sampling indices over the given period. For example "day" creates "jaeger-sampling-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.index-rollover-frequency-services | day |
| Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.index-rollover-frequency-spans | day |
| Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.log-level | error |
| The Elasticsearch client log-level. Valid levels: [debug, info, error] | |
--es.max-doc-count | 10000 |
| The maximum document count to return from an Elasticsearch query. This will also apply to aggregations. | |
--es.max-span-age | 72h0m0s |
| The maximum lookback for spans in Elasticsearch | |
--es.num-replicas | 1 |
| The number of replicas per index in Elasticsearch | |
--es.num-shards | 5 |
| The number of shards per index in Elasticsearch | |
--es.password | |
| The password required by Elasticsearch | |
--es.password-file | |
| Path to a file containing password. This file is watched for changes. | |
--es.prioirity-dependencies-template | 0 |
| Priority of jaeger-dependecies index template (ESv8 only) | |
--es.prioirity-service-template | 0 |
| Priority of jaeger-service index template (ESv8 only) | |
--es.prioirity-span-template | 0 |
| Priority of jaeger-span index template (ESv8 only) | |
--es.remote-read-clusters | |
| Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api. | |
--es.send-get-body-as | |
| HTTP verb for requests that contain a body [GET, POST]. | |
--es.server-urls | http://127.0.0.1:9200 |
| The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200 | |
--es.service-cache-ttl | 0s |
| The TTL for the cache of known service names | |
--es.sniffer | false |
| The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required | |
--es.sniffer-tls-enabled | false |
| Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default | |
--es.tags-as-fields.all | false |
| (experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects. | |
--es.tags-as-fields.config-file | |
| (experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include | |
--es.tags-as-fields.dot-replacement | @ |
| (experimental) The character used to replace dots (".") in tag keys stored as object fields. | |
--es.tags-as-fields.include | |
| (experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file | |
--es.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--es.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--es.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--es.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--es.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--es.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--es.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--es.token-file | |
| Path to a file containing bearer token. This flag also loads CA if it is specified. | |
--es.use-aliases | false |
| Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times. | |
--es.use-ilm | false |
| (experimental) Option to enable ILM for jaeger span & service indices. Use this option with es.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+. | |
--es.username | |
| The username required by Elasticsearch. The basic authentication also loads CA if it is specified. | |
--es.version | 0 |
| The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch. | |
--help | false |
| help for jaeger-ingester | |
--ingester.deadlockInterval | 0s |
| Interval to check for deadlocks. If no messages gets processed in given time, ingester app will exit. Value of 0 disables deadlock check. | |
--ingester.parallelism | 1000 |
| The number of messages to process in parallel | |
--kafka.consumer.authentication | none |
| Authentication type used to authenticate with kafka cluster. e.g. none, kerberos, tls, plaintext | |
--kafka.consumer.brokers | 127.0.0.1:9092 |
| The comma-separated list of kafka brokers. i.e. '127.0.0.1:9092,0.0.0:1234' | |
--kafka.consumer.client-id | jaeger-ingester |
| The Consumer Client ID that ingester will use | |
--kafka.consumer.encoding | protobuf |
| The encoding of spans ("json", "protobuf", "zipkin-thrift") consumed from kafka | |
--kafka.consumer.fetch-max-message-bytes | 1048576 |
| The maximum number of message bytes to fetch from the broker in a single request. So you must be sure this is at least as large as your largest message. | |
--kafka.consumer.group-id | jaeger-ingester |
| The Consumer Group that ingester will be consuming on behalf of | |
--kafka.consumer.kerberos.config-file | /etc/krb5.conf |
| Path to Kerberos configuration. i.e /etc/krb5.conf | |
--kafka.consumer.kerberos.disable-fast-negotiation | false |
| Disable FAST negotiation when not supported by KDC's like Active Directory. See https://github.com/jcmturner/gokrb5/blob/master/USAGE.md#active-directory-kdc-and-fast-negotiation. | |
--kafka.consumer.kerberos.keytab-file | /etc/security/kafka.keytab |
| Path to keytab file. i.e /etc/security/kafka.keytab | |
--kafka.consumer.kerberos.password | |
| The Kerberos password used for authenticate with KDC | |
--kafka.consumer.kerberos.realm | |
| Kerberos realm | |
--kafka.consumer.kerberos.service-name | kafka |
| Kerberos service name | |
--kafka.consumer.kerberos.use-keytab | false |
| Use of keytab instead of password, if this is true, keytab file will be used instead of password | |
--kafka.consumer.kerberos.username | |
| The Kerberos username used for authenticate with KDC | |
--kafka.consumer.plaintext.mechanism | PLAIN |
| The plaintext Mechanism for SASL/PLAIN authentication, e.g. 'SCRAM-SHA-256' or 'SCRAM-SHA-512' or 'PLAIN' | |
--kafka.consumer.plaintext.password | |
| The plaintext Password for SASL/PLAIN authentication | |
--kafka.consumer.plaintext.username | |
| The plaintext Username for SASL/PLAIN authentication | |
--kafka.consumer.protocol-version | |
| Kafka protocol version - must be supported by kafka server | |
--kafka.consumer.rack-id | |
| Rack identifier for this client. This can be any string value which indicates where this client is located. It corresponds with the broker config `broker.rack` | |
--kafka.consumer.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--kafka.consumer.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--kafka.consumer.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--kafka.consumer.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--kafka.consumer.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--kafka.consumer.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--kafka.consumer.topic | jaeger-spans |
| The name of the kafka topic to consume from | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-query
Jaeger query service provides a Web UI and an API for accessing trace data.
jaeger-query can be used with these storage backends:
(Experimental) jaeger-query can be used with these metrics storage types:
jaeger-query with cassandra storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :16687 |
| The host:port (e.g. 127.0.0.1:16687 or :16687) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--cassandra-archive.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra-archive.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra-archive.connections-per-host | 0 |
| The number of Cassandra connections from a single backend instance | |
--cassandra-archive.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra-archive.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra-archive.enabled | false |
| Enable extra storage | |
--cassandra-archive.keyspace | |
| The Cassandra keyspace for Jaeger data | |
--cassandra-archive.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra-archive.max-retry-attempts | 0 |
| The number of attempts when reading from Cassandra | |
--cassandra-archive.password | |
| Password for password authentication for Cassandra | |
--cassandra-archive.port | 0 |
| The port for cassandra | |
--cassandra-archive.proto-version | 0 |
| The Cassandra protocol version | |
--cassandra-archive.reconnect-interval | 0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra-archive.servers | |
| The comma-separated list of Cassandra servers | |
--cassandra-archive.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra-archive.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra-archive.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra-archive.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra-archive.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra-archive.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra-archive.username | |
| Username for password authentication for Cassandra | |
--cassandra.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra.connections-per-host | 2 |
| The number of Cassandra connections from a single backend instance | |
--cassandra.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra.index.logs | true |
| Controls log field indexing. Set to false to disable. | |
--cassandra.index.process-tags | true |
| Controls process tag indexing. Set to false to disable. | |
--cassandra.index.tag-blacklist | |
| The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option. | |
--cassandra.index.tag-whitelist | |
| The comma-separated list of span tags to whitelist for being indexed. All other tags will not be indexed. Mutually exclusive with the blacklist option. | |
--cassandra.index.tags | true |
| Controls tag indexing. Set to false to disable. | |
--cassandra.keyspace | jaeger_dc1 |
| The Cassandra keyspace for Jaeger data | |
--cassandra.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra.max-retry-attempts | 3 |
| The number of attempts when reading from Cassandra | |
--cassandra.password | |
| Password for password authentication for Cassandra | |
--cassandra.port | 9042 |
| The port for cassandra | |
--cassandra.proto-version | 4 |
| The Cassandra protocol version | |
--cassandra.reconnect-interval | 1m0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra.servers | 127.0.0.1 |
| The comma-separated list of Cassandra servers | |
--cassandra.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra.span-store-write-cache-ttl | 12h0m0s |
| The duration to wait before rewriting an existing service or operation name | |
--cassandra.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra.username | |
| Username for password authentication for Cassandra | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--help | false |
| help for jaeger-query | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--query.additional-headers | [] |
| Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value" | |
--query.base-path | / |
| The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy. See https://github.com/jaegertracing/jaeger/blob/main/examples/reverse-proxy/README.md | |
--query.bearer-token-propagation | false |
| Allow propagation of bearer token to be used by storage plugins | |
--query.enable-tracing | false |
| Enables emitting jaeger-query traces | |
--query.grpc-server.host-port | :16685 |
| The host:port (e.g. 127.0.0.1:14250 or :14250) of the query's gRPC server | |
--query.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.grpc.tls.enabled | false |
| Enable TLS on the server | |
--query.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http-server.host-port | :16686 |
| The host:port (e.g. 127.0.0.1:14268 or :14268) of the query's HTTP server | |
--query.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.http.tls.enabled | false |
| Enable TLS on the server | |
--query.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.log-static-assets-access | false |
| Log when static assets are accessed (for debugging) | |
--query.max-clock-skew-adjustment | 0s |
| The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments | |
--query.static-files | |
| The directory path override for the static assets for the UI | |
--query.ui-config | |
| The path to the UI configuration file in JSON format | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-query with elasticsearch storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :16687 |
| The host:port (e.g. 127.0.0.1:16687 or :16687) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--es-archive.adaptive-sampling.lookback | 72h0m0s |
| How far back to look for the latest adaptive sampling probabilities | |
--es-archive.bulk.actions | 1000 |
| The number of requests that can be enqueued before the bulk processor decides to commit | |
--es-archive.bulk.flush-interval | 200ms |
| A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled. | |
--es-archive.bulk.size | 5000000 |
| The number of bytes that the bulk requests can take up before the bulk processor decides to commit | |
--es-archive.bulk.workers | 1 |
| The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch | |
--es-archive.create-index-templates | true |
| Create index templates at application startup. Set to false when templates are installed manually. | |
--es-archive.enabled | false |
| Enable extra storage | |
--es-archive.index-date-separator | - |
| Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20". | |
--es-archive.index-prefix | |
| Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*". | |
--es-archive.index-rollover-frequency-adaptive-sampling | day |
| Rotates jaeger-sampling indices over the given period. For example "day" creates "jaeger-sampling-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.index-rollover-frequency-services | day |
| Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.index-rollover-frequency-spans | day |
| Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es-archive.log-level | error |
| The Elasticsearch client log-level. Valid levels: [debug, info, error] | |
--es-archive.max-doc-count | 10000 |
| The maximum document count to return from an Elasticsearch query. This will also apply to aggregations. | |
--es-archive.num-replicas | 1 |
| The number of replicas per index in Elasticsearch | |
--es-archive.num-shards | 5 |
| The number of shards per index in Elasticsearch | |
--es-archive.password | |
| The password required by Elasticsearch | |
--es-archive.password-file | |
| Path to a file containing password. This file is watched for changes. | |
--es-archive.prioirity-dependencies-template | 0 |
| Priority of jaeger-dependecies index template (ESv8 only) | |
--es-archive.prioirity-service-template | 0 |
| Priority of jaeger-service index template (ESv8 only) | |
--es-archive.prioirity-span-template | 0 |
| Priority of jaeger-span index template (ESv8 only) | |
--es-archive.remote-read-clusters | |
| Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api. | |
--es-archive.send-get-body-as | |
| HTTP verb for requests that contain a body [GET, POST]. | |
--es-archive.server-urls | http://127.0.0.1:9200 |
| The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200 | |
--es-archive.service-cache-ttl | 0s |
| The TTL for the cache of known service names | |
--es-archive.sniffer | false |
| The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required | |
--es-archive.sniffer-tls-enabled | false |
| Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default | |
--es-archive.tags-as-fields.all | false |
| (experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects. | |
--es-archive.tags-as-fields.config-file | |
| (experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include | |
--es-archive.tags-as-fields.dot-replacement | @ |
| (experimental) The character used to replace dots (".") in tag keys stored as object fields. | |
--es-archive.tags-as-fields.include | |
| (experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file | |
--es-archive.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--es-archive.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--es-archive.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--es-archive.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--es-archive.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--es-archive.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--es-archive.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--es-archive.token-file | |
| Path to a file containing bearer token. This flag also loads CA if it is specified. | |
--es-archive.use-aliases | false |
| Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times. | |
--es-archive.use-ilm | false |
| (experimental) Option to enable ILM for jaeger span & service indices. Use this option with es-archive.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+. | |
--es-archive.username | |
| The username required by Elasticsearch. The basic authentication also loads CA if it is specified. | |
--es-archive.version | 0 |
| The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch. | |
--es.adaptive-sampling.lookback | 72h0m0s |
| How far back to look for the latest adaptive sampling probabilities | |
--es.bulk.actions | 1000 |
| The number of requests that can be enqueued before the bulk processor decides to commit | |
--es.bulk.flush-interval | 200ms |
| A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled. | |
--es.bulk.size | 5000000 |
| The number of bytes that the bulk requests can take up before the bulk processor decides to commit | |
--es.bulk.workers | 1 |
| The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch | |
--es.create-index-templates | true |
| Create index templates at application startup. Set to false when templates are installed manually. | |
--es.index-date-separator | - |
| Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20". | |
--es.index-prefix | |
| Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*". | |
--es.index-rollover-frequency-adaptive-sampling | day |
| Rotates jaeger-sampling indices over the given period. For example "day" creates "jaeger-sampling-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.index-rollover-frequency-services | day |
| Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.index-rollover-frequency-spans | day |
| Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover | |
--es.log-level | error |
| The Elasticsearch client log-level. Valid levels: [debug, info, error] | |
--es.max-doc-count | 10000 |
| The maximum document count to return from an Elasticsearch query. This will also apply to aggregations. | |
--es.max-span-age | 72h0m0s |
| The maximum lookback for spans in Elasticsearch | |
--es.num-replicas | 1 |
| The number of replicas per index in Elasticsearch | |
--es.num-shards | 5 |
| The number of shards per index in Elasticsearch | |
--es.password | |
| The password required by Elasticsearch | |
--es.password-file | |
| Path to a file containing password. This file is watched for changes. | |
--es.prioirity-dependencies-template | 0 |
| Priority of jaeger-dependecies index template (ESv8 only) | |
--es.prioirity-service-template | 0 |
| Priority of jaeger-service index template (ESv8 only) | |
--es.prioirity-span-template | 0 |
| Priority of jaeger-span index template (ESv8 only) | |
--es.remote-read-clusters | |
| Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api. | |
--es.send-get-body-as | |
| HTTP verb for requests that contain a body [GET, POST]. | |
--es.server-urls | http://127.0.0.1:9200 |
| The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200 | |
--es.service-cache-ttl | 0s |
| The TTL for the cache of known service names | |
--es.sniffer | false |
| The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required | |
--es.sniffer-tls-enabled | false |
| Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default | |
--es.tags-as-fields.all | false |
| (experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects. | |
--es.tags-as-fields.config-file | |
| (experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include | |
--es.tags-as-fields.dot-replacement | @ |
| (experimental) The character used to replace dots (".") in tag keys stored as object fields. | |
--es.tags-as-fields.include | |
| (experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file | |
--es.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--es.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--es.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--es.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--es.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--es.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--es.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--es.token-file | |
| Path to a file containing bearer token. This flag also loads CA if it is specified. | |
--es.use-aliases | false |
| Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times. | |
--es.use-ilm | false |
| (experimental) Option to enable ILM for jaeger span & service indices. Use this option with es.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+. | |
--es.username | |
| The username required by Elasticsearch. The basic authentication also loads CA if it is specified. | |
--es.version | 0 |
| The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch. | |
--help | false |
| help for jaeger-query | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--query.additional-headers | [] |
| Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value" | |
--query.base-path | / |
| The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy. See https://github.com/jaegertracing/jaeger/blob/main/examples/reverse-proxy/README.md | |
--query.bearer-token-propagation | false |
| Allow propagation of bearer token to be used by storage plugins | |
--query.enable-tracing | false |
| Enables emitting jaeger-query traces | |
--query.grpc-server.host-port | :16685 |
| The host:port (e.g. 127.0.0.1:14250 or :14250) of the query's gRPC server | |
--query.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.grpc.tls.enabled | false |
| Enable TLS on the server | |
--query.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http-server.host-port | :16686 |
| The host:port (e.g. 127.0.0.1:14268 or :14268) of the query's HTTP server | |
--query.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.http.tls.enabled | false |
| Enable TLS on the server | |
--query.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.log-static-assets-access | false |
| Log when static assets are accessed (for debugging) | |
--query.max-clock-skew-adjustment | 0s |
| The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments | |
--query.static-files | |
| The directory path override for the static assets for the UI | |
--query.ui-config | |
| The path to the UI configuration file in JSON format | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |
jaeger-query with prometheus metrics storage
| Flag | Default Value |
|---|---|
--admin.http.host-port | :16687 |
| The host:port (e.g. 127.0.0.1:16687 or :16687) for the admin server, including health check, /metrics, etc. | |
--admin.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--admin.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--admin.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--admin.http.tls.enabled | false |
| Enable TLS on the server | |
--admin.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--admin.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--admin.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--cassandra-archive.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra-archive.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra-archive.connections-per-host | 0 |
| The number of Cassandra connections from a single backend instance | |
--cassandra-archive.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra-archive.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra-archive.enabled | false |
| Enable extra storage | |
--cassandra-archive.keyspace | |
| The Cassandra keyspace for Jaeger data | |
--cassandra-archive.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra-archive.max-retry-attempts | 0 |
| The number of attempts when reading from Cassandra | |
--cassandra-archive.password | |
| Password for password authentication for Cassandra | |
--cassandra-archive.port | 0 |
| The port for cassandra | |
--cassandra-archive.proto-version | 0 |
| The Cassandra protocol version | |
--cassandra-archive.reconnect-interval | 0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra-archive.servers | |
| The comma-separated list of Cassandra servers | |
--cassandra-archive.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra-archive.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra-archive.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra-archive.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra-archive.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra-archive.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra-archive.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra-archive.username | |
| Username for password authentication for Cassandra | |
--cassandra.basic.allowed-authenticators | |
| The comma-separated list of allowed password authenticators for Cassandra.If none are specified, there is a default 'approved' list that is used (https://github.com/gocql/gocql/blob/34fdeebefcbf183ed7f916f931aa0586fdaa1b40/conn.go#L27). If a non-empty list is provided, only specified authenticators are allowed. | |
--cassandra.connect-timeout | 0s |
| Timeout used for connections to Cassandra Servers | |
--cassandra.connections-per-host | 2 |
| The number of Cassandra connections from a single backend instance | |
--cassandra.consistency | |
| The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE) | |
--cassandra.disable-compression | false |
| Disables the use of the default Snappy Compression while connecting to the Cassandra Cluster if set to true. This is useful for connecting to Cassandra Clusters(like Azure Cosmos Db with Cassandra API) that do not support SnappyCompression | |
--cassandra.index.logs | true |
| Controls log field indexing. Set to false to disable. | |
--cassandra.index.process-tags | true |
| Controls process tag indexing. Set to false to disable. | |
--cassandra.index.tag-blacklist | |
| The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option. | |
--cassandra.index.tag-whitelist | |
| The comma-separated list of span tags to whitelist for being indexed. All other tags will not be indexed. Mutually exclusive with the blacklist option. | |
--cassandra.index.tags | true |
| Controls tag indexing. Set to false to disable. | |
--cassandra.keyspace | jaeger_dc1 |
| The Cassandra keyspace for Jaeger data | |
--cassandra.local-dc | |
| The name of the Cassandra local data center for DC Aware host selection | |
--cassandra.max-retry-attempts | 3 |
| The number of attempts when reading from Cassandra | |
--cassandra.password | |
| Password for password authentication for Cassandra | |
--cassandra.port | 9042 |
| The port for cassandra | |
--cassandra.proto-version | 4 |
| The Cassandra protocol version | |
--cassandra.reconnect-interval | 1m0s |
| Reconnect interval to retry connecting to downed hosts | |
--cassandra.servers | 127.0.0.1 |
| The comma-separated list of Cassandra servers | |
--cassandra.socket-keep-alive | 0s |
| Cassandra's keepalive period to use, enabled if > 0 | |
--cassandra.span-store-write-cache-ttl | 12h0m0s |
| The duration to wait before rewriting an existing service or operation name | |
--cassandra.timeout | 0s |
| Timeout used for queries. A Timeout of zero means no timeout | |
--cassandra.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--cassandra.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--cassandra.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--cassandra.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--cassandra.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--cassandra.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--cassandra.username | |
| Username for password authentication for Cassandra | |
--config-file | |
| Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence. | |
--help | false |
| help for jaeger-query | |
--log-encoding | json |
| Log encoding. Supported values are 'json' and 'console'. | |
--log-level | info |
| Minimal allowed log Level. For more levels see https://github.com/uber-go/zap | |
--metrics-backend | prometheus |
| Defines which metrics backend to use for metrics reporting: prometheus or none | |
--metrics-http-route | /metrics |
| Defines the route of HTTP endpoint for metrics backends that support scraping | |
--multi-tenancy.enabled | false |
| Enable tenancy header when receiving or querying | |
--multi-tenancy.header | x-tenant |
| HTTP header carrying tenant | |
--multi-tenancy.tenants | |
| comma-separated list of allowed values for --multi-tenancy.header header. (If not supplied, tenants are not restricted) | |
--prometheus.connect-timeout | 30s |
| The period to wait for a connection to Prometheus when executing queries. | |
--prometheus.query.duration-unit | ms |
| The units used for the "latency" histogram. It can be either "ms" or "s" and should be consistent with the histogram unit value set in the spanmetrics connector (see: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/connector/spanmetricsconnector#configurations). This also helps jaeger-query determine the metric name when querying for "latency" metrics. | |
--prometheus.query.namespace | traces_span_metrics |
| The metric namespace that is prefixed to the metric name. A '.' separator will be added between the namespace and the metric name. | |
--prometheus.query.normalize-calls | false |
| Whether to normalize the "calls" metric name according to https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/translator/prometheus/README.md. For example: "calls" (not normalized) -> "calls_total" (normalized), | |
--prometheus.query.normalize-duration | false |
| Whether to normalize the "duration" metric name according to https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/translator/prometheus/README.md. For example: "duration_bucket" (not normalized) -> "duration_milliseconds_bucket (normalized)" | |
--prometheus.server-url | http://localhost:9090 |
| The Prometheus server's URL, must include the protocol scheme e.g. http://localhost:9090 | |
--prometheus.tls.ca | |
| Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore) | |
--prometheus.tls.cert | |
| Path to a TLS Certificate file, used to identify this process to the remote server(s) | |
--prometheus.tls.enabled | false |
| Enable TLS when talking to the remote server(s) | |
--prometheus.tls.key | |
| Path to a TLS Private Key file, used to identify this process to the remote server(s) | |
--prometheus.tls.server-name | |
| Override the TLS server name we expect in the certificate of the remote server(s) | |
--prometheus.tls.skip-host-verify | false |
| (insecure) Skip server's certificate chain and host name verification | |
--prometheus.token-file | |
| The path to a file containing the bearer token which will be included when executing queries against the Prometheus API. | |
--prometheus.token-override-from-context | true |
| Whether the bearer token should be overridden from context (incoming request) | |
--query.additional-headers | [] |
| Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value" | |
--query.base-path | / |
| The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy. See https://github.com/jaegertracing/jaeger/blob/main/examples/reverse-proxy/README.md | |
--query.bearer-token-propagation | false |
| Allow propagation of bearer token to be used by storage plugins | |
--query.enable-tracing | false |
| Enables emitting jaeger-query traces | |
--query.grpc-server.host-port | :16685 |
| The host:port (e.g. 127.0.0.1:14250 or :14250) of the query's gRPC server | |
--query.grpc.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.grpc.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.grpc.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.grpc.tls.enabled | false |
| Enable TLS on the server | |
--query.grpc.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.grpc.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.grpc.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http-server.host-port | :16686 |
| The host:port (e.g. 127.0.0.1:14268 or :14268) of the query's HTTP server | |
--query.http.tls.cert | |
| Path to a TLS Certificate file, used to identify this server to clients | |
--query.http.tls.cipher-suites | |
| Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). | |
--query.http.tls.client-ca | |
| Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted) | |
--query.http.tls.enabled | false |
| Enable TLS on the server | |
--query.http.tls.key | |
| Path to a TLS Private Key file, used to identify this server to clients | |
--query.http.tls.max-version | |
| Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.http.tls.min-version | |
| Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3) | |
--query.log-static-assets-access | false |
| Log when static assets are accessed (for debugging) | |
--query.max-clock-skew-adjustment | 0s |
| The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments | |
--query.static-files | |
| The directory path override for the static assets for the UI | |
--query.ui-config | |
| The path to the UI configuration file in JSON format | |
--span-storage.type | |
| (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help. | |