Uploaded image for project: 'Observability Documentation'
  1. Observability Documentation
  2. OBSDOCS-918

Fix Tempo configuration docs

XMLWordPrintable

    • OBSDOCS (Apr 15 - May 6) #252, OBSDOCS (May 6 - May 28) #254, OBSDOCS (May 27 - Jun 17) #255, OBSDOCS (Jun 17 - Jul 8) #256, OBSDOCS (Jul 8 - Jul 29) #257
    • Important

      Doc link: https://docs.openshift.com/container-platform/4.15/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.html

      In Distributed Tracing default configuration options: Table 1 Tempo parameters.
      Kind must be TempoStack instead of Tempo.
      name doesn't have a default value. Currently the table mentions tempo-all-in-one-inmemory.
      Storage We can remove this sentence. 'All storage-related options must be placed under storage and not under the allInOne or other component options.'

      There are also some missing important CR options that we should document like:

        limits:
          global:
            ingestion: {}
            query: {}
      
      managementState: Managed
        observability:
          grafana: {}
          metrics: {}
          tracing: {}
      
        search: {}

       

      The storage configuration table needs to be updated. The table seems to be from Jaeger not Tempo. Here is a example TempoStack storage config.

        storage:
          secret:
            name: minio
            type: s3
          tls:
            enabled: true
            caName: custom-ca
        storageSize: 200M 

      Thus the parameters along with the description needs to be updated for the table. The Tempo Monolithic CR is bit different, we will need another table for that in 3.2. 

       

      In the Configuration of monitor tab in Jaeger UI, we need to add a full working example of the TempoStack config as we have observed that many customers usually just copy paste the config and try to deploy the TempoStack with some customizable parameters like name of the stack or object store name, secret etc. Here is a full working example.

      apiVersion: tempo.grafana.com/v1alpha1
      kind:  TempoStack
      metadata:
        name: redmetrics
      spec:
        storage:
          secret:
            name: minio-test
            type: s3
        storageSize: 1Gi
        template:
          gateway:
            enabled: false
          queryFrontend:
            jaegerQuery:
              enabled: true
              monitorTab:
                enabled: true
                prometheusEndpoint: https://thanos-querier.openshift-monitoring.svc.cluster.local:9091
              ingress:
                type: route
      

       

      For Multitenancy also we need a complete working example like below.

      apiVersion: tempo.grafana.com/v1alpha1
      kind:  TempoStack
      metadata:
        name: simplest
        namespace: chainsaw-multitenancy
      spec:
        storage:
          secret:
            name: minio
            type: s3
        storageSize: 1Gi
        resources:
          total:
            limits:
              memory: 2Gi
              cpu: 2000m
        tenants:
          mode: openshift
          authentication:
            - tenantName: dev
              tenantId: "1610b0c3-c509-4592-a256-a1871353dbfa"
            - tenantName: prod
              tenantId: "1610b0c3-c509-4592-a256-a1871353dbfb"
        template:
          gateway:
            enabled: true
          queryFrontend:
            jaegerQuery:
              enabled: true
      

       

              rhn-support-mleonov Max Leonov
              rhn-support-ikanse Ishwar Kanse
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: