jaeger-all-in-one-badger.yaml

name: jaeger-all-in-one
synopsis: |
  Jaeger all-in-one distribution with agent, collector and query in one process.
description: |-
  Jaeger all-in-one distribution with agent, collector and query. Use with caution this version
  by default uses only in-memory database.
usage: jaeger-all-in-one [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: admin.http.tls.cert
  usage: |
    Path to a TLS Certificate file, used to identify this server to clients
- name: admin.http.tls.cipher-suites
  usage: |
    Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants).
- name: admin.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: admin.http.tls.enabled
  default_value: "false"
  usage: Enable TLS on the server
- name: admin.http.tls.key
  usage: |
    Path to a TLS Private Key file, used to identify this server to clients
- name: admin.http.tls.max-version
  usage: |
    Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: admin.http.tls.min-version
  usage: |
    Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: badger.consistency
  default_value: "false"
  usage: |
    If all writes should be synced immediately to physical disk. This will impact write performance.
- name: badger.directory-key
  default_value: /go/bin/data/keys
  usage: |
    Path to store the keys (indexes), this directory should reside in SSD disk. Set ephemeral to false if you want to define this setting.
- name: badger.directory-value
  default_value: /go/bin/data/values
  usage: |
    Path to store the values (spans). Set ephemeral to false if you want to define this setting.
- name: badger.ephemeral
  default_value: "true"
  usage: Mark this storage ephemeral, data is stored in tmpfs.
- name: badger.maintenance-interval
  default_value: 5m0s
  usage: |
    How often the maintenance thread for values is ran. Format is time.Duration (https://golang.org/pkg/time/#Duration)
- name: badger.metrics-update-interval
  default_value: 10s
  usage: |
    How often the badger metrics are collected by Jaeger. Format is time.Duration (https://golang.org/pkg/time/#Duration)
- name: badger.read-only
  default_value: "false"
  usage: |
    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.
- name: badger.span-store-ttl
  default_value: 72h0m0s
  usage: |
    How long to store the data. Format is time.Duration (https://golang.org/pkg/time/#Duration)
- name: collector.grpc-server.host-port
  default_value: :14250
  usage: |
    The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server
- name: collector.grpc-server.max-connection-age
  default_value: 0s
  usage: |
    The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters
- name: collector.grpc-server.max-connection-age-grace
  default_value: 0s
  usage: |
    The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters
- 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.cipher-suites
  usage: |
    Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants).
- 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.grpc.tls.max-version
  usage: |
    Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: collector.grpc.tls.min-version
  usage: |
    Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: collector.http-server.host-port
  default_value: :14268
  usage: |
    The host:port (e.g. 127.0.0.1:12345 or :12345) 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.cipher-suites
  usage: |
    Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants).
- 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.http.tls.max-version
  usage: |
    Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: collector.http.tls.min-version
  usage: |
    Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: collector.num-workers
  default_value: "50"
  usage: The number of workers pulling items from the queue
- name: collector.otlp.enabled
  default_value: "false"
  usage: |
    Enables OpenTelemetry OTLP receiver on dedicated HTTP and gRPC ports
- name: collector.otlp.grpc.host-port
  usage: |
    The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's gRPC server
- name: collector.otlp.grpc.max-connection-age
  default_value: 0s
  usage: |
    The maximum amount of time a connection may exist. Set this value to a few seconds or minutes on highly elastic environments, so that clients discover new collector nodes frequently. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters
- name: collector.otlp.grpc.max-connection-age-grace
  default_value: 0s
  usage: |
    The additive period after MaxConnectionAge after which the connection will be forcibly closed. See https://pkg.go.dev/google.golang.org/grpc/keepalive#ServerParameters
- name: collector.otlp.grpc.max-message-size
  default_value: "4194304"
  usage: |
    The maximum receivable message size for the collector's gRPC server
- name: collector.otlp.grpc.tls.cert
  usage: |
    Path to a TLS Certificate file, used to identify this server to clients
- name: collector.otlp.grpc.tls.cipher-suites
  usage: |
    Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants).
- name: collector.otlp.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.otlp.grpc.tls.enabled
  default_value: "false"
  usage: Enable TLS on the server
- name: collector.otlp.grpc.tls.key
  usage: |
    Path to a TLS Private Key file, used to identify this server to clients
- name: collector.otlp.grpc.tls.max-version
  usage: |
    Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: collector.otlp.grpc.tls.min-version
  usage: |
    Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: collector.otlp.http.host-port
  usage: |
    The host:port (e.g. 127.0.0.1:12345 or :12345) of the collector's HTTP server
- name: collector.otlp.http.tls.cert
  usage: |
    Path to a TLS Certificate file, used to identify this server to clients
- name: collector.otlp.http.tls.cipher-suites
  usage: |
    Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants).
- name: collector.otlp.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.otlp.http.tls.enabled
  default_value: "false"
  usage: Enable TLS on the server
- name: collector.otlp.http.tls.key
  usage: |
    Path to a TLS Private Key file, used to identify this server to clients
- name: collector.otlp.http.tls.max-version
  usage: |
    Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: collector.otlp.http.tls.min-version
  usage: |
    Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- 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: collector.zipkin.tls.cert
  usage: |
    Path to a TLS Certificate file, used to identify this server to clients
- name: collector.zipkin.tls.cipher-suites
  usage: |
    Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants).
- name: collector.zipkin.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.zipkin.tls.enabled
  default_value: "false"
  usage: Enable TLS on the server
- name: collector.zipkin.tls.key
  usage: |
    Path to a TLS Private Key file, used to identify this server to clients
