Uploaded image for project: 'OpenShift Service Mesh'
  1. OpenShift Service Mesh
  2. OSSM-6296

Make OTEL + Tempo default tracing integration for service mesh

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Done-Errata
    • Icon: Blocker Blocker
    • OSSM 2.6.0
    • OSSM 2.5.0
    • Documentation, Maistra
    • None
    • Make OTEL + Tempo tracing default
    • False
    • None
    • False
    • Documentation (Ref Guide, User Guide, etc.), Release Notes
    • Done
    • 0% To Do, 0% In Progress, 100% Done
    • Hide
      DRAFTINESS

      Include in "Upgrading" --> Upgrade changes from 2.5 to 2.6 and in "New Features" for increased visbility
      --------------
      See Rel Note entry for OSSM-6391

      {SMProductName} 2.6 is the last release that includes support for {JaegerName} and {es-op}. Both {JaegerName} and {es-op} will be removed in the next release. If you are currently using {JaegerName} and {es-op}, you need to switch to {TempoName} and {OTELName}.

      Include under "New Features"
      ------
      Integration with {TempoName} and {OTELName}

      This release introduces a generally available integration of the tracing extension provider(s) {TempoName} and {OTELName}.

      You can expose tracing data to the {TempoName} by appending a named element and the `opentelemetry` provider to the `spec.meshConfig.extensionProviders` specification in the `ServiceMehControlPlane`. Then, a telemetry custom resource configures Istio proxies to collect trace spans and send them to the OpenTelemetry Collector endpoint.

      You can create a {OTELName} instance in a mesh namespace and configure it to send tracing data to a tracing platform backend service.
      Show
      DRAFTINESS Include in "Upgrading" --> Upgrade changes from 2.5 to 2.6 and in "New Features" for increased visbility -------------- See Rel Note entry for OSSM-6391 {SMProductName} 2.6 is the last release that includes support for {JaegerName} and {es-op}. Both {JaegerName} and {es-op} will be removed in the next release. If you are currently using {JaegerName} and {es-op}, you need to switch to {TempoName} and {OTELName}. Include under "New Features" ------ Integration with {TempoName} and {OTELName} This release introduces a generally available integration of the tracing extension provider(s) {TempoName} and {OTELName}. You can expose tracing data to the {TempoName} by appending a named element and the `opentelemetry` provider to the `spec.meshConfig.extensionProviders` specification in the `ServiceMehControlPlane`. Then, a telemetry custom resource configures Istio proxies to collect trace spans and send them to the OpenTelemetry Collector endpoint. You can create a {OTELName} instance in a mesh namespace and configure it to send tracing data to a tracing platform backend service.

      In 2.5, we:

      • Added support for Tempo and OTEL with OSSM
      • Formally deprecated Jaeger and Elasticsearch as operators.

      Jaeger and Elasticsearch will be EOLed by the tracing team around the same time that 2.6 is EOLed, thus, we must ask our customers to move off of Jaeger/ES in the 2.6 timeframe and ensure that new OSSM users do not start with Jaeger/ES. OTEL + Tempo is now the canonical tracing setup that Red Hat supports.

      Thus, in 2.6, we need to:

      • Disable the OSSM operator's Jaeger and ES installation by default. New installations should now have no tracing is enabled via the OSSM operator. Users should NOT be directed to install the Jaeger or Elasticsearch operators - this documentation should be removed or move to a separate section where it is clearly marked as deprecated.
      • Direct users to configure tracing with OTEL + Tempo. We will need to add additional documentation for OTEL, as this was not completed for 2.5. OTEL + Tempo in 2.5. This includes Kiali integration. This content should be similar if not identical for OSSM 3.0, so let's try to reuse.
      • Address any issues raised against OTEL + Tempo in 2.5 Z streams (not an item for this epic, just noting).
      • Provide a section on migrating from Jaeger to OTEL + Tempo, leveraging any content the tracing team has on this topic. We do not need to provide any content/guarantees beyond what the tracing team provides here. 
      • Document in 2.6 release notes that this will be the final release of OSSM that includes support for Jaeger and ES - it will be removed in the next release. Customers should migrate to OTEL + Tempo.

              yuaxu@redhat.com Yuanlin Xu
              jlongmui@redhat.com Jamie Longmuir
              Votes:
              1 Vote for this issue
              Watchers:
              13 Start watching this issue

                Created:
                Updated:
                Resolved: