CLI flags

Version  1.20 Latest

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

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14269
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--cassandra-archive.connect-timeout0s
Timeout used for connections to Cassandra Servers
--cassandra-archive.connections-per-host0
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-compressionfalse
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-v2false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra-archive.enabledfalse
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-attempts0
The number of attempts when reading from Cassandra
--cassandra-archive.password
Password for password authentication for Cassandra
--cassandra-archive.port0
The port for cassandra
--cassandra-archive.proto-version0
The Cassandra protocol version
--cassandra-archive.reconnect-interval0s
Reconnect interval to retry connecting to downed hosts
--cassandra-archive.servers
The comma-separated list of Cassandra servers
--cassandra-archive.socket-keep-alive0s
Cassandra's keepalive period to use, enabled if > 0
--cassandra-archive.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--cassandra-archive.tlsfalse
(deprecated) see --cassandra-archive.tls.enabled
--cassandra-archive.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--cassandra-archive.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--cassandra-archive.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--cassandra-archive.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--cassandra-archive.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--cassandra-archive.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--cassandra-archive.tls.verify-hostfalse
(deprecated) Enable (or disable) host key verification. Use cassandra-archive.tls.skip-host-verify instead
--cassandra-archive.username
Username for password authentication for Cassandra
--cassandra.connect-timeout0s
Timeout used for connections to Cassandra Servers
--cassandra.connections-per-host2
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-compressionfalse
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-v2false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra.index.logstrue
Controls log field indexing. Set to false to disable.
--cassandra.index.process-tagstrue
Controls process tag indexing. Set to false to disable.
--cassandra.index.tag-blacklist
The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option.
--cassandra.index.tag-whitelist
The comma-separated list of span tags to whitelist for being indexed. All other tags will not be indexed. Mutually exclusive with the blacklist option.
--cassandra.index.tagstrue
Controls tag indexing. Set to false to disable.
--cassandra.keyspacejaeger_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-attempts3
The number of attempts when reading from Cassandra
--cassandra.password
Password for password authentication for Cassandra
--cassandra.port0
The port for cassandra
--cassandra.proto-version4
The Cassandra protocol version
--cassandra.reconnect-interval1m0s
Reconnect interval to retry connecting to downed hosts
--cassandra.servers127.0.0.1
The comma-separated list of Cassandra servers
--cassandra.socket-keep-alive0s
Cassandra's keepalive period to use, enabled if > 0
--cassandra.span-store-write-cache-ttl12h0m0s
The duration to wait before rewriting an existing service or operation name
--cassandra.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--cassandra.tlsfalse
(deprecated) see --cassandra.tls.enabled
--cassandra.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--cassandra.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--cassandra.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--cassandra.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--cassandra.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--cassandra.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--cassandra.tls.verify-hostfalse
(deprecated) Enable (or disable) host key verification. Use cassandra.tls.skip-host-verify instead
--cassandra.username
Username for password authentication for Cassandra
--collector.grpc-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.grpc-server.host-port
--collector.grpc-server.host-port:14250
The host:port (e.g. 127.0.0.1:14250 or :14250) of the collector's GRPC server
--collector.grpc.tlsfalse
(deprecated) see --collector.grpc.tls.enabled
--collector.grpc.tls.cert
Path to a TLS Certificate file, used to identify this server to clients
--collector.grpc.tls.client-ca
Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.client.ca
(deprecated) see --collector.grpc.tls.client-ca
--collector.grpc.tls.enabledfalse
Enable TLS on the server
--collector.grpc.tls.key
Path to a TLS Private Key file, used to identify this server to clients
--collector.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.http-server.host-port
--collector.http-server.host-port:14268
The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's HTTP server
--collector.num-workers50
The number of workers pulling items from the queue
--collector.queue-size2000
The queue size of the collector
--collector.queue-size-memory0
(experimental) The max memory size in MiB to use for the dynamic queue.
--collector.tags
One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue}
--collector.zipkin.allowed-headerscontent-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.host-port:0
The host:port (e.g. 127.0.0.1:5555 or :5555) of the collector's Zipkin server
--collector.zipkin.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.zipkin.host-port
--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.ratio1
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-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
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)
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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-size65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-binary.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-binary.workers10
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-size65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-compact.workers10
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-size65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size1000
length of the queue for the UDP server
--processor.zipkin-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.zipkin-compact.workers10
how many workers the processor should run
--query.additional-headers[]
Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value"
--query.base-path/
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagationfalse
Allow propagation of bearer token to be used by storage plugins
--query.grpc-server.host-port:16685
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's gRPC server
--query.host-port:16686
(deprecated, will be removed after 2020-12-31 or in release v1.21.0, whichever is later) see --query.http-server.host-port and --query.grpc-server.host-port
--query.http-server.host-port:16686
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's HTTP server
--query.max-clock-skew-adjustment0s
The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments
--query.port0
(deprecated, will be removed after 2020-08-31 or in release v1.20.0, whichever is later) see --query.host-port
--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-peers3
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.max3
Sets the maximum number of retries for a call
--reporter.grpc.tlsfalse
(deprecated) see --reporter.grpc.tls.enabled
--reporter.grpc.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--reporter.grpc.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--reporter.grpc.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--reporter.grpc.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--reporter.grpc.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--reporter.grpc.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--reporter.typegrpc
Reporter type to use e.g. grpc
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--sampling.strategies-reload-interval0s
Reload interval to check and reload sampling strategies file. Zero value means no reloading
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.

