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_TYPE environment variable. Relevant variations are included below.
  • Some binaries support commands (mostly informational), such as env, docs, and version. These commands are not included here.
  • All parameters can be also provided via environment variables, by changing all letters to upper-case and replacing all punctuation characters with underscore _. For example, the value for the flag --cassandra.connections-per-host can be provided via CASSANDRA_CONNECTIONS_PER_HOST environment variable.

The CLI flags for the following binaries are documented below:

jaeger-all-in-one

Jaeger all-in-one distribution with agent, 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 storage

Flag Default Value
--admin-http-port 14269
The http port for the admin server, including health check, /metrics, etc.
--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.enable-dependencies-v2 false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--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 false
Enable TLS
--cassandra-archive.tls.ca
Path to TLS CA file
--cassandra-archive.tls.cert
Path to TLS certificate file
--cassandra-archive.tls.key
Path to TLS key file
--cassandra-archive.tls.server-name
Override the TLS server name
--cassandra-archive.tls.verify-host false
Enable (or disable) host key verification
--cassandra-archive.username
Username for password authentication for Cassandra
--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.enable-dependencies-v2 false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra.keyspace jaeger_v1_test
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 0
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 false
Enable TLS
--cassandra.tls.ca
Path to TLS CA file
--cassandra.tls.cert
Path to TLS certificate file
--cassandra.tls.key
Path to TLS key file
--cassandra.tls.server-name
Override the TLS server name
--cassandra.tls.verify-host true
Enable (or disable) host key verification
--cassandra.username
Username for password authentication for Cassandra
--collector.grpc-port 14250
The gRPC port for the collector service
--collector.grpc.tls false
Enable TLS for the gRPC collector port
--collector.grpc.tls.cert
Path to TLS certificate for the gRPC collector TLS service
--collector.grpc.tls.client.ca
Path to a TLS CA to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.key
Path to TLS key for the gRPC collector TLS cert
--collector.host-port
(deprecated) see --reporter.tchannel.host-port
--collector.http-port 14268
The HTTP port for the collector service
--collector.num-workers 50
The number of workers pulling items from the queue
--collector.port 14267
The TChannel port for the collector service
--collector.queue-size 2000
The queue size of the collector
--collector.zipkin.allowed-headers content-type
Comma separated list of allowed headers for the Zipkin collector service, default content-type
--collector.zipkin.allowed-origins *
Comma separated list of allowed origins for the Zipkin collector service, default accepts all
--collector.zipkin.http-port 0
The HTTP port for the Zipkin collector service e.g. 9411
--config-file
Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
--discovery.conn-check-timeout 250ms
(deprecated) see --reporter.tchannel.discovery.conn-check-timeout
--discovery.min-peers 3
(deprecated) see --reporter.tchannel.discovery.min-peers
--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.
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-all-in-one
--http-server.host-port :5778
host:port of the http server (e.g. for /sampling point and /baggageRestrictions endpoint)
--jaeger.tags
One or more tags to be added to the Process tags of all spans passing through this agent. Ex: key1=value1,key2=${envVar:defaultValue}
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--processor.jaeger-binary.server-host-port :6832
host:port for the UDP server
--processor.jaeger-binary.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-binary.workers 10
how many workers the processor should run
--processor.jaeger-compact.server-host-port :6831
host:port for the UDP server
--processor.jaeger-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-compact.workers 10
how many workers the processor should run
--processor.zipkin-compact.server-host-port :5775
host:port for the UDP server
--processor.zipkin-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.zipkin-compact.workers 10
how many workers the processor should run
--query.base-path /
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagation false
Allow propagation of bearer token to be used by storage plugins
--query.port 16686
The port for the query service
--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
--reporter.grpc.discovery.min-peers 3
Max number of collectors to which the agent will try to connect at any given time
--reporter.grpc.host-port
Comma-separated string representing host:port of a static list of collectors to connect to directly
--reporter.grpc.retry.max 3
Sets the maximum number of retries for a call
--reporter.grpc.tls false
Use TLS when talking to the remote collector
--reporter.grpc.tls.ca
Path to a TLS CA file used to verify the remote server. (default use the systems truststore)
--reporter.grpc.tls.cert
Path to a TLS client certificate file, used to identify this agent to the collector
--reporter.grpc.tls.key
Path to the TLS client key for the client certificate
--reporter.grpc.tls.server-name
Override the TLS server name we expected in the remote certificate
--reporter.tchannel.discovery.conn-check-timeout 250ms
sets the timeout used when establishing new connections
--reporter.tchannel.discovery.min-peers 3
if using service discovery, the min number of connections to maintain to the backend
--reporter.tchannel.host-port
comma-separated string representing host:ports of a static list of collectors to connect to directly (e.g. when not using service discovery)
--reporter.tchannel.report-timeout 1s
sets the timeout used when reporting spans
--reporter.type grpc
Reporter type to use e.g. grpc, tchannel
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with "env" command for help.

jaeger-all-in-one with elasticsearch storage

