jaeger-query-prometheus.yaml

name: jaeger-query
synopsis: |
    Jaeger query service provides a Web UI and an API for accessing trace data.
description: |
    Jaeger query service provides a Web UI and an API for accessing trace data.
usage: jaeger-query [flags]
options:
    - name: admin.http.host-port
      default_value: :16687
      usage: |
        The host:port (e.g. 127.0.0.1:16687 or :16687) 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: cassandra-archive.connect-timeout
      default_value: 0s
      usage: Timeout used for connections to Cassandra Servers
    - name: cassandra-archive.connections-per-host
      default_value: "0"
      usage: |
        The number of Cassandra connections from a single backend instance
    - name: cassandra-archive.consistency
      usage: |
        The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE)
    - name: cassandra-archive.disable-compression
      default_value: "false"
      usage: |
        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
    - name: cassandra-archive.enabled
      default_value: "false"
      usage: Enable extra storage
    - name: cassandra-archive.keyspace
      usage: The Cassandra keyspace for Jaeger data
    - name: cassandra-archive.local-dc
      usage: |
        The name of the Cassandra local data center for DC Aware host selection
    - name: cassandra-archive.max-retry-attempts
      default_value: "0"
      usage: The number of attempts when reading from Cassandra
    - name: cassandra-archive.password
      usage: Password for password authentication for Cassandra
    - name: cassandra-archive.port
      default_value: "0"
      usage: The port for cassandra
    - name: cassandra-archive.proto-version
      default_value: "0"
      usage: The Cassandra protocol version
    - name: cassandra-archive.reconnect-interval
      default_value: 0s
      usage: Reconnect interval to retry connecting to downed hosts
    - name: cassandra-archive.servers
      usage: The comma-separated list of Cassandra servers
    - name: cassandra-archive.socket-keep-alive
      default_value: 0s
      usage: Cassandra's keepalive period to use, enabled if > 0
    - name: cassandra-archive.timeout
      default_value: 0s
      usage: Timeout used for queries. A Timeout of zero means no timeout
    - name: cassandra-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: cassandra-archive.tls.cert
      usage: |
        Path to a TLS Certificate file, used to identify this process to the remote server(s)
    - name: cassandra-archive.tls.enabled
      default_value: "false"
      usage: Enable TLS when talking to the remote server(s)
    - name: cassandra-archive.tls.key
      usage: |
        Path to a TLS Private Key file, used to identify this process to the remote server(s)
    - name: cassandra-archive.tls.server-name
      usage: |
        Override the TLS server name we expect in the certificate of the remote server(s)
    - name: cassandra-archive.tls.skip-host-verify
      default_value: "false"
      usage: |
        (insecure) Skip server's certificate chain and host name verification
    - name: cassandra-archive.username
      usage: Username for password authentication for Cassandra
    - name: cassandra.connect-timeout
      default_value: 0s
      usage: Timeout used for connections to Cassandra Servers
    - name: cassandra.connections-per-host
      default_value: "2"
      usage: |
        The number of Cassandra connections from a single backend instance
    - name: cassandra.consistency
      usage: |
        The Cassandra consistency level, e.g. ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, LOCAL_ONE (default LOCAL_ONE)
    - name: cassandra.disable-compression
      default_value: "false"
      usage: |
        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
    - name: cassandra.index.logs
      default_value: "true"
      usage: Controls log field indexing. Set to false to disable.
    - name: cassandra.index.process-tags
      default_value: "true"
      usage: Controls process tag indexing. Set to false to disable.
    - name: cassandra.index.tag-blacklist
      usage: |
        The comma-separated list of span tags to blacklist from being indexed. All other tags will be indexed. Mutually exclusive with the whitelist option.
    - name: cassandra.index.tag-whitelist
      usage: |
        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.
    - name: cassandra.index.tags
      default_value: "true"
      usage: Controls tag indexing. Set to false to disable.
    - name: cassandra.keyspace
      default_value: jaeger_v1_test
      usage: The Cassandra keyspace for Jaeger data
    - name: cassandra.local-dc
      usage: |
        The name of the Cassandra local data center for DC Aware host selection
    - name: cassandra.max-retry-attempts
      default_value: "3"
      usage: The number of attempts when reading from Cassandra
    - name: cassandra.password
      usage: Password for password authentication for Cassandra
    - name: cassandra.port
      default_value: "0"
      usage: The port for cassandra
    - name: cassandra.proto-version
      default_value: "4"
      usage: The Cassandra protocol version
    - name: cassandra.reconnect-interval
      default_value: 1m0s
      usage: Reconnect interval to retry connecting to downed hosts
    - name: cassandra.servers
      default_value: 127.0.0.1
      usage: The comma-separated list of Cassandra servers
    - name: cassandra.socket-keep-alive
      default_value: 0s
      usage: Cassandra's keepalive period to use, enabled if > 0
    - name: cassandra.span-store-write-cache-ttl
      default_value: 12h0m0s
      usage: |
        The duration to wait before rewriting an existing service or operation name
    - name: cassandra.timeout
      default_value: 0s
      usage: Timeout used for queries. A Timeout of zero means no timeout
    - name: cassandra.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: cassandra.tls.cert
      usage: |
        Path to a TLS Certificate file, used to identify this process to the remote server(s)
    - name: cassandra.tls.enabled
      default_value: "false"
      usage: Enable TLS when talking to the remote server(s)
    - name: cassandra.tls.key
      usage: |
        Path to a TLS Private Key file, used to identify this process to the remote server(s)
    - name: cassandra.tls.server-name
      usage: |
        Override the TLS server name we expect in the certificate of the remote server(s)
    - name: cassandra.tls.skip-host-verify
      default_value: "false"
      usage: |
        (insecure) Skip server's certificate chain and host name verification
    - name: cassandra.username
      usage: Username for password authentication for Cassandra
    - name: config-file
      usage: |
        Configuration file in JSON, TOML, YAML, HCL, or Java properties formats (default none). See spf13/viper for precedence.
    - name: help
      shorthand: h
      default_value: "false"
      usage: help for jaeger-query
    - 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: prometheus, none, or expvar (deprecated, will be removed after 2024-01-01 or in release v1.53.0, whichever is later) \n"
    - name: metrics-http-route
      default_value: /metrics
      usage: |
        Defines the route of HTTP endpoint for metrics backends that support scraping
    - name: multi-tenancy.enabled
      default_value: "false"
      usage: Enable tenancy header when receiving or querying
    - name: multi-tenancy.header
      default_value: x-tenant
      usage: HTTP header carrying tenant
    - name: multi-tenancy.tenants
      usage: |
        comma-separated list of allowed values for --multi-tenancy.header header.  (If not supplied, tenants are not restricted)
    - name: prometheus.connect-timeout
      default_value: 30s
      usage: |
        The period to wait for a connection to Prometheus when executing queries.
    - name: prometheus.query.duration-unit
      default_value: ms
      usage: |
        The units used for the "latency" histogram. It can be either "ms" or "s" and should be consistent with the histogram unit value set in the spanmetrics connector (see: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/connector/spanmetricsconnector#configurations). This also helps jaeger-query determine the metric name when querying for "latency" metrics.
    - name: prometheus.query.namespace
      usage: |
        The metric namespace that is prefixed to the metric name. A '.' separator will be added between the namespace and the metric name.
    - name: prometheus.query.normalize-calls
      default_value: "false"
      usage: "Whether to normalize the \"calls\" metric name according to https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/translator/prometheus/README.md. For example: \"calls\" (not normalized) -> \"calls_total\" (normalized), \n"
    - name: prometheus.query.normalize-duration
      default_value: "false"
      usage: |
        Whether to normalize the "duration" metric name according to https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/translator/prometheus/README.md. For example: "duration_bucket" (not normalized) -> "duration_milliseconds_bucket (normalized)"
    - name: prometheus.query.support-spanmetrics-connector
      default_value: "true"
      usage: |
        (deprecated, will be removed after 2024-01-01 or in release v1.53.0, whichever is later)  Controls whether the metrics queries should match the OpenTelemetry Collector's spanmetrics connector naming (when true) or spanmetrics processor naming (when false).
    - name: prometheus.server-url
      default_value: http://localhost:9090
      usage: |
        The Prometheus server's URL, must include the protocol scheme e.g. http://localhost:9090
    - name: prometheus.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: prometheus.tls.cert
      usage: |
        Path to a TLS Certificate file, used to identify this process to the remote server(s)
    - name: prometheus.tls.enabled
      default_value: "false"
      usage: Enable TLS when talking to the remote server(s)
    - name: prometheus.tls.key
      usage: |
        Path to a TLS Private Key file, used to identify this process to the remote server(s)
    - name: prometheus.tls.server-name
      usage: |
        Override the TLS server name we expect in the certificate of the remote server(s)
    - name: prometheus.tls.skip-host-verify
      default_value: "false"
      usage: |
        (insecure) Skip server's certificate chain and host name verification
    - name: prometheus.token-file
      usage: |
        The path to a file containing the bearer token which will be included when executing queries against the Prometheus API.
    - name: prometheus.token-override-from-context
      default_value: "true"
      usage: |
        Whether the bearer token should be overridden from context (incoming request)
    - 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. See https://github.com/jaegertracing/jaeger/blob/main/examples/reverse-proxy/README.md
    - name: query.bearer-token-propagation
      default_value: "false"
      usage: |
        Allow propagation of bearer token to be used by storage plugins
    - name: query.enable-tracing
      default_value: "false"
      usage: Enables emitting jaeger-query traces
    - 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.log-static-assets-access
      default_value: "false"
      usage: Log when static assets are accessed (for debugging)
    - 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: span-storage.type
      usage: |
        (deprecated) please use SPAN_STORAGE_TYPE environment variable. Run this binary with the 'env' command for help.
see_also:
    - jaeger-query completion - Generate the autocompletion script for the specified shell
    - jaeger-query docs - Generates documentation
    - jaeger-query env - Help about environment variables.
    - jaeger-query print-config - Print names and values of configuration options
    - jaeger-query status - Print the status.
    - jaeger-query version - Print the version.