jaeger-collector-elasticsearch.yaml

name: jaeger-collector
synopsis: |
  Jaeger collector receives and processes traces from Jaeger agents and clients
description: |
  Jaeger collector receives traces from Jaeger agents and runs them through a processing pipeline.
usage: jaeger-collector [flags]
options:
- name: admin.http.host-port
  default_value: :14269
  usage: |
    The host:port (e.g. 127.0.0.1:14269 or :14269) for the admin server, including health check, /metrics, etc.
- name: collector.grpc-server.host-port
  default_value: :14250
  usage: |
    The host:port (e.g. 127.0.0.1:14250 or :14250) of the collector's GRPC server
- name: collector.grpc-server.max-message-size
  default_value: "4194304"
  usage: |
    The maximum receivable message size for the collector's GRPC server
- name: collector.grpc.tls.cert
  usage: |
    Path to a TLS Certificate file, used to identify this server to clients
- name: collector.grpc.tls.client-ca
  usage: |
    Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
- name: collector.grpc.tls.enabled
  default_value: "false"
  usage: Enable TLS on the server
- name: collector.grpc.tls.key
  usage: |
    Path to a TLS Private Key file, used to identify this server to clients
- name: collector.http-server.host-port
  default_value: :14268
  usage: |
    The host:port (e.g. 127.0.0.1:14268 or :14268) of the collector's HTTP server
- name: collector.http.tls.cert
  usage: |
    Path to a TLS Certificate file, used to identify this server to clients
- name: collector.http.tls.client-ca
  usage: |
    Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
- name: collector.http.tls.enabled
  default_value: "false"
  usage: Enable TLS on the server
- name: collector.http.tls.key
  usage: |
    Path to a TLS Private Key file, used to identify this server to clients
- name: collector.num-workers
  default_value: "50"
  usage: The number of workers pulling items from the queue
- name: collector.queue-size
  default_value: "2000"
  usage: The queue size of the collector
- name: collector.queue-size-memory
  default_value: "0"
  usage: |
    (experimental) The max memory size in MiB to use for the dynamic queue.
- name: collector.tags
  usage: |
    One or more tags to be added to the Process tags of all spans passing through this collector. Ex: key1=value1,key2=${envVar:defaultValue}
- name: collector.zipkin.allowed-headers
  default_value: content-type
  usage: |
    Comma separated list of allowed headers for the Zipkin collector service, default content-type
- name: collector.zipkin.allowed-origins
  default_value: '*'
  usage: |
    Comma separated list of allowed origins for the Zipkin collector service, default accepts all
- name: collector.zipkin.host-port
  usage: |
    The host:port (e.g. 127.0.0.1:9411 or :9411) of the collector's Zipkin server (disabled by default)
- name: config-file
  usage: |
    Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
- name: downsampling.hashsalt
  usage: Salt used when hashing trace id for downsampling.
- name: downsampling.ratio
  default_value: "1"
  usage: |
    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.
- name: es-archive.bulk.actions
  default_value: "1000"
  usage: |
    The number of requests that can be enqueued before the bulk processor decides to commit
- name: es-archive.bulk.flush-interval
  default_value: 200ms
  usage: |
    A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled.
- name: es-archive.bulk.size
  default_value: "5000000"
  usage: |
    The number of bytes that the bulk requests can take up before the bulk processor decides to commit
- name: es-archive.bulk.workers
  default_value: "1"
  usage: |
    The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
- name: es-archive.create-index-templates
  default_value: "true"
  usage: |
    Create index templates at application startup. Set to false when templates are installed manually.
- name: es-archive.enabled
  default_value: "false"
  usage: Enable extra storage
- name: es-archive.index-date-separator
  default_value: '-'
  usage: |
    Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20".
- name: es-archive.index-prefix
  usage: |
    Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
- name: es-archive.index-rollover-frequency-services
  default_value: day
  usage: |
    Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover
- name: es-archive.index-rollover-frequency-spans
  default_value: day
  usage: |
    Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover
- name: es-archive.log-level
  default_value: error
  usage: |
    The Elasticsearch client log-level. Valid levels: [debug, info, error]
- name: es-archive.max-doc-count
  default_value: "10000"
  usage: |
    The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
- name: es-archive.num-replicas
  default_value: "1"
  usage: The number of replicas per index in Elasticsearch