Flag Default Value
--admin-http-port 14269
The http port for the admin server, including health check, /metrics, etc.
--collector.grpc-port 14250
The gRPC port for the collector service
--collector.grpc.tls false
Enable TLS for the gRPC collector port
--collector.grpc.tls.cert
Path to TLS certificate for the gRPC collector TLS service
--collector.grpc.tls.client.ca
Path to a TLS CA to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.key
Path to TLS key for the gRPC collector TLS cert
--collector.host-port
(deprecated) see --reporter.tchannel.host-port
--collector.http-port 14268
The HTTP port for the collector service
--collector.num-workers 50
The number of workers pulling items from the queue
--collector.port 14267
The TChannel port for the collector service
--collector.queue-size 2000
The queue size of the collector
--collector.zipkin.allowed-headers content-type
Comma separated list of allowed headers for the Zipkin collector service, default content-type
--collector.zipkin.allowed-origins *
Comma separated list of allowed origins for the Zipkin collector service, default accepts all
--collector.zipkin.http-port 0
The HTTP port for the Zipkin collector service e.g. 9411
--config-file
Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
--discovery.conn-check-timeout 250ms
(deprecated) see --reporter.tchannel.discovery.conn-check-timeout
--discovery.min-peers 3
(deprecated) see --reporter.tchannel.discovery.min-peers
--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.bulk.actions 0
The number of requests that can be enqueued before the bulk processor decides to commit
--es-archive.bulk.flush-interval 0s
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 0
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es-archive.bulk.workers 0
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es-archive.create-index-templates false
Create index templates at application startup. Set to false when templates are installed manually.
--es-archive.enabled false
Enable extra storage
--es-archive.index-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es-archive.max-num-spans 0
The maximum number of spans to fetch at a time per query in Elasticsearch
--es-archive.max-span-age 0s
The maximum lookback for spans in Elasticsearch
--es-archive.num-replicas 0
The number of replicas per index in Elasticsearch
--es-archive.num-shards 0
The number of shards per index in Elasticsearch
--es-archive.password
The password required by Elasticsearch
--es-archive.server-urls
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es-archive.sniffer false
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es-archive.tags-as-fields.all false
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file 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.
--es-archive.tags-as-fields.dot-replacement
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es-archive.timeout 0s
Timeout used for queries. A Timeout of zero means no timeout
--es-archive.tls false
Enable TLS with client certificates.
--es-archive.tls.ca
Path to TLS CA file
--es-archive.tls.cert
Path to TLS certificate file
--es-archive.tls.key
Path to TLS key file
--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
(experimental) 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-archive.max-span-age is not taken into the account and has to be substituted by external component managing read alias.
--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.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-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es.max-num-spans 10000
The maximum number of spans to fetch at a time per query in Elasticsearch
--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.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.sniffer false
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es.tags-as-fields.all false
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file 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.
--es.tags-as-fields.dot-replacement @
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es.timeout 0s
Timeout used for queries. A Timeout of zero means no timeout
--es.tls false
Enable TLS with client certificates.
--es.tls.ca
Path to TLS CA file
--es.tls.cert
Path to TLS certificate file
--es.tls.key
Path to TLS key file
--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
(experimental) 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 is not taken into the account and has to be substituted by external component managing read alias.
--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.
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-all-in-one
--http-server.host-port :5778
host:port of the http server (e.g. for /sampling point and /baggageRestrictions endpoint)
--jaeger.tags
One or more tags to be added to the Process tags of all spans passing through this agent. Ex: key1=value1,key2=${envVar:defaultValue}
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--processor.jaeger-binary.server-host-port :6832
host:port for the UDP server
--processor.jaeger-binary.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-binary.workers 10
how many workers the processor should run
--processor.jaeger-compact.server-host-port :6831
host:port for the UDP server
--processor.jaeger-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-compact.workers 10
how many workers the processor should run
--processor.zipkin-compact.server-host-port :5775
host:port for the UDP server
--processor.zipkin-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.zipkin-compact.workers 10
how many workers the processor should run
--query.base-path /
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagation false
Allow propagation of bearer token to be used by storage plugins
--query.port 16686
The port for the query service
--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
--reporter.grpc.discovery.min-peers 3
Max number of collectors to which the agent will try to connect at any given time
--reporter.grpc.host-port
Comma-separated string representing host:port of a static list of collectors to connect to directly
--reporter.grpc.retry.max 3
Sets the maximum number of retries for a call
--reporter.grpc.tls false
Use TLS when talking to the remote collector
--reporter.grpc.tls.ca
Path to a TLS CA file used to verify the remote server. (default use the systems truststore)
--reporter.grpc.tls.cert
Path to a TLS client certificate file, used to identify this agent to the collector
--reporter.grpc.tls.key
Path to the TLS client key for the client certificate
--reporter.grpc.tls.server-name
Override the TLS server name we expected in the remote certificate
--reporter.tchannel.discovery.conn-check-timeout 250ms
sets the timeout used when establishing new connections
--reporter.tchannel.discovery.min-peers 3
if using service discovery, the min number of connections to maintain to the backend
--reporter.tchannel.host-port
comma-separated string representing host:ports of a static list of collectors to connect to directly (e.g. when not using service discovery)
--reporter.tchannel.report-timeout 1s
sets the timeout used when reporting spans
--reporter.type grpc
Reporter type to use e.g. grpc, tchannel
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with "env" command for help.

