grafana / tempo

Grafana Tempo is a high volume, minimal dependency distributed tracing backend.
https://grafana.com/oss/tempo/
GNU Affero General Public License v3.0
3.9k stars 508 forks source link

[DOC] Update overrides content in Helm chart to clarify configuration for new, legacy #3820

Open knylander-grafana opened 2 months ago

knylander-grafana commented 2 months ago

Update the overrides configuration documentation to address changes to the Overrides module. The configuration examples need to be checked to make sure they are for the updated overrdies and which ones are not.

Update these pages:

The configuratio file in this doc works, but it's a YAML file: "A snippet of a config.yaml file showing how the overrides section is here.

Reference: https://github.com/grafana/tempo/issues/3795

Notes

Same issue happens in the tempo-distributed Helm chart:

global_overrides:
  defaults:
    metrics_generator:
      processors:
        - span-metrics
      processor:
        span_metrics:
          histogram_buckets: [null]
          dimensions:
            - kubernetes_cluster
            - kubernetes.cluster
            - http.status_code

As a rule of thumb: long, unindented params are legacy (eg. metrics_generator_forwarder_queue_size), indented params are new (eg. metrics_generator.forwarder.queue_size).

With the new config, a new key defaults was also added after the overrides key, to be more explicit of the contents of the config block.

Finally, there is a command in the tempo-cli that allows you to convert legacy config to new overrides config.

github-actions[bot] commented 2 weeks ago

This issue has been automatically marked as stale because it has not had any activity in the past 60 days. The next time this stale check runs, the stale label will be removed if there is new activity. The issue will be closed after 15 days if there is no new activity. Please apply keepalive label to exempt this Issue.