Tracing #

Thanos supports different tracing backends that implements opentracing.Tracer interface.

All clients are configured using --tracing.config-file to reference to the configuration file or --tracing.config to put yaml config directly.

How to use config flags? #

You can either pass YAML file defined below in --tracing.config-file or pass the YAML content directly using --tracing.config. We recommend the latter as it gives an explicit static view of configuration for each component. It also saves you the fuss of creating and managing additional file.

Don’t be afraid of multiline flags!

In Kubernetes it is as easy as (on Thanos sidecar example):

      - args:
        - sidecar
        - |
          --objstore.config=type: GCS
            bucket: <bucket>
        - --prometheus.url=http://localhost:9090
        - |
          --tracing.config=type: STACKDRIVER
            service_name: ""
            project_id: <project>
            sample_factor: 16
        - --tsdb.path=/prometheus-data

How to add a new client? #

  1. Create new directory under pkg/tracing/<provider>
  2. Implement opentracing.Tracer interface
  3. Add client implementation to the factory in factory code. (Using as small amount of flags as possible in every command)
  4. Add client struct config to cfggen to allow config auto generation.

At that point, anyone can use your provider by spec.

Configuration #

Current tracing supported backends:

Jaeger #

Client for tracing.

type: JAEGER
  service_name: ""
  disabled: false
  rpc_metrics: false
  tags: ""
  sampler_type: ""
  sampler_param: 0
  sampler_manager_host_port: ""
  sampler_max_operations: 0
  sampler_refresh_interval: 0s
  reporter_max_queue_size: 0
  reporter_flush_interval: 0s
  reporter_log_spans: false
  endpoint: ""
  user: ""
  password: ""
  agent_host: ""
  agent_port: 0

Stackdriver #

Client for tracing.

  service_name: ""
  project_id: ""
  sample_factor: 0

Elastic APM #

Client for tracing.

  service_name: ""
  service_version: ""
  service_environment: ""

Found a typo, inconsistency or missing information in our docs? Help us to improve Thanos documentation by proposing a fix on GitHub here ❤️