jaeger-all-in-one with memory storage

Flag Default Value
--admin-http-port 14269
The http port for the admin server, including health check, /metrics, etc.
--collector.grpc-port 14250
The gRPC port for the collector service
--collector.grpc.tls false
Enable TLS for the gRPC collector port
--collector.grpc.tls.cert
Path to TLS certificate for the gRPC collector TLS service
--collector.grpc.tls.client.ca
Path to a TLS CA to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.key
Path to TLS key for the gRPC collector TLS cert
--collector.host-port
(deprecated) see --reporter.tchannel.host-port
--collector.http-port 14268
The HTTP port for the collector service
--collector.num-workers 50
The number of workers pulling items from the queue
--collector.port 14267
The TChannel port for the collector service
--collector.queue-size 2000
The queue size of the collector
--collector.zipkin.allowed-headers content-type
Comma separated list of allowed headers for the Zipkin collector service, default content-type
--collector.zipkin.allowed-origins *
Comma separated list of allowed origins for the Zipkin collector service, default accepts all
--collector.zipkin.http-port 0
The HTTP port for the Zipkin collector service e.g. 9411
--config-file
Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
--discovery.conn-check-timeout 250ms
(deprecated) see --reporter.tchannel.discovery.conn-check-timeout
--discovery.min-peers 3
(deprecated) see --reporter.tchannel.discovery.min-peers
--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.
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-all-in-one
--http-server.host-port :5778
host:port of the http server (e.g. for /sampling point and /baggageRestrictions endpoint)
--jaeger.tags
One or more tags to be added to the Process tags of all spans passing through this agent. Ex: key1=value1,key2=${envVar:defaultValue}
--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
--metrics-backend prometheus
Defines which metrics backend to use for metrics reporting: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--processor.jaeger-binary.server-host-port :6832
host:port for the UDP server
--processor.jaeger-binary.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-binary.workers 10
how many workers the processor should run
--processor.jaeger-compact.server-host-port :6831
host:port for the UDP server
--processor.jaeger-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-compact.workers 10
how many workers the processor should run
--processor.zipkin-compact.server-host-port :5775
host:port for the UDP server
--processor.zipkin-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.zipkin-compact.workers 10
how many workers the processor should run
--query.base-path /
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagation false
Allow propagation of bearer token to be used by storage plugins
--query.port 16686
The port for the query service
--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
--reporter.grpc.discovery.min-peers 3
Max number of collectors to which the agent will try to connect at any given time
--reporter.grpc.host-port
Comma-separated string representing host:port of a static list of collectors to connect to directly
--reporter.grpc.retry.max 3
Sets the maximum number of retries for a call
--reporter.grpc.tls false
Use TLS when talking to the remote collector
--reporter.grpc.tls.ca
Path to a TLS CA file used to verify the remote server. (default use the systems truststore)
--reporter.grpc.tls.cert
Path to a TLS client certificate file, used to identify this agent to the collector
--reporter.grpc.tls.key
Path to the TLS client key for the client certificate
--reporter.grpc.tls.server-name
Override the TLS server name we expected in the remote certificate
--reporter.tchannel.discovery.conn-check-timeout 250ms
sets the timeout used when establishing new connections
--reporter.tchannel.discovery.min-peers 3
if using service discovery, the min number of connections to maintain to the backend
--reporter.tchannel.host-port
comma-separated string representing host:ports of a static list of collectors to connect to directly (e.g. when not using service discovery)
--reporter.tchannel.report-timeout 1s
sets the timeout used when reporting spans
--reporter.type grpc
Reporter type to use e.g. grpc, tchannel
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with "env" command for help.

jaeger-all-in-one with badger storage