jaeger-all-in-one with elasticsearch storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14269
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--collector.grpc-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.grpc-server.host-port
--collector.grpc-server.host-port:14250
The host:port (e.g. 127.0.0.1:14250 or :14250) of the collector's GRPC server
--collector.grpc.tlsfalse
(deprecated) see --collector.grpc.tls.enabled
--collector.grpc.tls.cert
Path to a TLS Certificate file, used to identify this server to clients
--collector.grpc.tls.client-ca
Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.client.ca
(deprecated) see --collector.grpc.tls.client-ca
--collector.grpc.tls.enabledfalse
Enable TLS on the server
--collector.grpc.tls.key
Path to a TLS Private Key file, used to identify this server to clients
--collector.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.http-server.host-port
--collector.http-server.host-port:14268
The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's HTTP server
--collector.num-workers50
The number of workers pulling items from the queue
--collector.queue-size2000
The queue size of the collector
--collector.queue-size-memory0
(experimental) The max memory size in MiB to use for the dynamic queue.
--collector.tags
One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue}
--collector.zipkin.allowed-headerscontent-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.host-port:0
The host:port (e.g. 127.0.0.1:5555 or :5555) of the collector's Zipkin server
--collector.zipkin.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.zipkin.host-port
--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.ratio1
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.actions0
The number of requests that can be enqueued before the bulk processor decides to commit
--es-archive.bulk.flush-interval0s
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.size0
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es-archive.bulk.workers0
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es-archive.create-index-templatesfalse
Create index templates at application startup. Set to false when templates are installed manually.
--es-archive.enabledfalse
Enable extra storage
--es-archive.index-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es-archive.max-doc-count0
The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
--es-archive.max-num-spans0
(deprecated, will be removed in release v1.21.0. Please use es.max-doc-count). The maximum number of spans to fetch at a time per query in Elasticsearch. The lesser of es.max-num-spans and es.max-doc-count will be used if both are set.
--es-archive.max-span-age0s
The maximum lookback for spans in Elasticsearch
--es-archive.num-replicas0
The number of replicas per index in Elasticsearch
--es-archive.num-shards0
The number of shards per index in Elasticsearch
--es-archive.password
The password required by Elasticsearch
--es-archive.server-urlshttp://127.0.0.1:9200
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es-archive.snifferfalse
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es-archive.sniffer-tls-enabledfalse
Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
--es-archive.tags-as-fields.allfalse
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects.
--es-archive.tags-as-fields.config-file
(experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include
--es-archive.tags-as-fields.dot-replacement
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es-archive.tags-as-fields.include
(experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
--es-archive.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--es-archive.tlsfalse
(deprecated) see --es-archive.tls.enabled
--es-archive.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--es-archive.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--es-archive.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--es-archive.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--es-archive.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--es-archive.tls.skip-host-verifyfalse
(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-aliasesfalse
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.version0
The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
--es.bulk.actions1000
The number of requests that can be enqueued before the bulk processor decides to commit
--es.bulk.flush-interval200ms
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.size5000000
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es.bulk.workers1
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es.create-index-templatestrue
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-doc-count10000
The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
--es.max-num-spans10000
(deprecated, will be removed in release v1.21.0. Please use es.max-doc-count). The maximum number of spans to fetch at a time per query in Elasticsearch. The lesser of es.max-num-spans and es.max-doc-count will be used if both are set.
--es.max-span-age72h0m0s
The maximum lookback for spans in Elasticsearch
--es.num-replicas1
The number of replicas per index in Elasticsearch
--es.num-shards5
The number of shards per index in Elasticsearch
--es.password
The password required by Elasticsearch
--es.server-urlshttp://127.0.0.1:9200
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es.snifferfalse
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es.sniffer-tls-enabledfalse
Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
--es.tags-as-fields.allfalse
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects.
--es.tags-as-fields.config-file
(experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include
--es.tags-as-fields.dot-replacement@
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es.tags-as-fields.include
(experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
--es.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--es.tlsfalse
(deprecated) see --es.tls.enabled
--es.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--es.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--es.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--es.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--es.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--es.tls.skip-host-verifyfalse
(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-aliasesfalse
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.version0
The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
--health-check-http-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
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)
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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-size65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-binary.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-binary.workers10
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-size65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-compact.workers10
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-size65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size1000
length of the queue for the UDP server
--processor.zipkin-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.zipkin-compact.workers10
how many workers the processor should run
--query.additional-headers[]
Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value"
--query.base-path/
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagationfalse
Allow propagation of bearer token to be used by storage plugins
--query.grpc-server.host-port:16685
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's gRPC server
--query.host-port:16686
(deprecated, will be removed after 2020-12-31 or in release v1.21.0, whichever is later) see --query.http-server.host-port and --query.grpc-server.host-port
--query.http-server.host-port:16686
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's HTTP server
--query.max-clock-skew-adjustment0s
The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments
--query.port0
(deprecated, will be removed after 2020-08-31 or in release v1.20.0, whichever is later) see --query.host-port
--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-peers3
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.max3
Sets the maximum number of retries for a call
--reporter.grpc.tlsfalse
(deprecated) see --reporter.grpc.tls.enabled
--reporter.grpc.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--reporter.grpc.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--reporter.grpc.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--reporter.grpc.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--reporter.grpc.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--reporter.grpc.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--reporter.typegrpc
Reporter type to use e.g. grpc
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--sampling.strategies-reload-interval0s
Reload interval to check and reload sampling strategies file. Zero value means no reloading
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.

jaeger-all-in-one with memory storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14269
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--collector.grpc-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.grpc-server.host-port
--collector.grpc-server.host-port:14250
The host:port (e.g. 127.0.0.1:14250 or :14250) of the collector's GRPC server
--collector.grpc.tlsfalse
(deprecated) see --collector.grpc.tls.enabled
--collector.grpc.tls.cert
Path to a TLS Certificate file, used to identify this server to clients
--collector.grpc.tls.client-ca
Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.client.ca
(deprecated) see --collector.grpc.tls.client-ca
--collector.grpc.tls.enabledfalse
Enable TLS on the server
--collector.grpc.tls.key
Path to a TLS Private Key file, used to identify this server to clients
--collector.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.http-server.host-port
--collector.http-server.host-port:14268
The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's HTTP server
--collector.num-workers50
The number of workers pulling items from the queue
--collector.queue-size2000
The queue size of the collector
--collector.queue-size-memory0
(experimental) The max memory size in MiB to use for the dynamic queue.
--collector.tags
One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue}
--collector.zipkin.allowed-headerscontent-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.host-port:0
The host:port (e.g. 127.0.0.1:5555 or :5555) of the collector's Zipkin server
--collector.zipkin.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.zipkin.host-port
--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.ratio1
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-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
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)
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--memory.max-traces0
The maximum amount of traces to store in memory. The default number of traces is unbounded.
--metrics-backendprometheus
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-size65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-binary.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-binary.workers10
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-size65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-compact.workers10
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-size65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size1000
length of the queue for the UDP server
--processor.zipkin-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.zipkin-compact.workers10
how many workers the processor should run
--query.additional-headers[]
Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value"
--query.base-path/
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagationfalse
Allow propagation of bearer token to be used by storage plugins
--query.grpc-server.host-port:16685
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's gRPC server
--query.host-port:16686
(deprecated, will be removed after 2020-12-31 or in release v1.21.0, whichever is later) see --query.http-server.host-port and --query.grpc-server.host-port
--query.http-server.host-port:16686
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's HTTP server
--query.max-clock-skew-adjustment0s
The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments
--query.port0
(deprecated, will be removed after 2020-08-31 or in release v1.20.0, whichever is later) see --query.host-port
--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-peers3
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.max3
Sets the maximum number of retries for a call
--reporter.grpc.tlsfalse
(deprecated) see --reporter.grpc.tls.enabled
--reporter.grpc.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--reporter.grpc.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--reporter.grpc.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--reporter.grpc.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--reporter.grpc.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--reporter.grpc.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--reporter.typegrpc
Reporter type to use e.g. grpc
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--sampling.strategies-reload-interval0s
Reload interval to check and reload sampling strategies file. Zero value means no reloading
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.

jaeger-all-in-one with badger storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14269
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--badger.consistencyfalse
If all writes should be synced immediately to physical disk. This will impact write performance.
--badger.directory-key/go/bin/data/keys
Path to store the keys (indexes), this directory should reside in SSD disk. Set ephemeral to false if you want to define this setting.
--badger.directory-value/go/bin/data/values
Path to store the values (spans). Set ephemeral to false if you want to define this setting.
--badger.ephemeraltrue
Mark this storage ephemeral, data is stored in tmpfs.
--badger.maintenance-interval5m0s
How often the maintenance thread for values is ran. Format is time.Duration (https://golang.org/pkg/time/#Duration)
--badger.metrics-update-interval10s
How often the badger metrics are collected by Jaeger. Format is time.Duration (https://golang.org/pkg/time/#Duration)
--badger.read-onlyfalse
Allows to open badger database in read only mode. Multiple instances can open same database in read-only mode. Values still in the write-ahead-log must be replayed before opening.
--badger.span-store-ttl72h0m0s
How long to store the data. Format is time.Duration (https://golang.org/pkg/time/#Duration)
--badger.truncatefalse
If write-ahead-log should be truncated on restart. this will cause data loss.
--collector.grpc-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.grpc-server.host-port
--collector.grpc-server.host-port:14250
The host:port (e.g. 127.0.0.1:14250 or :14250) of the collector's GRPC server
--collector.grpc.tlsfalse
(deprecated) see --collector.grpc.tls.enabled
--collector.grpc.tls.cert
Path to a TLS Certificate file, used to identify this server to clients
--collector.grpc.tls.client-ca
Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.client.ca
(deprecated) see --collector.grpc.tls.client-ca
--collector.grpc.tls.enabledfalse
Enable TLS on the server
--collector.grpc.tls.key
Path to a TLS Private Key file, used to identify this server to clients
--collector.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.http-server.host-port
--collector.http-server.host-port:14268
The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's HTTP server
--collector.num-workers50
The number of workers pulling items from the queue
--collector.queue-size2000
The queue size of the collector
--collector.queue-size-memory0
(experimental) The max memory size in MiB to use for the dynamic queue.
--collector.tags
One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue}
--collector.zipkin.allowed-headerscontent-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.host-port:0
The host:port (e.g. 127.0.0.1:5555 or :5555) of the collector's Zipkin server
--collector.zipkin.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.zipkin.host-port
--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.ratio1
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-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
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)
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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-size65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-binary.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-binary.workers10
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-size65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-compact.workers10
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-size65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size1000
length of the queue for the UDP server
--processor.zipkin-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.zipkin-compact.workers10
how many workers the processor should run
--query.additional-headers[]
Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value"
--query.base-path/
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagationfalse
Allow propagation of bearer token to be used by storage plugins
--query.grpc-server.host-port:16685
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's gRPC server
--query.host-port:16686
(deprecated, will be removed after 2020-12-31 or in release v1.21.0, whichever is later) see --query.http-server.host-port and --query.grpc-server.host-port
--query.http-server.host-port:16686
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's HTTP server
--query.max-clock-skew-adjustment0s
The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments
--query.port0
(deprecated, will be removed after 2020-08-31 or in release v1.20.0, whichever is later) see --query.host-port
--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-peers3
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.max3
Sets the maximum number of retries for a call
--reporter.grpc.tlsfalse
(deprecated) see --reporter.grpc.tls.enabled
--reporter.grpc.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--reporter.grpc.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--reporter.grpc.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--reporter.grpc.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--reporter.grpc.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--reporter.grpc.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--reporter.typegrpc
Reporter type to use e.g. grpc
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--sampling.strategies-reload-interval0s
Reload interval to check and reload sampling strategies file. Zero value means no reloading
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.

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

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14269
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--collector.grpc-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.grpc-server.host-port
--collector.grpc-server.host-port:14250
The host:port (e.g. 127.0.0.1:14250 or :14250) of the collector's GRPC server
--collector.grpc.tlsfalse
(deprecated) see --collector.grpc.tls.enabled
--collector.grpc.tls.cert
Path to a TLS Certificate file, used to identify this server to clients
--collector.grpc.tls.client-ca
Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.client.ca
(deprecated) see --collector.grpc.tls.client-ca
--collector.grpc.tls.enabledfalse
Enable TLS on the server
--collector.grpc.tls.key
Path to a TLS Private Key file, used to identify this server to clients
--collector.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.http-server.host-port
--collector.http-server.host-port:14268
The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's HTTP server
--collector.num-workers50
The number of workers pulling items from the queue
--collector.queue-size2000
The queue size of the collector
--collector.queue-size-memory0
(experimental) The max memory size in MiB to use for the dynamic queue.
--collector.tags
One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue}
--collector.zipkin.allowed-headerscontent-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.host-port:0
The host:port (e.g. 127.0.0.1:5555 or :5555) of the collector's Zipkin server
--collector.zipkin.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.zipkin.host-port
--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.ratio1
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
--grpc-storage-plugin.log-levelwarn
Set the log level of the plugin's logger
--health-check-http-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
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)
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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-size65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-binary.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-binary.workers10
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-size65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-compact.workers10
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-size65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size1000
length of the queue for the UDP server
--processor.zipkin-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.zipkin-compact.workers10
how many workers the processor should run
--query.additional-headers[]
Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value"
--query.base-path/
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagationfalse
Allow propagation of bearer token to be used by storage plugins
--query.grpc-server.host-port:16685
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's gRPC server
--query.host-port:16686
(deprecated, will be removed after 2020-12-31 or in release v1.21.0, whichever is later) see --query.http-server.host-port and --query.grpc-server.host-port
--query.http-server.host-port:16686
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's HTTP server
--query.max-clock-skew-adjustment0s
The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments
--query.port0
(deprecated, will be removed after 2020-08-31 or in release v1.20.0, whichever is later) see --query.host-port
--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-peers3
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.max3
Sets the maximum number of retries for a call
--reporter.grpc.tlsfalse
(deprecated) see --reporter.grpc.tls.enabled
--reporter.grpc.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--reporter.grpc.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--reporter.grpc.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--reporter.grpc.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--reporter.grpc.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--reporter.grpc.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--reporter.typegrpc
Reporter type to use e.g. grpc
--sampling.strategies-file
The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
--sampling.strategies-reload-interval0s
Reload interval to check and reload sampling strategies file. Zero value means no reloading
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the '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.

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14271
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--agent.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}
--config-file
Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
--health-check-http-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
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
(deprecated) see --agent.tags
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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-size65000
max packet size for the UDP server
--processor.jaeger-binary.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-binary.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-binary.workers10
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-size65000
max packet size for the UDP server
--processor.jaeger-compact.server-queue-size1000
length of the queue for the UDP server
--processor.jaeger-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.jaeger-compact.workers10
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-size65000
max packet size for the UDP server
--processor.zipkin-compact.server-queue-size1000
length of the queue for the UDP server
--processor.zipkin-compact.server-socket-buffer-size0
socket buffer size for UDP packets in bytes
--processor.zipkin-compact.workers10
how many workers the processor should run
--reporter.grpc.discovery.min-peers3
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.max3
Sets the maximum number of retries for a call
--reporter.grpc.tlsfalse
(deprecated) see --reporter.grpc.tls.enabled
--reporter.grpc.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--reporter.grpc.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--reporter.grpc.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--reporter.grpc.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--reporter.grpc.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--reporter.grpc.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--reporter.typegrpc
Reporter type to use e.g. grpc

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

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14269
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--cassandra-archive.connect-timeout0s
Timeout used for connections to Cassandra Servers
--cassandra-archive.connections-per-host0
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-compressionfalse
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-v2false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra-archive.enabledfalse
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-attempts0
The number of attempts when reading from Cassandra
--cassandra-archive.password
Password for password authentication for Cassandra
--cassandra-archive.port0
The port for cassandra
--cassandra-archive.proto-version0
The Cassandra protocol version
--cassandra-archive.reconnect-interval0s
Reconnect interval to retry connecting to downed hosts
--cassandra-archive.servers
The comma-separated list of Cassandra servers
--cassandra-archive.socket-keep-alive0s
Cassandra's keepalive period to use, enabled if > 0
--cassandra-archive.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--cassandra-archive.tlsfalse
(deprecated) see --cassandra-archive.tls.enabled
--cassandra-archive.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--cassandra-archive.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--cassandra-archive.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--cassandra-archive.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--cassandra-archive.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--cassandra-archive.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--cassandra-archive.tls.verify-hostfalse
(deprecated) Enable (or disable) host key verification. Use cassandra-archive.tls.skip-host-verify instead
--cassandra-archive.username
Username for password authentication for Cassandra
--cassandra.connect-timeout0s
Timeout used for connections to Cassandra Servers
--cassandra.connections-per-host2
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-compressionfalse
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-v2false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra.index.logstrue
Controls log field indexing. Set to false to disable.
--cassandra.index.process-tagstrue
Controls process tag indexing. Set to false to disable.
--cassandra.index.tag-blacklist
The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option.
--cassandra.index.tag-whitelist
The comma-separated list of span tags to whitelist for being indexed. All other tags will not be indexed. Mutually exclusive with the blacklist option.
--cassandra.index.tagstrue
Controls tag indexing. Set to false to disable.
--cassandra.keyspacejaeger_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-attempts3
The number of attempts when reading from Cassandra
--cassandra.password
Password for password authentication for Cassandra
--cassandra.port0
The port for cassandra
--cassandra.proto-version4
The Cassandra protocol version
--cassandra.reconnect-interval1m0s
Reconnect interval to retry connecting to downed hosts
--cassandra.servers127.0.0.1
The comma-separated list of Cassandra servers
--cassandra.socket-keep-alive0s
Cassandra's keepalive period to use, enabled if > 0
--cassandra.span-store-write-cache-ttl12h0m0s
The duration to wait before rewriting an existing service or operation name
--cassandra.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--cassandra.tlsfalse
(deprecated) see --cassandra.tls.enabled
--cassandra.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--cassandra.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--cassandra.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--cassandra.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--cassandra.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--cassandra.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--cassandra.tls.verify-hostfalse
(deprecated) Enable (or disable) host key verification. Use cassandra.tls.skip-host-verify instead
--cassandra.username
Username for password authentication for Cassandra
--collector.grpc-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.grpc-server.host-port
--collector.grpc-server.host-port:14250
The host:port (e.g. 127.0.0.1:14250 or :14250) of the collector's GRPC server
--collector.grpc.tlsfalse
(deprecated) see --collector.grpc.tls.enabled
--collector.grpc.tls.cert
Path to a TLS Certificate file, used to identify this server to clients
--collector.grpc.tls.client-ca
Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.client.ca
(deprecated) see --collector.grpc.tls.client-ca
--collector.grpc.tls.enabledfalse
Enable TLS on the server
--collector.grpc.tls.key
Path to a TLS Private Key file, used to identify this server to clients
--collector.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.http-server.host-port
--collector.http-server.host-port:14268
The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's HTTP server
--collector.num-workers50
The number of workers pulling items from the queue
--collector.queue-size2000
The queue size of the collector
--collector.queue-size-memory0
(experimental) The max memory size in MiB to use for the dynamic queue.
--collector.tags
One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue}
--collector.zipkin.allowed-headerscontent-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.host-port:0
The host:port (e.g. 127.0.0.1:5555 or :5555) of the collector's Zipkin server
--collector.zipkin.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.zipkin.host-port
--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.ratio1
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-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
help for jaeger-collector
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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
--sampling.strategies-reload-interval0s
Reload interval to check and reload sampling strategies file. Zero value means no reloading
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.