- name: collector.zipkin.tls.max-version
  usage: |
    Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: collector.zipkin.tls.min-version
  usage: |
    Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- 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: help
  shorthand: h
  default_value: "false"
  usage: help for jaeger-all-in-one
- name: http-server.host-port
  default_value: :5778
  usage: |
    host:port of the http server (e.g. for /sampling point and /baggageRestrictions endpoint)
- 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: processor.jaeger-binary.server-host-port
  default_value: :6832
  usage: host:port for the UDP server
- name: processor.jaeger-binary.server-max-packet-size
  default_value: "65000"
  usage: max packet size for the UDP server
- name: processor.jaeger-binary.server-queue-size
  default_value: "1000"
  usage: length of the queue for the UDP server
- name: processor.jaeger-binary.server-socket-buffer-size
  default_value: "0"
  usage: socket buffer size for UDP packets in bytes
- name: processor.jaeger-binary.workers
  default_value: "10"
  usage: how many workers the processor should run
- name: processor.jaeger-compact.server-host-port
  default_value: :6831
  usage: host:port for the UDP server
- name: processor.jaeger-compact.server-max-packet-size
  default_value: "65000"
  usage: max packet size for the UDP server
- name: processor.jaeger-compact.server-queue-size
  default_value: "1000"
  usage: length of the queue for the UDP server
- name: processor.jaeger-compact.server-socket-buffer-size
  default_value: "0"
  usage: socket buffer size for UDP packets in bytes
- name: processor.jaeger-compact.workers
  default_value: "10"
  usage: how many workers the processor should run
- name: processor.zipkin-compact.server-host-port
  default_value: :5775
  usage: host:port for the UDP server
- name: processor.zipkin-compact.server-max-packet-size
  default_value: "65000"
  usage: max packet size for the UDP server
- name: processor.zipkin-compact.server-queue-size
  default_value: "1000"
  usage: length of the queue for the UDP server
- name: processor.zipkin-compact.server-socket-buffer-size
  default_value: "0"
  usage: socket buffer size for UDP packets in bytes
- name: processor.zipkin-compact.workers
  default_value: "10"
  usage: how many workers the processor should run
- name: query.additional-headers
  default_value: '[]'
  usage: |
    Additional HTTP response headers.  Can be specified multiple times.  Format: "Key: Value"
- name: query.base-path
  default_value: /
  usage: |
    The base path for all HTTP routes, e.g. /jaeger; useful when running behind a reverse proxy
- name: query.bearer-token-propagation
  default_value: "false"
  usage: |
    Allow propagation of bearer token to be used by storage plugins
- name: query.grpc-server.host-port
  default_value: :16685
  usage: |
    The host:port (e.g. 127.0.0.1:14250 or :14250) of the query's gRPC server
- name: query.grpc.tls.cert
  usage: |
    Path to a TLS Certificate file, used to identify this server to clients
- name: query.grpc.tls.cipher-suites
  usage: |
    Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants).
- name: query.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: query.grpc.tls.enabled
  default_value: "false"
  usage: Enable TLS on the server
- name: query.grpc.tls.key
  usage: |
    Path to a TLS Private Key file, used to identify this server to clients
- name: query.grpc.tls.max-version
  usage: |
    Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: query.grpc.tls.min-version
  usage: |
    Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: query.http-server.host-port
  default_value: :16686
  usage: |
    The host:port (e.g. 127.0.0.1:14268 or :14268) of the query's HTTP server
- name: query.http.tls.cert
  usage: |
    Path to a TLS Certificate file, used to identify this server to clients
- name: query.http.tls.cipher-suites
  usage: |
    Comma-separated list of cipher suites for the server, values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants).
- name: query.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: query.http.tls.enabled
  default_value: "false"
  usage: Enable TLS on the server
- name: query.http.tls.key
  usage: |
    Path to a TLS Private Key file, used to identify this server to clients
- name: query.http.tls.max-version
  usage: |
    Maximum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: query.http.tls.min-version
  usage: |
    Minimum TLS version supported (Possible values: 1.0, 1.1, 1.2, 1.3)
- name: query.max-clock-skew-adjustment
  default_value: 0s
  usage: |
    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
- name: query.static-files
  usage: The directory path override for the static assets for the UI
- name: query.ui-config
  usage: The path to the UI configuration file in JSON format
- name: reporter.grpc.discovery.min-peers
  default_value: "3"
  usage: |
    Max number of collectors to which the agent will try to connect at any given time
- name: reporter.grpc.host-port
  usage: |
    Comma-separated string representing host:port of a static list of collectors to connect to directly
- name: reporter.grpc.retry.max
  default_value: "3"
  usage: Sets the maximum number of retries for a call
- name: reporter.grpc.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: reporter.grpc.tls.cert
  usage: |
    Path to a TLS Certificate file, used to identify this process to the remote server(s)
- name: reporter.grpc.tls.enabled
  default_value: "false"
  usage: Enable TLS when talking to the remote server(s)
- name: reporter.grpc.tls.key
  usage: |
    Path to a TLS Private Key file, used to identify this process to the remote server(s)
- name: reporter.grpc.tls.server-name
  usage: |
    Override the TLS server name we expect in the certificate of the remote server(s)
- name: reporter.grpc.tls.skip-host-verify
  default_value: "false"
  usage: |
    (insecure) Skip server's certificate chain and host name verification
- name: reporter.type
  default_value: grpc
  usage: Reporter type to use e.g. grpc
- 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.