Flag Default Value
--admin-http-port 14269
The http port for the admin server, including health check, /metrics, etc.
--badger.consistency false
If all writes should be synced immediately. This can 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.span-store-ttl 72h0m0s
How long to store the data. Format is time.Duration (https://golang.org/pkg/time/#Duration)
--collector.grpc-port 14250
The gRPC port for the collector service
--collector.grpc.tls false
Enable TLS for the gRPC collector port
--collector.grpc.tls.cert
Path to TLS certificate for the gRPC collector TLS service
--collector.grpc.tls.client.ca
Path to a TLS CA to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.key
Path to TLS key for the gRPC collector TLS cert
--collector.host-port
(deprecated) see --reporter.tchannel.host-port
--collector.http-port 14268
The HTTP port for the collector service
--collector.num-workers 50
The number of workers pulling items from the queue
--collector.port 14267
The TChannel port for the collector service
--collector.queue-size 2000
The queue size of the collector
--collector.zipkin.allowed-headers content-type
Comma separated list of allowed headers for the Zipkin collector service, default content-type
--collector.zipkin.allowed-origins *
Comma separated list of allowed origins for the Zipkin collector service, default accepts all
--collector.zipkin.http-port 0
The HTTP port for the Zipkin collector service e.g. 9411
--config-file
Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
--discovery.conn-check-timeout 250ms
(deprecated) see --reporter.tchannel.discovery.conn-check-timeout
--discovery.min-peers 3
(deprecated) see --reporter.tchannel.discovery.min-peers
--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.
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-all-in-one
--http-server.host-port :5778
host:port of the http server (e.g. for /sampling point and /baggageRestrictions endpoint)
--jaeger.tags
One or more tags to be added to the Process tags of all spans passing through this agent. Ex: key1=value1,key2=${envVar:defaultValue}
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--processor.jaeger-binary.server-host-port :6832
host:port for the UDP server
--processor.jaeger-binary.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-binary.workers 10
how many workers the processor should run
--processor.jaeger-compact.server-host-port :6831
host:port for the UDP server
--processor.jaeger-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-compact.workers 10
how many workers the processor should run
--processor.zipkin-compact.server-host-port :5775
host:port for the UDP server
--processor.zipkin-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.zipkin-compact.workers 10
how many workers the processor should run
--query.base-path /
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagation false
Allow propagation of bearer token to be used by storage plugins
--query.port 16686
The port for the query service
--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
--reporter.grpc.discovery.min-peers 3
Max number of collectors to which the agent will try to connect at any given time
--reporter.grpc.host-port
Comma-separated string representing host:port of a static list of collectors to connect to directly
--reporter.grpc.retry.max 3
Sets the maximum number of retries for a call
--reporter.grpc.tls false
Use TLS when talking to the remote collector
--reporter.grpc.tls.ca
Path to a TLS CA file used to verify the remote server. (default use the systems truststore)
--reporter.grpc.tls.cert
Path to a TLS client certificate file, used to identify this agent to the collector
--reporter.grpc.tls.key
Path to the TLS client key for the client certificate
--reporter.grpc.tls.server-name
Override the TLS server name we expected in the remote certificate
--reporter.tchannel.discovery.conn-check-timeout 250ms
sets the timeout used when establishing new connections
--reporter.tchannel.discovery.min-peers 3
if using service discovery, the min number of connections to maintain to the backend
--reporter.tchannel.host-port
comma-separated string representing host:ports of a static list of collectors to connect to directly (e.g. when not using service discovery)
--reporter.tchannel.report-timeout 1s
sets the timeout used when reporting spans
--reporter.type grpc
Reporter type to use e.g. grpc, tchannel
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with "env" command for help.

jaeger-all-in-one with grpc-plugin storage

Flag Default Value
--admin-http-port 14269
The http port for the admin server, including health check, /metrics, etc.
--collector.grpc-port 14250
The gRPC port for the collector service
--collector.grpc.tls false
Enable TLS for the gRPC collector port
--collector.grpc.tls.cert
Path to TLS certificate for the gRPC collector TLS service
--collector.grpc.tls.client.ca
Path to a TLS CA to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.key
Path to TLS key for the gRPC collector TLS cert
--collector.host-port
(deprecated) see --reporter.tchannel.host-port
--collector.http-port 14268
The HTTP port for the collector service
--collector.num-workers 50
The number of workers pulling items from the queue
--collector.port 14267
The TChannel port for the collector service
--collector.queue-size 2000
The queue size of the collector
--collector.zipkin.allowed-headers content-type
Comma separated list of allowed headers for the Zipkin collector service, default content-type
--collector.zipkin.allowed-origins *
Comma separated list of allowed origins for the Zipkin collector service, default accepts all
--collector.zipkin.http-port 0
The HTTP port for the Zipkin collector service e.g. 9411
--config-file
Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
--discovery.conn-check-timeout 250ms
(deprecated) see --reporter.tchannel.discovery.conn-check-timeout
--discovery.min-peers 3
(deprecated) see --reporter.tchannel.discovery.min-peers
--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.
--grpc-storage-plugin.binary
The location of the plugin binary
--grpc-storage-plugin.configuration-file
A path pointing to the plugin's configuration file, made available to the plugin with the --config arg
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-all-in-one
--http-server.host-port :5778
host:port of the http server (e.g. for /sampling point and /baggageRestrictions endpoint)
--jaeger.tags
One or more tags to be added to the Process tags of all spans passing through this agent. Ex: key1=value1,key2=${envVar:defaultValue}
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--processor.jaeger-binary.server-host-port :6832
host:port for the UDP server
--processor.jaeger-binary.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-binary.workers 10
how many workers the processor should run
--processor.jaeger-compact.server-host-port :6831
host:port for the UDP server
--processor.jaeger-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-compact.workers 10
how many workers the processor should run
--processor.zipkin-compact.server-host-port :5775
host:port for the UDP server
--processor.zipkin-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.zipkin-compact.workers 10
how many workers the processor should run
--query.base-path /
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagation false
Allow propagation of bearer token to be used by storage plugins
--query.port 16686
The port for the query service
--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
--reporter.grpc.discovery.min-peers 3
Max number of collectors to which the agent will try to connect at any given time
--reporter.grpc.host-port
Comma-separated string representing host:port of a static list of collectors to connect to directly
--reporter.grpc.retry.max 3
Sets the maximum number of retries for a call
--reporter.grpc.tls false
Use TLS when talking to the remote collector
--reporter.grpc.tls.ca
Path to a TLS CA file used to verify the remote server. (default use the systems truststore)
--reporter.grpc.tls.cert
Path to a TLS client certificate file, used to identify this agent to the collector
--reporter.grpc.tls.key
Path to the TLS client key for the client certificate
--reporter.grpc.tls.server-name
Override the TLS server name we expected in the remote certificate
--reporter.tchannel.discovery.conn-check-timeout 250ms
sets the timeout used when establishing new connections
--reporter.tchannel.discovery.min-peers 3
if using service discovery, the min number of connections to maintain to the backend
--reporter.tchannel.host-port
comma-separated string representing host:ports of a static list of collectors to connect to directly (e.g. when not using service discovery)
--reporter.tchannel.report-timeout 1s
sets the timeout used when reporting spans
--reporter.type grpc
Reporter type to use e.g. grpc, tchannel
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with "env" command for help.

jaeger-agent

Jaeger agent is a daemon program that runs on every host and receives tracing data submitted by Jaeger client libraries.

Flag Default Value
--admin-http-port 14271
The http port for the admin server, including health check, /metrics, etc.
--collector.host-port
(deprecated) see --reporter.tchannel.host-port
--config-file
Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
--discovery.conn-check-timeout 250ms
(deprecated) see --reporter.tchannel.discovery.conn-check-timeout
--discovery.min-peers 3
(deprecated) see --reporter.tchannel.discovery.min-peers
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-agent
--http-server.host-port :5778
host:port of the http server (e.g. for /sampling point and /baggageRestrictions endpoint)
--jaeger.tags
One or more tags to be added to the Process tags of all spans passing through this agent. Ex: key1=value1,key2=${envVar:defaultValue}
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--processor.jaeger-binary.server-host-port :6832
host:port for the UDP server
--processor.jaeger-binary.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-binary.workers 10
how many workers the processor should run
--processor.jaeger-compact.server-host-port :6831
host:port for the UDP server
--processor.jaeger-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.jaeger-compact.workers 10
how many workers the processor should run
--processor.zipkin-compact.server-host-port :5775
host:port for the UDP server
--processor.zipkin-compact.server-max-packet-size 65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size 1000
length of the queue for the UDP server
--processor.zipkin-compact.workers 10
how many workers the processor should run
--reporter.grpc.discovery.min-peers 3
Max number of collectors to which the agent will try to connect at any given time
--reporter.grpc.host-port
Comma-separated string representing host:port of a static list of collectors to connect to directly
--reporter.grpc.retry.max 3
Sets the maximum number of retries for a call
--reporter.grpc.tls false
Use TLS when talking to the remote collector
--reporter.grpc.tls.ca
Path to a TLS CA file used to verify the remote server. (default use the systems truststore)
--reporter.grpc.tls.cert
Path to a TLS client certificate file, used to identify this agent to the collector
--reporter.grpc.tls.key
Path to the TLS client key for the client certificate
--reporter.grpc.tls.server-name
Override the TLS server name we expected in the remote certificate
--reporter.tchannel.discovery.conn-check-timeout 250ms
sets the timeout used when establishing new connections
--reporter.tchannel.discovery.min-peers 3
if using service discovery, the min number of connections to maintain to the backend
--reporter.tchannel.host-port
comma-separated string representing host:ports of a static list of collectors to connect to directly (e.g. when not using service discovery)
--reporter.tchannel.report-timeout 1s
sets the timeout used when reporting spans
--reporter.type grpc
Reporter type to use e.g. grpc, tchannel

jaeger-collector

Jaeger collector receives traces from Jaeger agents and runs them through a processing pipeline.

jaeger-collector can be used with these storage backends:

jaeger-collector with cassandra storage

Flag Default Value
--admin-http-port 14269
The http port for the admin server, including health check, /metrics, etc.
--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.enable-dependencies-v2 false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--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 false
Enable TLS
--cassandra-archive.tls.ca
Path to TLS CA file
--cassandra-archive.tls.cert
Path to TLS certificate file
--cassandra-archive.tls.key
Path to TLS key file
--cassandra-archive.tls.server-name
Override the TLS server name
--cassandra-archive.tls.verify-host false
Enable (or disable) host key verification
--cassandra-archive.username
Username for password authentication for Cassandra
--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.enable-dependencies-v2 false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra.keyspace jaeger_v1_test
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 0
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 false
Enable TLS
--cassandra.tls.ca
Path to TLS CA file
--cassandra.tls.cert
Path to TLS certificate file
--cassandra.tls.key
Path to TLS key file
--cassandra.tls.server-name
Override the TLS server name
--cassandra.tls.verify-host true
Enable (or disable) host key verification
--cassandra.username
Username for password authentication for Cassandra
--collector.grpc-port 14250
The gRPC port for the collector service
--collector.grpc.tls false
Enable TLS for the gRPC collector port
--collector.grpc.tls.cert
Path to TLS certificate for the gRPC collector TLS service
--collector.grpc.tls.client.ca
Path to a TLS CA to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.key
Path to TLS key for the gRPC collector TLS cert
--collector.http-port 14268
The HTTP port for the collector service
--collector.num-workers 50
The number of workers pulling items from the queue
--collector.port 14267
The TChannel port for the collector service
--collector.queue-size 2000
The queue size of the collector
--collector.zipkin.allowed-headers content-type
Comma separated list of allowed headers for the Zipkin collector service, default content-type
--collector.zipkin.allowed-origins *
Comma separated list of allowed origins for the Zipkin collector service, default accepts all
--collector.zipkin.http-port 0
The HTTP port for the Zipkin collector service e.g. 9411
--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.
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-collector
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with "env" command for help.

jaeger-collector with elasticsearch storage

Flag Default Value
--admin-http-port 14269
The http port for the admin server, including health check, /metrics, etc.
--collector.grpc-port 14250
The gRPC port for the collector service
--collector.grpc.tls false
Enable TLS for the gRPC collector port
--collector.grpc.tls.cert
Path to TLS certificate for the gRPC collector TLS service
--collector.grpc.tls.client.ca
Path to a TLS CA to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.key
Path to TLS key for the gRPC collector TLS cert
--collector.http-port 14268
The HTTP port for the collector service
--collector.num-workers 50
The number of workers pulling items from the queue
--collector.port 14267
The TChannel port for the collector service
--collector.queue-size 2000
The queue size of the collector
--collector.zipkin.allowed-headers content-type
Comma separated list of allowed headers for the Zipkin collector service, default content-type
--collector.zipkin.allowed-origins *
Comma separated list of allowed origins for the Zipkin collector service, default accepts all
--collector.zipkin.http-port 0
The HTTP port for the Zipkin collector service e.g. 9411
--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.bulk.actions 0
The number of requests that can be enqueued before the bulk processor decides to commit
--es-archive.bulk.flush-interval 0s
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 0
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es-archive.bulk.workers 0
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es-archive.create-index-templates false
Create index templates at application startup. Set to false when templates are installed manually.
--es-archive.enabled false
Enable extra storage
--es-archive.index-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es-archive.max-num-spans 0
The maximum number of spans to fetch at a time per query in Elasticsearch
--es-archive.max-span-age 0s
The maximum lookback for spans in Elasticsearch
--es-archive.num-replicas 0
The number of replicas per index in Elasticsearch
--es-archive.num-shards 0
The number of shards per index in Elasticsearch
--es-archive.password
The password required by Elasticsearch
--es-archive.server-urls
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es-archive.sniffer false
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es-archive.tags-as-fields.all false
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file 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.
--es-archive.tags-as-fields.dot-replacement
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es-archive.timeout 0s
Timeout used for queries. A Timeout of zero means no timeout
--es-archive.tls false
Enable TLS with client certificates.
--es-archive.tls.ca
Path to TLS CA file
--es-archive.tls.cert
Path to TLS certificate file
--es-archive.tls.key
Path to TLS key file
--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
(experimental) 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-archive.max-span-age is not taken into the account and has to be substituted by external component managing read alias.
--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.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-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es.max-num-spans 10000
The maximum number of spans to fetch at a time per query in Elasticsearch
--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.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.sniffer false
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es.tags-as-fields.all false
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file 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.
--es.tags-as-fields.dot-replacement @
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es.timeout 0s
Timeout used for queries. A Timeout of zero means no timeout
--es.tls false
Enable TLS with client certificates.
--es.tls.ca
Path to TLS CA file
--es.tls.cert
Path to TLS certificate file
--es.tls.key
Path to TLS key file
--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
(experimental) 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 is not taken into the account and has to be substituted by external component managing read alias.
--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.
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-collector
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with "env" command for help.

jaeger-collector with kafka storage

Flag Default Value
--admin-http-port 14269
The http port for the admin server, including health check, /metrics, etc.
--collector.grpc-port 14250
The gRPC port for the collector service
--collector.grpc.tls false
Enable TLS for the gRPC collector port
--collector.grpc.tls.cert
Path to TLS certificate for the gRPC collector TLS service
--collector.grpc.tls.client.ca
Path to a TLS CA to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.key
Path to TLS key for the gRPC collector TLS cert
--collector.http-port 14268
The HTTP port for the collector service
--collector.num-workers 50
The number of workers pulling items from the queue
--collector.port 14267
The TChannel port for the collector service
--collector.queue-size 2000
The queue size of the collector
--collector.zipkin.allowed-headers content-type
Comma separated list of allowed headers for the Zipkin collector service, default content-type
--collector.zipkin.allowed-origins *
Comma separated list of allowed origins for the Zipkin collector service, default accepts all
--collector.zipkin.http-port 0
The HTTP port for the Zipkin collector service e.g. 9411
--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.
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-collector
--kafka.producer.authentication none
Authentication type used to authenticate with kafka cluster. e.g. none, kerberos
--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.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.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.protocol-version
Kafka protocol version - must be supported by kafka server
--kafka.producer.topic jaeger-spans
The name of the kafka topic
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with "env" command for help.

jaeger-collector with grpc-plugin storage

Flag Default Value
--admin-http-port 14269
The http port for the admin server, including health check, /metrics, etc.
--collector.grpc-port 14250
The gRPC port for the collector service
--collector.grpc.tls false
Enable TLS for the gRPC collector port
--collector.grpc.tls.cert
Path to TLS certificate for the gRPC collector TLS service
--collector.grpc.tls.client.ca
Path to a TLS CA to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.key
Path to TLS key for the gRPC collector TLS cert
--collector.http-port 14268
The HTTP port for the collector service
--collector.num-workers 50
The number of workers pulling items from the queue
--collector.port 14267
The TChannel port for the collector service
--collector.queue-size 2000
The queue size of the collector
--collector.zipkin.allowed-headers content-type
Comma separated list of allowed headers for the Zipkin collector service, default content-type
--collector.zipkin.allowed-origins *
Comma separated list of allowed origins for the Zipkin collector service, default accepts all
--collector.zipkin.http-port 0
The HTTP port for the Zipkin collector service e.g. 9411
--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.
--grpc-storage-plugin.binary
The location of the plugin binary
--grpc-storage-plugin.configuration-file
A path pointing to the plugin's configuration file, made available to the plugin with the --config arg
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-collector
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with "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-port 14270
The http port for the admin server, including health check, /metrics, etc.
--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.enable-dependencies-v2 false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--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 false
Enable TLS
--cassandra-archive.tls.ca
Path to TLS CA file
--cassandra-archive.tls.cert
Path to TLS certificate file
--cassandra-archive.tls.key
Path to TLS key file
--cassandra-archive.tls.server-name
Override the TLS server name
--cassandra-archive.tls.verify-host false
Enable (or disable) host key verification
--cassandra-archive.username
Username for password authentication for Cassandra
--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.enable-dependencies-v2 false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra.keyspace jaeger_v1_test
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 0
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 false
Enable TLS
--cassandra.tls.ca
Path to TLS CA file
--cassandra.tls.cert
Path to TLS certificate file
--cassandra.tls.key
Path to TLS key file
--cassandra.tls.server-name
Override the TLS server name
--cassandra.tls.verify-host true
Enable (or disable) host key 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.
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-ingester
--ingester.deadlockInterval 1m0s
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
--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.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.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.protocol-version
Kafka protocol version - must be supported by kafka server
--kafka.consumer.topic jaeger-spans
The name of the kafka topic to consume from
--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: expvar, prometheus, 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 "env" command for help.

jaeger-ingester with elasticsearch storage

Flag Default Value
--admin-http-port 14270
The http port for the admin server, including health check, /metrics, etc.
--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.bulk.actions 0
The number of requests that can be enqueued before the bulk processor decides to commit
--es-archive.bulk.flush-interval 0s
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 0
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es-archive.bulk.workers 0
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es-archive.create-index-templates false
Create index templates at application startup. Set to false when templates are installed manually.
--es-archive.enabled false
Enable extra storage
--es-archive.index-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es-archive.max-num-spans 0
The maximum number of spans to fetch at a time per query in Elasticsearch
--es-archive.max-span-age 0s
The maximum lookback for spans in Elasticsearch
--es-archive.num-replicas 0
The number of replicas per index in Elasticsearch
--es-archive.num-shards 0
The number of shards per index in Elasticsearch
--es-archive.password
The password required by Elasticsearch
--es-archive.server-urls
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es-archive.sniffer false
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es-archive.tags-as-fields.all false
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file 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.
--es-archive.tags-as-fields.dot-replacement
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es-archive.timeout 0s
Timeout used for queries. A Timeout of zero means no timeout
--es-archive.tls false
Enable TLS with client certificates.
--es-archive.tls.ca
Path to TLS CA file
--es-archive.tls.cert
Path to TLS certificate file
--es-archive.tls.key
Path to TLS key file
--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
(experimental) 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-archive.max-span-age is not taken into the account and has to be substituted by external component managing read alias.
--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.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-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es.max-num-spans 10000
The maximum number of spans to fetch at a time per query in Elasticsearch
--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.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.sniffer false
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es.tags-as-fields.all false
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file 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.
--es.tags-as-fields.dot-replacement @
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es.timeout 0s
Timeout used for queries. A Timeout of zero means no timeout
--es.tls false
Enable TLS with client certificates.
--es.tls.ca
Path to TLS CA file
--es.tls.cert
Path to TLS certificate file
--es.tls.key
Path to TLS key file
--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
(experimental) 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 is not taken into the account and has to be substituted by external component managing read alias.
--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.
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-ingester
--ingester.deadlockInterval 1m0s
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
--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.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.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.protocol-version
Kafka protocol version - must be supported by kafka server
--kafka.consumer.topic jaeger-spans
The name of the kafka topic to consume from
--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: expvar, prometheus, 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 "env" command for help.

jaeger-ingester with grpc-plugin storage

Flag Default Value
--admin-http-port 14270
The http port for the admin server, including health check, /metrics, etc.
--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.
--grpc-storage-plugin.binary
The location of the plugin binary
--grpc-storage-plugin.configuration-file
A path pointing to the plugin's configuration file, made available to the plugin with the --config arg
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-ingester
--ingester.deadlockInterval 1m0s
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
--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.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.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.protocol-version
Kafka protocol version - must be supported by kafka server
--kafka.consumer.topic jaeger-spans
The name of the kafka topic to consume from
--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: expvar, prometheus, 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 "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:

jaeger-query with cassandra storage

Flag Default Value
--admin-http-port 16687
The http port for the admin server, including health check, /metrics, etc.
--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.enable-dependencies-v2 false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--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 false
Enable TLS
--cassandra-archive.tls.ca
Path to TLS CA file
--cassandra-archive.tls.cert
Path to TLS certificate file
--cassandra-archive.tls.key
Path to TLS key file
--cassandra-archive.tls.server-name
Override the TLS server name
--cassandra-archive.tls.verify-host false
Enable (or disable) host key verification
--cassandra-archive.username
Username for password authentication for Cassandra
--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.enable-dependencies-v2 false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra.keyspace jaeger_v1_test
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 0
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 false
Enable TLS
--cassandra.tls.ca
Path to TLS CA file
--cassandra.tls.cert
Path to TLS certificate file
--cassandra.tls.key
Path to TLS key file
--cassandra.tls.server-name
Override the TLS server name
--cassandra.tls.verify-host true
Enable (or disable) host key 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.
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-query
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--query.base-path /
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagation false
Allow propagation of bearer token to be used by storage plugins
--query.port 16686
The port for the query service
--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 "env" command for help.

jaeger-query with elasticsearch storage

Flag Default Value
--admin-http-port 16687
The http port for the admin server, including health check, /metrics, etc.
--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.bulk.actions 0
The number of requests that can be enqueued before the bulk processor decides to commit
--es-archive.bulk.flush-interval 0s
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 0
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es-archive.bulk.workers 0
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es-archive.create-index-templates false
Create index templates at application startup. Set to false when templates are installed manually.
--es-archive.enabled false
Enable extra storage
--es-archive.index-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es-archive.max-num-spans 0
The maximum number of spans to fetch at a time per query in Elasticsearch
--es-archive.max-span-age 0s
The maximum lookback for spans in Elasticsearch
--es-archive.num-replicas 0
The number of replicas per index in Elasticsearch
--es-archive.num-shards 0
The number of shards per index in Elasticsearch
--es-archive.password
The password required by Elasticsearch
--es-archive.server-urls
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es-archive.sniffer false
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es-archive.tags-as-fields.all false
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file 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.
--es-archive.tags-as-fields.dot-replacement
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es-archive.timeout 0s
Timeout used for queries. A Timeout of zero means no timeout
--es-archive.tls false
Enable TLS with client certificates.
--es-archive.tls.ca
Path to TLS CA file
--es-archive.tls.cert
Path to TLS certificate file
--es-archive.tls.key
Path to TLS key file
--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
(experimental) 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-archive.max-span-age is not taken into the account and has to be substituted by external component managing read alias.
--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.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-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es.max-num-spans 10000
The maximum number of spans to fetch at a time per query in Elasticsearch
--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.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.sniffer false
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es.tags-as-fields.all false
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file 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.
--es.tags-as-fields.dot-replacement @
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es.timeout 0s
Timeout used for queries. A Timeout of zero means no timeout
--es.tls false
Enable TLS with client certificates.
--es.tls.ca
Path to TLS CA file
--es.tls.cert
Path to TLS certificate file
--es.tls.key
Path to TLS key file
--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
(experimental) 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 is not taken into the account and has to be substituted by external component managing read alias.
--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.
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-query
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--query.base-path /
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagation false
Allow propagation of bearer token to be used by storage plugins
--query.port 16686
The port for the query service
--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 "env" command for help.

jaeger-query with grpc-plugin storage

Flag Default Value
--admin-http-port 16687
The http port for the admin server, including health check, /metrics, etc.
--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.
--grpc-storage-plugin.binary
The location of the plugin binary
--grpc-storage-plugin.configuration-file
A path pointing to the plugin's configuration file, made available to the plugin with the --config arg
--health-check-http-port 0
(deprecated) see --admin-http-port
--help false
help for jaeger-query
--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: expvar, prometheus, none
--metrics-http-route /metrics
Defines the route of HTTP endpoint for metrics backends that support scraping
--query.base-path /
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagation false
Allow propagation of bearer token to be used by storage plugins
--query.port 16686
The port for the query service
--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 "env" command for help.