jaeger-collector with elasticsearch storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14269
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--collector.grpc-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.grpc-server.host-port
--collector.grpc-server.host-port:14250
The host:port (e.g. 127.0.0.1:14250 or :14250) of the collector's GRPC server
--collector.grpc.tlsfalse
(deprecated) see --collector.grpc.tls.enabled
--collector.grpc.tls.cert
Path to a TLS Certificate file, used to identify this server to clients
--collector.grpc.tls.client-ca
Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.client.ca
(deprecated) see --collector.grpc.tls.client-ca
--collector.grpc.tls.enabledfalse
Enable TLS on the server
--collector.grpc.tls.key
Path to a TLS Private Key file, used to identify this server to clients
--collector.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.http-server.host-port
--collector.http-server.host-port:14268
The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's HTTP server
--collector.num-workers50
The number of workers pulling items from the queue
--collector.queue-size2000
The queue size of the collector
--collector.queue-size-memory0
(experimental) The max memory size in MiB to use for the dynamic queue.
--collector.tags
One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue}
--collector.zipkin.allowed-headerscontent-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.host-port:0
The host:port (e.g. 127.0.0.1:5555 or :5555) of the collector's Zipkin server
--collector.zipkin.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.zipkin.host-port
--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.ratio1
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.actions0
The number of requests that can be enqueued before the bulk processor decides to commit
--es-archive.bulk.flush-interval0s
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.size0
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es-archive.bulk.workers0
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es-archive.create-index-templatesfalse
Create index templates at application startup. Set to false when templates are installed manually.
--es-archive.enabledfalse
Enable extra storage
--es-archive.index-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es-archive.max-doc-count0
The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
--es-archive.max-num-spans0
(deprecated, will be removed in release v1.21.0. Please use es.max-doc-count). The maximum number of spans to fetch at a time per query in Elasticsearch. The lesser of es.max-num-spans and es.max-doc-count will be used if both are set.
--es-archive.max-span-age0s
The maximum lookback for spans in Elasticsearch
--es-archive.num-replicas0
The number of replicas per index in Elasticsearch
--es-archive.num-shards0
The number of shards per index in Elasticsearch
--es-archive.password
The password required by Elasticsearch
--es-archive.server-urlshttp://127.0.0.1:9200
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es-archive.snifferfalse
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es-archive.sniffer-tls-enabledfalse
Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
--es-archive.tags-as-fields.allfalse
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects.
--es-archive.tags-as-fields.config-file
(experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include
--es-archive.tags-as-fields.dot-replacement
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es-archive.tags-as-fields.include
(experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
--es-archive.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--es-archive.tlsfalse
(deprecated) see --es-archive.tls.enabled
--es-archive.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--es-archive.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--es-archive.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--es-archive.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--es-archive.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--es-archive.tls.skip-host-verifyfalse
(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-aliasesfalse
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.version0
The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
--es.bulk.actions1000
The number of requests that can be enqueued before the bulk processor decides to commit
--es.bulk.flush-interval200ms
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.size5000000
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es.bulk.workers1
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es.create-index-templatestrue
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-doc-count10000
The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
--es.max-num-spans10000
(deprecated, will be removed in release v1.21.0. Please use es.max-doc-count). The maximum number of spans to fetch at a time per query in Elasticsearch. The lesser of es.max-num-spans and es.max-doc-count will be used if both are set.
--es.max-span-age72h0m0s
The maximum lookback for spans in Elasticsearch
--es.num-replicas1
The number of replicas per index in Elasticsearch
--es.num-shards5
The number of shards per index in Elasticsearch
--es.password
The password required by Elasticsearch
--es.server-urlshttp://127.0.0.1:9200
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es.snifferfalse
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es.sniffer-tls-enabledfalse
Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
--es.tags-as-fields.allfalse
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects.
--es.tags-as-fields.config-file
(experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include
--es.tags-as-fields.dot-replacement@
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es.tags-as-fields.include
(experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
--es.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--es.tlsfalse
(deprecated) see --es.tls.enabled
--es.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--es.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--es.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--es.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--es.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--es.tls.skip-host-verifyfalse
(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-aliasesfalse
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.version0
The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
--health-check-http-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
help for jaeger-collector
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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
--sampling.strategies-reload-interval0s
Reload interval to check and reload sampling strategies file. Zero value means no reloading
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.

jaeger-collector with kafka storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14269
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--collector.grpc-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.grpc-server.host-port
--collector.grpc-server.host-port:14250
The host:port (e.g. 127.0.0.1:14250 or :14250) of the collector's GRPC server
--collector.grpc.tlsfalse
(deprecated) see --collector.grpc.tls.enabled
--collector.grpc.tls.cert
Path to a TLS Certificate file, used to identify this server to clients
--collector.grpc.tls.client-ca
Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.client.ca
(deprecated) see --collector.grpc.tls.client-ca
--collector.grpc.tls.enabledfalse
Enable TLS on the server
--collector.grpc.tls.key
Path to a TLS Private Key file, used to identify this server to clients
--collector.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.http-server.host-port
--collector.http-server.host-port:14268
The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's HTTP server
--collector.num-workers50
The number of workers pulling items from the queue
--collector.queue-size2000
The queue size of the collector
--collector.queue-size-memory0
(experimental) The max memory size in MiB to use for the dynamic queue.
--collector.tags
One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue}
--collector.zipkin.allowed-headerscontent-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.host-port:0
The host:port (e.g. 127.0.0.1:5555 or :5555) of the collector's Zipkin server
--collector.zipkin.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.zipkin.host-port
--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.ratio1
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-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
help for jaeger-collector
--kafka.producer.authenticationnone
Authentication type used to authenticate with kafka cluster. e.g. none, kerberos, tls
--kafka.producer.batch-linger0s
(experimental) Time interval to wait before sending records to Kafka. Higher value reduce request to Kafka but increase latency and the possibility of data loss in case of process restart. See https://kafka.apache.org/documentation/
--kafka.producer.batch-max-messages0
(experimental) Maximum number of message to batch before sending records to Kafka
--kafka.producer.batch-min-messages0
(experimental) The best-effort minimum number of messages needed to send a batch of records to Kafka. Higher value reduce request to Kafka but increase latency and the possibility of data loss in case of process restart. See https://kafka.apache.org/documentation/
--kafka.producer.batch-size0
(experimental) Number of bytes to batch before sending records to Kafka. Higher value reduce request to Kafka but increase latency and the possibility of data loss in case of process restart. See https://kafka.apache.org/documentation/
--kafka.producer.brokers127.0.0.1:9092
The comma-separated list of kafka brokers. i.e. '127.0.0.1:9092,0.0.0:1234'
--kafka.producer.compressionnone
(experimental) Type of compression (none, gzip, snappy, lz4, zstd) to use on messages
--kafka.producer.compression-level0
(experimental) compression level to use on messages. gzip = 1-9 (default = 6), snappy = none, lz4 = 1-17 (default = 9), zstd = -131072 - 22 (default = 3)
--kafka.producer.encodingprotobuf
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-namekafka
Kerberos service name
--kafka.producer.kerberos.use-keytabfalse
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.plaintext.password
The plaintext Password for SASL/PLAIN authentication
--kafka.producer.plaintext.username
The plaintext Username for SASL/PLAIN authentication
--kafka.producer.protocol-version
Kafka protocol version - must be supported by kafka server
--kafka.producer.required-ackslocal
(experimental) Required kafka broker acknowledgement. i.e. noack, local, all
--kafka.producer.tlsfalse
(deprecated) see --kafka.producer.tls.enabled
--kafka.producer.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--kafka.producer.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--kafka.producer.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--kafka.producer.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--kafka.producer.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--kafka.producer.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--kafka.producer.topicjaeger-spans
The name of the kafka topic
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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
--sampling.strategies-reload-interval0s
Reload interval to check and reload sampling strategies file. Zero value means no reloading
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.

jaeger-collector with grpc-plugin storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14269
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--collector.grpc-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.grpc-server.host-port
--collector.grpc-server.host-port:14250
The host:port (e.g. 127.0.0.1:14250 or :14250) of the collector's GRPC server
--collector.grpc.tlsfalse
(deprecated) see --collector.grpc.tls.enabled
--collector.grpc.tls.cert
Path to a TLS Certificate file, used to identify this server to clients
--collector.grpc.tls.client-ca
Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.client.ca
(deprecated) see --collector.grpc.tls.client-ca
--collector.grpc.tls.enabledfalse
Enable TLS on the server
--collector.grpc.tls.key
Path to a TLS Private Key file, used to identify this server to clients
--collector.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.http-server.host-port
--collector.http-server.host-port:14268
The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's HTTP server
--collector.num-workers50
The number of workers pulling items from the queue
--collector.queue-size2000
The queue size of the collector
--collector.queue-size-memory0
(experimental) The max memory size in MiB to use for the dynamic queue.
--collector.tags
One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue}
--collector.zipkin.allowed-headerscontent-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.host-port:0
The host:port (e.g. 127.0.0.1:5555 or :5555) of the collector's Zipkin server
--collector.zipkin.http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --collector.zipkin.host-port
--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.ratio1
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
--grpc-storage-plugin.log-levelwarn
Set the log level of the plugin's logger
--health-check-http-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
help for jaeger-collector
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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
--sampling.strategies-reload-interval0s
Reload interval to check and reload sampling strategies file. Zero value means no reloading
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.

jaeger-ingester

Jaeger ingester consumes spans from a particular Kafka topic and writes them to a configured storage.

jaeger-ingester can be used with these storage backends:

jaeger-ingester with cassandra storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14270
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--cassandra-archive.connect-timeout0s
Timeout used for connections to Cassandra Servers
--cassandra-archive.connections-per-host0
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-compressionfalse
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-v2false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra-archive.enabledfalse
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-attempts0
The number of attempts when reading from Cassandra
--cassandra-archive.password
Password for password authentication for Cassandra
--cassandra-archive.port0
The port for cassandra
--cassandra-archive.proto-version0
The Cassandra protocol version
--cassandra-archive.reconnect-interval0s
Reconnect interval to retry connecting to downed hosts
--cassandra-archive.servers
The comma-separated list of Cassandra servers
--cassandra-archive.socket-keep-alive0s
Cassandra's keepalive period to use, enabled if > 0
--cassandra-archive.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--cassandra-archive.tlsfalse
(deprecated) see --cassandra-archive.tls.enabled
--cassandra-archive.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--cassandra-archive.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--cassandra-archive.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--cassandra-archive.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--cassandra-archive.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--cassandra-archive.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--cassandra-archive.tls.verify-hostfalse
(deprecated) Enable (or disable) host key verification. Use cassandra-archive.tls.skip-host-verify instead
--cassandra-archive.username
Username for password authentication for Cassandra
--cassandra.connect-timeout0s
Timeout used for connections to Cassandra Servers
--cassandra.connections-per-host2
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-compressionfalse
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-v2false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra.index.logstrue
Controls log field indexing. Set to false to disable.
--cassandra.index.process-tagstrue
Controls process tag indexing. Set to false to disable.
--cassandra.index.tag-blacklist
The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option.
--cassandra.index.tag-whitelist
The comma-separated list of span tags to whitelist for being indexed. All other tags will not be indexed. Mutually exclusive with the blacklist option.
--cassandra.index.tagstrue
Controls tag indexing. Set to false to disable.
--cassandra.keyspacejaeger_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-attempts3
The number of attempts when reading from Cassandra
--cassandra.password
Password for password authentication for Cassandra
--cassandra.port0
The port for cassandra
--cassandra.proto-version4
The Cassandra protocol version
--cassandra.reconnect-interval1m0s
Reconnect interval to retry connecting to downed hosts
--cassandra.servers127.0.0.1
The comma-separated list of Cassandra servers
--cassandra.socket-keep-alive0s
Cassandra's keepalive period to use, enabled if > 0
--cassandra.span-store-write-cache-ttl12h0m0s
The duration to wait before rewriting an existing service or operation name
--cassandra.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--cassandra.tlsfalse
(deprecated) see --cassandra.tls.enabled
--cassandra.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--cassandra.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--cassandra.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--cassandra.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--cassandra.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--cassandra.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--cassandra.tls.verify-hostfalse
(deprecated) Enable (or disable) host key verification. Use cassandra.tls.skip-host-verify instead
--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.ratio1
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-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
help for jaeger-ingester
--ingester.deadlockInterval0s
Interval to check for deadlocks. If no messages gets processed in given time, ingester app will exit. Value of 0 disables deadlock check.
--ingester.parallelism1000
The number of messages to process in parallel
--kafka.consumer.authenticationnone
Authentication type used to authenticate with kafka cluster. e.g. none, kerberos, tls
--kafka.consumer.brokers127.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-idjaeger-ingester
The Consumer Client ID that ingester will use
--kafka.consumer.encodingprotobuf
The encoding of spans ("json", "protobuf", "zipkin-thrift") consumed from kafka
--kafka.consumer.group-idjaeger-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-namekafka
Kerberos service name
--kafka.consumer.kerberos.use-keytabfalse
Use of keytab instead of password, if this is true, keytab file will be used instead of password
--kafka.consumer.kerberos.username
The Kerberos username used for authenticate with KDC
--kafka.consumer.plaintext.password
The plaintext Password for SASL/PLAIN authentication
--kafka.consumer.plaintext.username
The plaintext Username for SASL/PLAIN authentication
--kafka.consumer.protocol-version
Kafka protocol version - must be supported by kafka server
--kafka.consumer.tlsfalse
(deprecated) see --kafka.consumer.tls.enabled
--kafka.consumer.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--kafka.consumer.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--kafka.consumer.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--kafka.consumer.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--kafka.consumer.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--kafka.consumer.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--kafka.consumer.topicjaeger-spans
The name of the kafka topic to consume from
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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 the 'env' command for help.

jaeger-ingester with elasticsearch storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14270
The host:port (e.g. 127.0.0.1:5555 or :5555) 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.ratio1
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.actions0
The number of requests that can be enqueued before the bulk processor decides to commit
--es-archive.bulk.flush-interval0s
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.size0
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es-archive.bulk.workers0
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es-archive.create-index-templatesfalse
Create index templates at application startup. Set to false when templates are installed manually.
--es-archive.enabledfalse
Enable extra storage
--es-archive.index-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es-archive.max-doc-count0
The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
--es-archive.max-num-spans0
(deprecated, will be removed in release v1.21.0. Please use es.max-doc-count). The maximum number of spans to fetch at a time per query in Elasticsearch. The lesser of es.max-num-spans and es.max-doc-count will be used if both are set.
--es-archive.max-span-age0s
The maximum lookback for spans in Elasticsearch
--es-archive.num-replicas0
The number of replicas per index in Elasticsearch
--es-archive.num-shards0
The number of shards per index in Elasticsearch
--es-archive.password
The password required by Elasticsearch
--es-archive.server-urlshttp://127.0.0.1:9200
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es-archive.snifferfalse
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es-archive.sniffer-tls-enabledfalse
Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
--es-archive.tags-as-fields.allfalse
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects.
--es-archive.tags-as-fields.config-file
(experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include
--es-archive.tags-as-fields.dot-replacement
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es-archive.tags-as-fields.include
(experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
--es-archive.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--es-archive.tlsfalse
(deprecated) see --es-archive.tls.enabled
--es-archive.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--es-archive.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--es-archive.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--es-archive.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--es-archive.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--es-archive.tls.skip-host-verifyfalse
(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-aliasesfalse
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.version0
The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
--es.bulk.actions1000
The number of requests that can be enqueued before the bulk processor decides to commit
--es.bulk.flush-interval200ms
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.size5000000
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es.bulk.workers1
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es.create-index-templatestrue
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-doc-count10000
The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
--es.max-num-spans10000
(deprecated, will be removed in release v1.21.0. Please use es.max-doc-count). The maximum number of spans to fetch at a time per query in Elasticsearch. The lesser of es.max-num-spans and es.max-doc-count will be used if both are set.
--es.max-span-age72h0m0s
The maximum lookback for spans in Elasticsearch
--es.num-replicas1
The number of replicas per index in Elasticsearch
--es.num-shards5
The number of shards per index in Elasticsearch
--es.password
The password required by Elasticsearch
--es.server-urlshttp://127.0.0.1:9200
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es.snifferfalse
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es.sniffer-tls-enabledfalse
Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
--es.tags-as-fields.allfalse
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects.
--es.tags-as-fields.config-file
(experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include
--es.tags-as-fields.dot-replacement@
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es.tags-as-fields.include
(experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
--es.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--es.tlsfalse
(deprecated) see --es.tls.enabled
--es.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--es.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--es.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--es.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--es.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--es.tls.skip-host-verifyfalse
(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-aliasesfalse
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.version0
The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
--health-check-http-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
help for jaeger-ingester
--ingester.deadlockInterval0s
Interval to check for deadlocks. If no messages gets processed in given time, ingester app will exit. Value of 0 disables deadlock check.
--ingester.parallelism1000
The number of messages to process in parallel
--kafka.consumer.authenticationnone
Authentication type used to authenticate with kafka cluster. e.g. none, kerberos, tls
--kafka.consumer.brokers127.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-idjaeger-ingester
The Consumer Client ID that ingester will use
--kafka.consumer.encodingprotobuf
The encoding of spans ("json", "protobuf", "zipkin-thrift") consumed from kafka
--kafka.consumer.group-idjaeger-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-namekafka
Kerberos service name
--kafka.consumer.kerberos.use-keytabfalse
Use of keytab instead of password, if this is true, keytab file will be used instead of password
--kafka.consumer.kerberos.username
The Kerberos username used for authenticate with KDC
--kafka.consumer.plaintext.password
The plaintext Password for SASL/PLAIN authentication
--kafka.consumer.plaintext.username
The plaintext Username for SASL/PLAIN authentication
--kafka.consumer.protocol-version
Kafka protocol version - must be supported by kafka server
--kafka.consumer.tlsfalse
(deprecated) see --kafka.consumer.tls.enabled
--kafka.consumer.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--kafka.consumer.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--kafka.consumer.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--kafka.consumer.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--kafka.consumer.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--kafka.consumer.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--kafka.consumer.topicjaeger-spans
The name of the kafka topic to consume from
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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 the 'env' command for help.

jaeger-ingester with grpc-plugin storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:14270
The host:port (e.g. 127.0.0.1:5555 or :5555) 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.ratio1
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
--grpc-storage-plugin.log-levelwarn
Set the log level of the plugin's logger
--health-check-http-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
help for jaeger-ingester
--ingester.deadlockInterval0s
Interval to check for deadlocks. If no messages gets processed in given time, ingester app will exit. Value of 0 disables deadlock check.
--ingester.parallelism1000
The number of messages to process in parallel
--kafka.consumer.authenticationnone
Authentication type used to authenticate with kafka cluster. e.g. none, kerberos, tls
--kafka.consumer.brokers127.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-idjaeger-ingester
The Consumer Client ID that ingester will use
--kafka.consumer.encodingprotobuf
The encoding of spans ("json", "protobuf", "zipkin-thrift") consumed from kafka
--kafka.consumer.group-idjaeger-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-namekafka
Kerberos service name
--kafka.consumer.kerberos.use-keytabfalse
Use of keytab instead of password, if this is true, keytab file will be used instead of password
--kafka.consumer.kerberos.username
The Kerberos username used for authenticate with KDC
--kafka.consumer.plaintext.password
The plaintext Password for SASL/PLAIN authentication
--kafka.consumer.plaintext.username
The plaintext Username for SASL/PLAIN authentication
--kafka.consumer.protocol-version
Kafka protocol version - must be supported by kafka server
--kafka.consumer.tlsfalse
(deprecated) see --kafka.consumer.tls.enabled
--kafka.consumer.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--kafka.consumer.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--kafka.consumer.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--kafka.consumer.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--kafka.consumer.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--kafka.consumer.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--kafka.consumer.topicjaeger-spans
The name of the kafka topic to consume from
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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 the 'env' command for help.

jaeger-query

Jaeger query service provides a Web UI and an API for accessing trace data.

jaeger-query can be used with these storage backends:

jaeger-query with cassandra storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:16687
The host:port (e.g. 127.0.0.1:5555 or :5555) for the admin server, including health check, /metrics, etc.
--cassandra-archive.connect-timeout0s
Timeout used for connections to Cassandra Servers
--cassandra-archive.connections-per-host0
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-compressionfalse
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-v2false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra-archive.enabledfalse
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-attempts0
The number of attempts when reading from Cassandra
--cassandra-archive.password
Password for password authentication for Cassandra
--cassandra-archive.port0
The port for cassandra
--cassandra-archive.proto-version0
The Cassandra protocol version
--cassandra-archive.reconnect-interval0s
Reconnect interval to retry connecting to downed hosts
--cassandra-archive.servers
The comma-separated list of Cassandra servers
--cassandra-archive.socket-keep-alive0s
Cassandra's keepalive period to use, enabled if > 0
--cassandra-archive.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--cassandra-archive.tlsfalse
(deprecated) see --cassandra-archive.tls.enabled
--cassandra-archive.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--cassandra-archive.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--cassandra-archive.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--cassandra-archive.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--cassandra-archive.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--cassandra-archive.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--cassandra-archive.tls.verify-hostfalse
(deprecated) Enable (or disable) host key verification. Use cassandra-archive.tls.skip-host-verify instead
--cassandra-archive.username
Username for password authentication for Cassandra
--cassandra.connect-timeout0s
Timeout used for connections to Cassandra Servers
--cassandra.connections-per-host2
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-compressionfalse
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-v2false
(deprecated) Jaeger will automatically detect the version of the dependencies table
--cassandra.index.logstrue
Controls log field indexing. Set to false to disable.
--cassandra.index.process-tagstrue
Controls process tag indexing. Set to false to disable.
--cassandra.index.tag-blacklist
The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option.
--cassandra.index.tag-whitelist
The comma-separated list of span tags to whitelist for being indexed. All other tags will not be indexed. Mutually exclusive with the blacklist option.
--cassandra.index.tagstrue
Controls tag indexing. Set to false to disable.
--cassandra.keyspacejaeger_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-attempts3
The number of attempts when reading from Cassandra
--cassandra.password
Password for password authentication for Cassandra
--cassandra.port0
The port for cassandra
--cassandra.proto-version4
The Cassandra protocol version
--cassandra.reconnect-interval1m0s
Reconnect interval to retry connecting to downed hosts
--cassandra.servers127.0.0.1
The comma-separated list of Cassandra servers
--cassandra.socket-keep-alive0s
Cassandra's keepalive period to use, enabled if > 0
--cassandra.span-store-write-cache-ttl12h0m0s
The duration to wait before rewriting an existing service or operation name
--cassandra.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--cassandra.tlsfalse
(deprecated) see --cassandra.tls.enabled
--cassandra.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--cassandra.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--cassandra.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--cassandra.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--cassandra.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--cassandra.tls.skip-host-verifyfalse
(insecure) Skip server's certificate chain and host name verification
--cassandra.tls.verify-hostfalse
(deprecated) Enable (or disable) host key verification. Use cassandra.tls.skip-host-verify instead
--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.ratio1
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-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
help for jaeger-query
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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.additional-headers[]
Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value"
--query.base-path/
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagationfalse
Allow propagation of bearer token to be used by storage plugins
--query.grpc-server.host-port:16685
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's gRPC server
--query.host-port:16686
(deprecated, will be removed after 2020-12-31 or in release v1.21.0, whichever is later) see --query.http-server.host-port and --query.grpc-server.host-port
--query.http-server.host-port:16686
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's HTTP server
--query.max-clock-skew-adjustment0s
The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments
--query.port0
(deprecated, will be removed after 2020-08-31 or in release v1.20.0, whichever is later) see --query.host-port
--query.static-files
The directory path override for the static assets for the UI
--query.ui-config
The path to the UI configuration file in JSON format
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.

jaeger-query with elasticsearch storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:16687
The host:port (e.g. 127.0.0.1:5555 or :5555) 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.ratio1
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.actions0
The number of requests that can be enqueued before the bulk processor decides to commit
--es-archive.bulk.flush-interval0s
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.size0
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es-archive.bulk.workers0
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es-archive.create-index-templatesfalse
Create index templates at application startup. Set to false when templates are installed manually.
--es-archive.enabledfalse
Enable extra storage
--es-archive.index-prefix
Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
--es-archive.max-doc-count0
The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
--es-archive.max-num-spans0
(deprecated, will be removed in release v1.21.0. Please use es.max-doc-count). The maximum number of spans to fetch at a time per query in Elasticsearch. The lesser of es.max-num-spans and es.max-doc-count will be used if both are set.
--es-archive.max-span-age0s
The maximum lookback for spans in Elasticsearch
--es-archive.num-replicas0
The number of replicas per index in Elasticsearch
--es-archive.num-shards0
The number of shards per index in Elasticsearch
--es-archive.password
The password required by Elasticsearch
--es-archive.server-urlshttp://127.0.0.1:9200
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es-archive.snifferfalse
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es-archive.sniffer-tls-enabledfalse
Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
--es-archive.tags-as-fields.allfalse
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects.
--es-archive.tags-as-fields.config-file
(experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include
--es-archive.tags-as-fields.dot-replacement
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es-archive.tags-as-fields.include
(experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
--es-archive.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--es-archive.tlsfalse
(deprecated) see --es-archive.tls.enabled
--es-archive.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--es-archive.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--es-archive.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--es-archive.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--es-archive.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--es-archive.tls.skip-host-verifyfalse
(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-aliasesfalse
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.version0
The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
--es.bulk.actions1000
The number of requests that can be enqueued before the bulk processor decides to commit
--es.bulk.flush-interval200ms
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.size5000000
The number of bytes that the bulk requests can take up before the bulk processor decides to commit
--es.bulk.workers1
The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
--es.create-index-templatestrue
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-doc-count10000
The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
--es.max-num-spans10000
(deprecated, will be removed in release v1.21.0. Please use es.max-doc-count). The maximum number of spans to fetch at a time per query in Elasticsearch. The lesser of es.max-num-spans and es.max-doc-count will be used if both are set.
--es.max-span-age72h0m0s
The maximum lookback for spans in Elasticsearch
--es.num-replicas1
The number of replicas per index in Elasticsearch
--es.num-shards5
The number of shards per index in Elasticsearch
--es.password
The password required by Elasticsearch
--es.server-urlshttp://127.0.0.1:9200
The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
--es.snifferfalse
The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
--es.sniffer-tls-enabledfalse
Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
--es.tags-as-fields.allfalse
(experimental) Store all span and process tags as object fields. If true .tags-as-fields.config-file and .tags-as-fields.include is ignored. Binary tags are always stored as nested objects.
--es.tags-as-fields.config-file
(experimental) Optional path to a file containing tag keys which will be stored as object fields. Each key should be on a separate line. Merged with .tags-as-fields.include
--es.tags-as-fields.dot-replacement@
(experimental) The character used to replace dots (".") in tag keys stored as object fields.
--es.tags-as-fields.include
(experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
--es.timeout0s
Timeout used for queries. A Timeout of zero means no timeout
--es.tlsfalse
(deprecated) see --es.tls.enabled
--es.tls.ca
Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--es.tls.cert
Path to a TLS Certificate file, used to identify this process to the remote server(s)
--es.tls.enabledfalse
Enable TLS when talking to the remote server(s)
--es.tls.key
Path to a TLS Private Key file, used to identify this process to the remote server(s)
--es.tls.server-name
Override the TLS server name we expect in the certificate of the remote server(s)
--es.tls.skip-host-verifyfalse
(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-aliasesfalse
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.version0
The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
--health-check-http-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
help for jaeger-query
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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.additional-headers[]
Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value"
--query.base-path/
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagationfalse
Allow propagation of bearer token to be used by storage plugins
--query.grpc-server.host-port:16685
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's gRPC server
--query.host-port:16686
(deprecated, will be removed after 2020-12-31 or in release v1.21.0, whichever is later) see --query.http-server.host-port and --query.grpc-server.host-port
--query.http-server.host-port:16686
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's HTTP server
--query.max-clock-skew-adjustment0s
The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments
--query.port0
(deprecated, will be removed after 2020-08-31 or in release v1.20.0, whichever is later) see --query.host-port
--query.static-files
The directory path override for the static assets for the UI
--query.ui-config
The path to the UI configuration file in JSON format
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.

jaeger-query with grpc-plugin storage

FlagDefault Value
--admin-http-port0
(deprecated, will be removed after 2020-06-30 or in release v1.20.0, whichever is later) see --admin.http.host-port
--admin.http.host-port:16687
The host:port (e.g. 127.0.0.1:5555 or :5555) 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.ratio1
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
--grpc-storage-plugin.log-levelwarn
Set the log level of the plugin's logger
--health-check-http-port0
(deprecated, will be removed after 2020-03-15 or in release v1.19.0, whichever is later) see --admin.http.host-port
--helpfalse
help for jaeger-query
--log-levelinfo
Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
--metrics-backendprometheus
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.additional-headers[]
Additional HTTP response headers. Can be specified multiple times. Format: "Key: Value"
--query.base-path/
The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
--query.bearer-token-propagationfalse
Allow propagation of bearer token to be used by storage plugins
--query.grpc-server.host-port:16685
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's gRPC server
--query.host-port:16686
(deprecated, will be removed after 2020-12-31 or in release v1.21.0, whichever is later) see --query.http-server.host-port and --query.grpc-server.host-port
--query.http-server.host-port:16686
The host:port (e.g. 127.0.0.1:5555 or :5555) of the query's HTTP server
--query.max-clock-skew-adjustment0s
The maximum delta by which span timestamps may be adjusted in the UI due to clock skew; set to 0s to disable clock skew adjustments
--query.port0
(deprecated, will be removed after 2020-08-31 or in release v1.20.0, whichever is later) see --query.host-port
--query.static-files
The directory path override for the static assets for the UI
--query.ui-config
The path to the UI configuration file in JSON format
--span-storage.type
(deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.