- name: es-archive.num-shards
  default_value: "5"
  usage: The number of shards per index in Elasticsearch
- name: es-archive.password
  usage: The password required by Elasticsearch
- name: es-archive.remote-read-clusters
  usage: |
    Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api.
- name: es-archive.send-get-body-as
  usage: HTTP verb for requests that contain a body [GET, POST].
- name: es-archive.server-urls
  default_value: http://127.0.0.1:9200
  usage: |
    The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
- name: es-archive.sniffer
  default_value: "false"
  usage: |
    The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
- name: es-archive.sniffer-tls-enabled
  default_value: "false"
  usage: |
    Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
- name: es-archive.tags-as-fields.all
  default_value: "false"
  usage: |
    (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.
- name: es-archive.tags-as-fields.config-file
  usage: |
    (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
- name: es-archive.tags-as-fields.dot-replacement
  default_value: '@'
  usage: |
    (experimental) The character used to replace dots (".") in tag keys stored as object fields.
- name: es-archive.tags-as-fields.include
  usage: |
    (experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
- name: es-archive.timeout
  default_value: 0s
  usage: Timeout used for queries. A Timeout of zero means no timeout
- name: es-archive.tls.ca
  usage: |
    Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
- name: es-archive.tls.cert
  usage: |
    Path to a TLS Certificate file, used to identify this process to the remote server(s)
- name: es-archive.tls.enabled
  default_value: "false"
  usage: Enable TLS when talking to the remote server(s)
- name: es-archive.tls.key
  usage: |
    Path to a TLS Private Key file, used to identify this process to the remote server(s)
- name: es-archive.tls.server-name
  usage: |
    Override the TLS server name we expect in the certificate of the remote server(s)
- name: es-archive.tls.skip-host-verify
  default_value: "false"
  usage: |
    (insecure) Skip server's certificate chain and host name verification
- name: es-archive.token-file
  usage: |
    Path to a file containing bearer token. This flag also loads CA if it is specified.
- name: es-archive.use-aliases
  default_value: "false"
  usage: |
    Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times.
- name: es-archive.use-ilm
  default_value: "false"
  usage: |
    (experimental) Option to enable ILM for jaeger span & service indices. Use this option with  es-archive.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+.
- name: es-archive.username
  usage: |
    The username required by Elasticsearch. The basic authentication also loads CA if it is specified.
- name: es-archive.version
  default_value: "0"
  usage: |
    The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
- name: es.bulk.actions
  default_value: "1000"
  usage: |
    The number of requests that can be enqueued before the bulk processor decides to commit
- name: es.bulk.flush-interval
  default_value: 200ms
  usage: |
    A time.Duration after which bulk requests are committed, regardless of other thresholds. Set to zero to disable. By default, this is disabled.
- name: es.bulk.size
  default_value: "5000000"
  usage: |
    The number of bytes that the bulk requests can take up before the bulk processor decides to commit
- name: es.bulk.workers
  default_value: "1"
  usage: |
    The number of workers that are able to receive bulk requests and eventually commit them to Elasticsearch
- name: es.create-index-templates
  default_value: "true"
  usage: |
    Create index templates at application startup. Set to false when templates are installed manually.
- name: es.index-date-separator
  default_value: '-'
  usage: |
    Optional date separator of Jaeger indices. For example "." creates "jaeger-span-2020.11.20".
- name: es.index-prefix
  usage: |
    Optional prefix of Jaeger indices. For example "production" creates "production-jaeger-*".
- name: es.index-rollover-frequency-services
  default_value: day
  usage: |
    Rotates jaeger-service indices over the given period. For example "day" creates "jaeger-service-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover
- name: es.index-rollover-frequency-spans
  default_value: day
  usage: |
    Rotates jaeger-span indices over the given period. For example "day" creates "jaeger-span-yyyy-MM-dd" every day after UTC 12AM. Valid options: [hour, day]. This does not delete old indices. For details on complete index management solutions supported by Jaeger, refer to: https://www.jaegertracing.io/docs/deployment/#elasticsearch-rollover
- name: es.log-level
  default_value: error
  usage: |
    The Elasticsearch client log-level. Valid levels: [debug, info, error]
- name: es.max-doc-count
  default_value: "10000"
  usage: |
    The maximum document count to return from an Elasticsearch query. This will also apply to aggregations.
- name: es.max-span-age
  default_value: 72h0m0s
  usage: The maximum lookback for spans in Elasticsearch
- name: es.num-replicas
  default_value: "1"
  usage: The number of replicas per index in Elasticsearch
- name: es.num-shards
  default_value: "5"
  usage: The number of shards per index in Elasticsearch
- name: es.password
  usage: The password required by Elasticsearch
- name: es.remote-read-clusters
  usage: |
    Comma-separated list of Elasticsearch remote cluster names for cross-cluster querying.See Elasticsearch remote clusters and cross-cluster query api.
- name: es.send-get-body-as
  usage: HTTP verb for requests that contain a body [GET, POST].
- name: es.server-urls
  default_value: http://127.0.0.1:9200
  usage: |
    The comma-separated list of Elasticsearch servers, must be full url i.e. http://localhost:9200
- name: es.sniffer
  default_value: "false"
  usage: |
    The sniffer config for Elasticsearch; client uses sniffing process to find all nodes automatically, disable if not required
- name: es.sniffer-tls-enabled
  default_value: "false"
  usage: |
    Option to enable TLS when sniffing an Elasticsearch Cluster ; client uses sniffing process to find all nodes automatically, disabled by default
- name: es.tags-as-fields.all
  default_value: "false"
  usage: |
    (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.
- name: es.tags-as-fields.config-file
  usage: |
    (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
- name: es.tags-as-fields.dot-replacement
  default_value: '@'
  usage: |
    (experimental) The character used to replace dots (".") in tag keys stored as object fields.
- name: es.tags-as-fields.include
  usage: |
    (experimental) Comma delimited list of tag keys which will be stored as object fields. Merged with the contents of .tags-as-fields.config-file
- name: es.timeout
  default_value: 0s
  usage: Timeout used for queries. A Timeout of zero means no timeout
- name: es.tls.ca
  usage: |
    Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
- name: es.tls.cert
  usage: |
    Path to a TLS Certificate file, used to identify this process to the remote server(s)
- name: es.tls.enabled
  default_value: "false"
  usage: Enable TLS when talking to the remote server(s)
- name: es.tls.key
  usage: |
    Path to a TLS Private Key file, used to identify this process to the remote server(s)
- name: es.tls.server-name
  usage: |
    Override the TLS server name we expect in the certificate of the remote server(s)
- name: es.tls.skip-host-verify
  default_value: "false"
  usage: |
    (insecure) Skip server's certificate chain and host name verification
- name: es.token-file
  usage: |
    Path to a file containing bearer token. This flag also loads CA if it is specified.
- name: es.use-aliases
  default_value: "false"
  usage: |
    Use read and write aliases for indices. Use this option with Elasticsearch rollover API. It requires an external component to create aliases before startup and then performing its management. Note that es.max-span-age will influence trace search window start times.
- name: es.use-ilm
  default_value: "false"
  usage: |
    (experimental) Option to enable ILM for jaeger span & service indices. Use this option with  es.use-aliases. It requires an external component to create aliases before startup and then performing its management. ILM policy must be manually created in ES before startup. Supported only for elasticsearch version 7+.
- name: es.username
  usage: |
    The username required by Elasticsearch. The basic authentication also loads CA if it is specified.
- name: es.version
  default_value: "0"
  usage: |
    The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.
- name: help
  shorthand: h
  default_value: "false"
  usage: help for jaeger-collector
- name: log-level
  default_value: info
  usage: |
    Minimal allowed log Level. For more levels see https://github.com/uber-go/zap
- name: metrics-backend
  default_value: prometheus
  usage: |
    Defines which metrics backend to use for metrics reporting: expvar, prometheus, none
- name: metrics-http-route
  default_value: /metrics
  usage: |
    Defines the route of HTTP endpoint for metrics backends that support scraping
- name: sampling.strategies-file
  usage: |
    The path for the sampling strategies file in JSON format. See sampling documentation to see format of the file
- name: sampling.strategies-reload-interval
  default_value: 0s
  usage: |
    Reload interval to check and reload sampling strategies file. Zero value means no reloading
- name: span-storage.type
  usage: |
    (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.
see_also:
- completion - generate the autocompletion script for the specified shell
- docs - Generates documentation
- env - Help about environment variables.
- status - Print the status.
- version - Print the version.