diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index f6f7ba2ac51f..b954b1ab94d2 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -2628,6 +2628,8 @@ Topics: Topics: - Name: Release notes for the Red Hat build of OpenTelemetry File: otel-rn + - Name: About the Red Hat build of OpenTelemetry + File: otel-architecture - Name: Installing the Red Hat build of OpenTelemetry File: otel-installing - Name: Configuring the Collector diff --git a/modules/distr-tracing-product-overview.adoc b/modules/distr-tracing-product-overview.adoc deleted file mode 100644 index 23f23deccf46..000000000000 --- a/modules/distr-tracing-product-overview.adoc +++ /dev/null @@ -1,22 +0,0 @@ -// Module included in the following assemblies: -// -// * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1.adoc -// * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc -// * observability/distr-tracing-architecture.adoc -// * service_mesh/v2x/ossm-architecture.adoc -// * serverless/serverless-tracing.adoc - -:_mod-docs-content-type: CONCEPT -[id="distr-tracing-product-overview_{context}"] -= Distributed tracing overview - -As a service owner, you can use distributed tracing to instrument your services to gather insights into your service architecture. -You can use the {DTProductName} for monitoring, network profiling, and troubleshooting the interaction between components in modern, cloud-native, microservices-based applications. - -With the {DTShortName}, you can perform the following functions: - -* Monitor distributed transactions - -* Optimize performance and latency - -* Perform root cause analysis diff --git a/modules/distr-tracing-tempo-about-rn.adoc b/modules/distr-tracing-tempo-about-rn.adoc new file mode 100644 index 000000000000..e098bf56159e --- /dev/null +++ b/modules/distr-tracing-tempo-about-rn.adoc @@ -0,0 +1,14 @@ +// Module included in the following assemblies: +// +// * observability/distr_tracing/distr-tracing-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="distr-tracing-product-overview_{context}"] += About this release + +{DTShortName} 3.7 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/tempo-operator-bundle/642c3e0eacf1b5bdbba7654a/history[{TempoOperator} 0.18.0] and based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.8.2. + +[NOTE] +==== +Some linked Jira tickets are accessible only with Red Hat credentials. +==== diff --git a/modules/distr-tracing-tempo-coo-ui-plugin.adoc b/modules/distr-tracing-tempo-coo-ui-plugin.adoc new file mode 100644 index 000000000000..0e91a45e85d8 --- /dev/null +++ b/modules/distr-tracing-tempo-coo-ui-plugin.adoc @@ -0,0 +1,9 @@ +// Module included in the following assemblies: +// +// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc + +:_mod-docs-content-type: REFERENCE +[id="distr-tracing-tempo-coo-ui-plugin_{context}"] += Configuring the UI + +You can use the distributed tracing UI plugin of the {coo-first} as the user interface (UI) for the {DTProductName}. For more information about installing and using the distributed tracing UI plugin, see "Distributed tracing UI plugin" in _Cluster Observability Operator_. diff --git a/modules/distr-tracing-tempo-key-concepts-in-distributed-tracing.adoc b/modules/distr-tracing-tempo-key-concepts-in-distributed-tracing.adoc new file mode 100644 index 000000000000..e9a398fcf98e --- /dev/null +++ b/modules/distr-tracing-tempo-key-concepts-in-distributed-tracing.adoc @@ -0,0 +1,38 @@ +// Module included in the following assemblies: +// +// * observability/distr-tracing-architecture.adoc +// * service_mesh/v2x/ossm-architecture.adoc +// * service_mesh/v1x/ossm-architecture.adoc +// * serverless/observability/tracing/serverless-tracing.adoc + +:_mod-docs-content-type: CONCEPT +[id="distr-tracing-tempo-key-concepts-in-distributed-tracing_{context}"] += Key concepts in distributed tracing + +Every time a user takes an action in an application, a request is executed by the architecture that may require dozens of different services to participate to produce a response. +{DTProductName} lets you perform distributed tracing, which records the path of a request through various microservices that make up an application. + +_Distributed tracing_ is a technique that is used to tie the information about different units of work together — usually executed in different processes or hosts — to understand a whole chain of events in a distributed transaction. +Developers can visualize call flows in large microservice architectures with distributed tracing. +It is valuable for understanding serialization, parallelism, and sources of latency. + +{DTProductName} records the execution of individual requests across the whole stack of microservices, and presents them as traces. A _trace_ is a data/execution path through the system. An end-to-end trace consists of one or more spans. + +A _span_ represents a logical unit of work in {DTProductName} that has an operation name, the start time of the operation, and the duration, as well as potentially tags and logs. Spans may be nested and ordered to model causal relationships. + +As a service owner, you can use distributed tracing to instrument your services to gather insights into your service architecture. +You can use {DTProductName} for monitoring, network profiling, and troubleshooting the interaction between components in modern, cloud-native, microservices-based applications. + +With {DTShortName}, you can perform the following functions: + +* Monitor distributed transactions + +* Optimize performance and latency + +* Perform root cause analysis + +You can combine {DTShortName} with other relevant components of the {product-title}: + +* {OTELName} for forwarding traces to a TempoStack instance + +* Distributed tracing UI plugin of the {coo-first} diff --git a/modules/distr-tracing-tempo-rn-bug-fixes.adoc b/modules/distr-tracing-tempo-rn-bug-fixes.adoc new file mode 100644 index 000000000000..d558376a40ed --- /dev/null +++ b/modules/distr-tracing-tempo-rn-bug-fixes.adoc @@ -0,0 +1,11 @@ +// Module included in the following assemblies: +// +// * observability/distr_tracing/distr-tracing-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="fixed-issues_{context}"] += Fixed issues + +This release fixes the following CVE: + +* link:https://access.redhat.com/security/cve/cve-2025-22874[CVE-2025-22874] diff --git a/modules/distr-tracing-tempo-rn-deprecated-features.adoc b/modules/distr-tracing-tempo-rn-deprecated-features.adoc new file mode 100644 index 000000000000..b8d6782eb40e --- /dev/null +++ b/modules/distr-tracing-tempo-rn-deprecated-features.adoc @@ -0,0 +1,9 @@ +// Module included in the following assemblies: +// +// * observability/distr_tracing/distr-tracing-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="deprecated-features_{context}"] += Deprecated features + +None. diff --git a/modules/distr-tracing-tempo-rn-enhancements.adoc b/modules/distr-tracing-tempo-rn-enhancements.adoc new file mode 100644 index 000000000000..341376d1b84a --- /dev/null +++ b/modules/distr-tracing-tempo-rn-enhancements.adoc @@ -0,0 +1,10 @@ +// Module included in the following assemblies: +// +// * observability/distr_tracing/distr-tracing-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="new-features-and-enhancements_{context}"] += New features and enhancements + +Network policy to restrict API access:: +With this update, the {TempoOperator} creates a network policy for the Operator to restrict access to the used APIs. diff --git a/modules/distr-tracing-tempo-rn-known-issues.adoc b/modules/distr-tracing-tempo-rn-known-issues.adoc new file mode 100644 index 000000000000..3af762896e94 --- /dev/null +++ b/modules/distr-tracing-tempo-rn-known-issues.adoc @@ -0,0 +1,14 @@ +// Module included in the following assemblies: +// +// * observability/distr_tracing/distr-tracing-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="known-issues_{context}"] += Known issues + +Tempo query frontend fails to fetch trace JSON:: +In the Jaeger UI, clicking on *Trace* and refreshing the page, or accessing *Trace* -> *Trace Timeline* -> *Trace JSON* from the Tempo query frontend, might result in the Tempo query pod failing with an EOF error. ++ +To work around this problem, use the distributed tracing UI plugin to view traces. ++ +link:https://issues.redhat.com/browse/TRACING-5483[TRACING-5483] diff --git a/modules/distr-tracing-tempo-rn-removed-features.adoc b/modules/distr-tracing-tempo-rn-removed-features.adoc new file mode 100644 index 000000000000..1789077fba3b --- /dev/null +++ b/modules/distr-tracing-tempo-rn-removed-features.adoc @@ -0,0 +1,9 @@ +// Module included in the following assemblies: +// +// * observability/distr_tracing/distr-tracing-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="removed-features_{context}"] += Removed features + +None. diff --git a/modules/distr-tracing-tempo-rn-technology-preview-features.adoc b/modules/distr-tracing-tempo-rn-technology-preview-features.adoc new file mode 100644 index 000000000000..4804e534952c --- /dev/null +++ b/modules/distr-tracing-tempo-rn-technology-preview-features.adoc @@ -0,0 +1,12 @@ +// Module included in the following assemblies: +// +// * observability/distr_tracing/distr-tracing-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="technology-preview-features_{context}"] += Technology Preview features + +None. + +//:FeatureName: Each of these features +//include::snippets/technology-preview.adoc[leveloffset=+1] diff --git a/modules/otel-about-rn.adoc b/modules/otel-about-rn.adoc new file mode 100644 index 000000000000..a161ef6e99c0 --- /dev/null +++ b/modules/otel-about-rn.adoc @@ -0,0 +1,14 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="otel-product-overview_{context}"] += About this release + +{OTELName} 3.7 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/opentelemetry-operator-bundle/615618406feffc5384e84400/history[{OTELOperator} 0.135.0] and based on the open source link:https://opentelemetry.io/docs/collector/[OpenTelemetry] release 0.135.0. + +[NOTE] +==== +Some linked Jira tickets are accessible only with Red Hat credentials. +==== diff --git a/modules/otel-product-overview.adoc b/modules/otel-about.adoc similarity index 76% rename from modules/otel-product-overview.adoc rename to modules/otel-about.adoc index f6d6a354efbf..42f14b836961 100644 --- a/modules/otel-product-overview.adoc +++ b/modules/otel-about.adoc @@ -1,21 +1,20 @@ // Module included in the following assemblies: // -// * observability/otel/otel_rn/otel-rn-3-2.adoc -// * observability/otel/otel_rn/otel-rn-past-releases.adoc +// * observability/otel/otel-architecture.adoc :_mod-docs-content-type: CONCEPT -[id="otel-product-overview_{context}"] -= {OTELName} overview +[id="otel-about-product_{context}"] += About {OTELName} -{OTELName} is based on the open source link:https://opentelemetry.io/[OpenTelemetry project], which aims to provide unified, standardized, and vendor-neutral telemetry data collection for cloud-native software. {OTELName} product provides support for deploying and managing the OpenTelemetry Collector and simplifying the workload instrumentation. +{OTELName} is based on the open source link:https://opentelemetry.io/[OpenTelemetry project], which aims to provide unified, standardized, and vendor-neutral telemetry data collection for cloud-native software. {OTELName} provides support for deploying and managing the OpenTelemetry Collector and simplifying the workload instrumentation. The link:https://opentelemetry.io/docs/collector/[OpenTelemetry Collector] can receive, process, and forward telemetry data in multiple formats, making it the ideal component for telemetry processing and interoperability between telemetry systems. The Collector provides a unified solution for collecting and processing metrics, traces, and logs. -The OpenTelemetry Collector has a number of features including the following: +The OpenTelemetry Collector provides several features including the following: Data Collection and Processing Hub:: It acts as a central component that gathers telemetry data like metrics and traces from various sources. This data can be created from instrumented applications and infrastructure. -Customizable telemetry data pipeline:: The OpenTelemetry Collector is designed to be customizable. It supports various processors, exporters, and receivers. +Customizable telemetry data pipeline:: The OpenTelemetry Collector is customizable and supports various processors, exporters, and receivers. Auto-instrumentation features:: Automatic instrumentation simplifies the process of adding observability to applications. Developers don't need to manually instrument their code for basic telemetry data. @@ -26,3 +25,5 @@ Centralized data collection:: In a microservices architecture, the Collector can Data enrichment and processing:: Before forwarding data to analysis tools, the Collector can enrich, filter, and process this data. Multi-backend receiving and exporting:: The Collector can receive and send data to multiple monitoring and analysis platforms simultaneously. + +You can use {OTELName} in combination with {TempoName}. diff --git a/modules/otel-collector-deployment-modes.adoc b/modules/otel-collector-deployment-modes.adoc new file mode 100644 index 000000000000..47327bb7404e --- /dev/null +++ b/modules/otel-collector-deployment-modes.adoc @@ -0,0 +1,45 @@ +//Module included in the following assemblies: +// +// * observability/otel/otel-collector/otel-collector-configuration-intro.adoc + +:_mod-docs-content-type: REFERENCE +[id="otel-collector-deployment-modes_{context}"] += Deployment modes + +The `OpenTelemetryCollector` custom resource allows you to specify one of the following deployment modes for the OpenTelemetry Collector: + +Deployment:: The default. + +StatefulSet:: If you need to run stateful workloads, for example when using the Collector's File Storage Extension or Tail Sampling Processor, use the StatefulSet deployment mode. + +DaemonSet:: If you need to scrape telemetry data from every node, for example by using the Collector's Filelog Receiver to read container logs, use the DaemonSet deployment mode. + +Sidecar:: If you need access to log files inside a container, inject the Collector as a sidecar, and use the Collector's Filelog Receiver and a shared volume such as `emptyDir`. ++ +If you need to configure an application to send telemetry data via `localhost`, inject the Collector as a sidecar, and set up the Collector to forward the telemetry data to an external service via an encrypted and authenticated connection. The Collector runs in the same pod as the application when injected as a sidecar. ++ +[NOTE] +==== + +If you choose the sidecar deployment mode, then in addition to setting the `spec.mode: sidecar` field in the `OpenTelemetryCollector` custom resource CR, you must also set the `sidecar.opentelemetry.io/inject` annotation as a pod annotation or namespace annotation. If you set this annotation on both the pod and namespace, the pod annotation takes precedence if it is set to either `false` or the `OpenTelemetryCollector` CR name. + +As a pod annotation, the `sidecar.opentelemetry.io/inject` annotation supports several values: + +[source,yaml] +---- +apiVersion: v1 +kind: Pod +metadata: + ... + annotations: + sidecar.opentelemetry.io/inject: "" <1> +... +---- +<1> Supported values: ++ +`false`:: Does not inject the Collector. This is the default if the annotation is missing. +`true`:: Injects the Collector with the configuration of the `OpenTelemetryCollector` CR in the same namespace. +``:: Injects the Collector with the configuration of the `` `OpenTelemetryCollector` CR in the same namespace. +`/`:: Injects the Collector with the configuration of the `` `OpenTelemetryCollector` CR in the `` namespace. + +==== diff --git a/modules/otel-config-send-metrics-monitoring-stack.adoc b/modules/otel-config-send-metrics-monitoring-stack.adoc index a9a471e572e1..db13a40da63d 100644 --- a/modules/otel-config-send-metrics-monitoring-stack.adoc +++ b/modules/otel-config-send-metrics-monitoring-stack.adoc @@ -27,7 +27,12 @@ spec: service: telemetry: metrics: - address: ":8888" + readers: + - pull: + exporter: + prometheus: + host: 0.0.0.0 + port: 8888 pipelines: metrics: exporters: [prometheus] diff --git a/modules/otel-forwarding-data-to-third-party-systems.adoc b/modules/otel-forwarding-data-to-third-party-systems.adoc new file mode 100644 index 000000000000..8f97d5ca468e --- /dev/null +++ b/modules/otel-forwarding-data-to-third-party-systems.adoc @@ -0,0 +1,100 @@ +//Module included in the following assemblies: +// +// * observability/otel/otel-forwarding-data.adoc + +:_mod-docs-content-type: PROCEDURE +[id="otel-forwarding-data-to-third-party-systems_{context}"] += Forwarding telemetry data to third-party systems + +The OpenTelemetry Collector exports telemetry data by using the OTLP exporter via the OpenTelemetry Protocol (OTLP) that is implemented over the gRPC or HTTP transports. If you need to forward telemetry data to your third-party system and it does not support the OTLP or other supported protocol in the {OTELShortName}, then you can deploy an unsupported custom OpenTelemetry Collector that can receive telemetry data via the OTLP and export it to your third-party system by using a custom exporter. + +[WARNING] +==== +Red{nbsp}Hat does not support custom deployments. +==== + +.Prerequisites + +* You have developed your own unsupported custom exporter that can export telemetry data via the OTLP to your third-party system. + +.Procedure + +* Deploy a custom Collector either through the OperatorHub or manually: + +** If your third-party system supports it, deploy the custom Collector by using the OperatorHub. + +** Deploy the custom Collector manually by using a config map, deployment, and service. ++ +.Example of a custom Collector deployment +[source,yaml] +---- +apiVersion: v1 +kind: ConfigMap +metadata: + name: custom-otel-collector-config +data: + otel-collector-config.yaml: | + receivers: + otlp: + protocols: + grpc: + exporters: + debug: {} + prometheus: + service: + pipelines: + traces: + receivers: [otlp] + exporters: [debug] # <1> +--- +apiVersion: apps/v1 +kind: Deployment +metadata: + name: custom-otel-collector-deployment +spec: + replicas: 1 + selector: + matchLabels: + component: otel-collector + template: + metadata: + labels: + component: otel-collector + spec: + containers: + - name: opentelemetry-collector + image: ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:latest # <2> + command: + - "/otelcol-contrib" + - "--config=/conf/otel-collector-config.yaml" + ports: + - name: otlp + containerPort: 4317 + protocol: TCP + volumeMounts: + - name: otel-collector-config-vol + mountPath: /conf + readOnly: true + volumes: + - name: otel-collector-config-vol + configMap: + name: custom-otel-collector-config +--- +apiVersion: v1 +kind: Service +metadata: + name: custom-otel-collector-service # <3> + labels: + component: otel-collector +spec: + type: ClusterIP + ports: + - name: otlp-grpc + port: 4317 + targetPort: 4317 + selector: + component: otel-collector +---- +<1> Replace `debug` with the required exporter for your third-party system. +<2> Replace the image with the required version of the OpenTelemetry Collector that has the required exporter for your third-party system. +<3> The service name is used in the Red Hat build of OpenTelemetry Collector CR to configure the OTLP exporter. diff --git a/modules/otel-processors-probabilistic-sampling-processor.adoc b/modules/otel-processors-probabilistic-sampling-processor.adoc new file mode 100644 index 000000000000..3c14424aca3f --- /dev/null +++ b/modules/otel-processors-probabilistic-sampling-processor.adoc @@ -0,0 +1,74 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-collector/ + +:_mod-docs-content-type: REFERENCE +[id="otel-processors-probabilistic-sampling-processor_{context}"] += Probabilistic Sampling Processor + +If you handle high volumes of telemetry data and seek to reduce costs by reducing processed data volumes, you can use the Probabilistic Sampling Processor as an alternative to the Tail Sampling Processor. + +The processor samples a specified percentage of trace spans or log records statelessly and per request. + +The processor adds the information about the used effective sampling probability into the telemetry data: + +* In trace spans, the processor encodes the threshold and optional randomness information in the W3C Trace Context `tracestate` fields. + +* In log records, the processor encodes the threshold and randomness information as attributes. + +The following is an example `OpenTelemetryCollector` custom resource configuration for the Probabilistic Sampling Processor for sampling trace spans: + +[source,yaml] +---- +# ... + config: + processors: + probabilistic_sampler: # <1> + sampling_percentage: 15.3 # <2> + mode: "proportional" # <3> + hash_seed: 22 # <4> + sampling_precision: 14 # <5> + fail_closed: true # <6> +# ... +service: + pipelines: + traces: + processors: [probabilistic_sampler] +# ... +---- +<1> For trace pipelines, the source of randomness is the hashed value of the span trace ID. +<2> Required. Accepts a 32-bit floating-point percentage value at which spans are to be sampled. +<3> Optional. Accepts a supported string value for a sampling logic mode: the default `hash_seed`, `proportional`, or `equalizing`. The `hash_seed` mode applies the Fowler–Noll–Vo (FNV) hash function to the trace ID and weighs the hashed value against the sampling percentage value. You can also use the `hash_seed` mode with units of telemetry other than the trace ID. The `proportional` mode samples a strict, probability-based ratio of the total span quantity, and is based on the OpenTelemetry and World Wide Web Consortium specifications. The `equalizing` mode is useful for lowering the sampling probability to a minimum value across a whole pipeline or applying a uniform sampling probability in Collector deployments where client SDKs have mixed sampling configurations. +<4> Optional. Accepts a 32-bit unsigned integer, which is used to compute the hash algorithm. When this field is not configured, the default seed value is `0`. If you use multiple tiers of Collector instances, you must configure all Collectors of the same tier to the same seed value. +<5> Optional. Determines the number of hexadecimal digits used to encode the sampling threshold. Accepts an integer value. The supported values are `1`-`14`. The default value `4` causes the threshold to be rounded if it contains more than 16 significant bits, which is the case of the `proportional` mode that uses 56 bits. If you select the `proportional` mode, use a greater value for the purpose of preserving precision applied by preceding samplers. +<6> Optional. Rejects spans with sampling errors. Accepts a boolean value. The default value is `true`. + +The following is an example `OpenTelemetryCollector` custom resource configuration for the Probabilistic Sampling Processor for sampling log records: + +[source,yaml] +---- +# ... + config: + processors: + probabilistic_sampler/logs: + sampling_percentage: 15.3 # <1> + mode: "hash_seed" # <2> + hash_seed: 22 # <3> + sampling_precision: 4 # <4> + attribute_source: "record" # <5> + from_attribute: "" # <6> + fail_closed: true # <7> +# ... +service: + pipelines: + logs: + processors: [ probabilistic_sampler/logs ] +# ... +---- +<1> Required. Accepts a 32-bit floating-point percentage value at which spans are to be sampled. +<2> Optional. Accepts a supported string value for a sampling logic mode: the default `hash_seed`, `equalizing`, or `proportional`. The `hash_seed` mode applies the Fowler–Noll–Vo (FNV) hash function to the trace ID or a specified log record attribute and then weighs the hashed value against the sampling percentage value. You can also use `hash_seed` mode with other units of telemetry than trace ID, for example to use the `service.instance.id` resource attribute for collecting log records from a percentage of pods. The `equalizing` mode is useful for lowering the sampling probability to a minimum value across a whole pipeline or applying a uniform sampling probability in Collector deployments where client SDKs have mixed sampling configurations. The `proportional` mode samples a strict, probability-based ratio of the total span quantity, and is based on the OpenTelemetry and World Wide Web Consortium specifications. +<3> Optional. Accepts a 32-bit unsigned integer, which is used to compute the hash algorithm. When this field is not configured, the default seed value is `0`. If you use multiple tiers of Collector instances, you must configure all Collectors of the same tier to the same seed value. +<4> Optional. Determines the number of hexadecimal digits used to encode the sampling threshold. Accepts an integer value. The supported values are `1`-`14`. The default value `4` causes the threshold to be rounded if it contains more than 16 significant bits, which is the case of the `proportional` mode that uses 56 bits. If you select the `proportional` mode, use a greater value for the purpose of preserving precision applied by preceding samplers. +<5> Optional. Defines where to look for the log record attribute in `from_attribute`. The log record attribute is used as the source of randomness. Accept the default `traceID` value or the `record` value. +<6> Optional. The name of a log record attribute to be used to compute the sampling hash, such as a unique log record ID. Accepts a string value. The default value is `""`. Use this field only if you need to specify a log record attribute as the source of randomness in those situations where the trace ID is absent or trace ID sampling is disabled or the `attribute_source` field is set to the `record` value. +<7> Optional. Rejects spans with sampling errors. Accepts a boolean value. The default value is `true`. diff --git a/modules/otel-rn-bug-fixes.adoc b/modules/otel-rn-bug-fixes.adoc new file mode 100644 index 000000000000..f6cd0b710328 --- /dev/null +++ b/modules/otel-rn-bug-fixes.adoc @@ -0,0 +1,9 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="fixed-issues_{context}"] += Fixed issues + +None. diff --git a/modules/otel-rn-deprecated-features.adoc b/modules/otel-rn-deprecated-features.adoc new file mode 100644 index 000000000000..d81b7869e1a1 --- /dev/null +++ b/modules/otel-rn-deprecated-features.adoc @@ -0,0 +1,31 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="deprecated-features_{context}"] += Deprecated features + +The OpenCensus Receiver is deprecated:: +The OpenCensus Receiver, which provided backward compatibility with the OpenCensus format, is deprecated and might be removed in a future release. + +The Collector's service metrics telemetry address is deprecated:: +The `metrics.address` field in the `OpenTelemetryCollector` custom resource (CR) is deprecated and might be removed in a future release. As an alternative, use the `metrics.readers` field instead. ++ +Example of using the `readers` field: ++ +[source,yaml] +---- +# ... + config: + service: + telemetry: + metrics: + readers: + - pull: + exporter: + prometheus: + host: 0.0.0.0 + port: 8888 +# ... +---- diff --git a/modules/otel-rn-enhancements.adoc b/modules/otel-rn-enhancements.adoc new file mode 100644 index 000000000000..ac1419f1a65d --- /dev/null +++ b/modules/otel-rn-enhancements.adoc @@ -0,0 +1,11 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="new-features-and-enhancements_{context}"] += New features and enhancements + +Network policy to restrict API access:: With this update, the {OTELOperator} creates a network policy for itself and the OpenTelemetry Collector to restrict access to the used APIs. + +Native sidecars:: With this update, the {OTELOperator} uses native sidecars on {product-title} 4.16 or later. diff --git a/modules/otel-rn-known-issues.adoc b/modules/otel-rn-known-issues.adoc new file mode 100644 index 000000000000..5671fd676015 --- /dev/null +++ b/modules/otel-rn-known-issues.adoc @@ -0,0 +1,9 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="known-issues_{context}"] += Known issues + +None. diff --git a/modules/otel-rn-removed-features.adoc b/modules/otel-rn-removed-features.adoc new file mode 100644 index 000000000000..c9b63b60f76a --- /dev/null +++ b/modules/otel-rn-removed-features.adoc @@ -0,0 +1,13 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="removed-features_{context}"] += Removed features + +The LokiStack Exporter is removed:: +The LokiStack Exporter, which exported data to a LokiStack instance, is removed and no longer supported. You can export data to a LokiStack instance by using the OTLP HTTP Exporter instead. + +The Routing Processor is removed:: +The Routing Processor, which routed telemetry data to an exporter is removed and no longer supported. You can route telemetry data by using the Routing Connector instead. diff --git a/modules/otel-rn-technology-preview-features.adoc b/modules/otel-rn-technology-preview-features.adoc new file mode 100644 index 000000000000..bb9a051b7d25 --- /dev/null +++ b/modules/otel-rn-technology-preview-features.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-rn.adoc + +:_mod-docs-content-type: REFERENCE +[id="technology-preview-features_{context}"] += Technology Preview features + +[IMPORTANT] +==== +[subs="attributes+"] +Technology Preview features are not supported with Red{nbsp}Hat production service level agreements (SLAs) and might not be functionally complete. Red{nbsp}Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. + +For more information about the support scope of Red{nbsp}Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]. +==== + +Probabilistic Sampling Processor (Technology Preview):: +This release introduces the Probabilistic Sampling Processor as a Technology Preview feature for the {OTELShortName} Collector. The Probabilistic Sampling Processor samples a specified percentage of trace spans or log records statelessly and per request. You can use the Probabilistic Sampling Processor if you handle high volumes of telemetry data and seek to reduce costs by reducing processed data volumes. diff --git a/modules/otel-troubleshoot-network-policies.adoc b/modules/otel-troubleshoot-network-policies.adoc new file mode 100644 index 000000000000..f349de640e14 --- /dev/null +++ b/modules/otel-troubleshoot-network-policies.adoc @@ -0,0 +1,35 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-troubleshooting.adoc + +:_mod-docs-content-type: PROCEDURE +[id="troubleshoot-network-policies_{context}"] += Disabling network policies + +The {OTELOperator} creates network policies to control the traffic for the Operator and operands to improve security. +By default, the network policies are enabled and configured to allow traffic to all the required components. No additional configuration is needed. + +If you are experiencing traffic issues for the OpenTelemetry Collector or its Target Allocator component, the problem might be caused by the default network policy configuration. You can disable network policies for the OpenTelemetry Collector to troubleshoot the issue. + +.Prerequisites + +* You have access to the cluster as a cluster administrator with the `cluster-admin` role. + +.Procedure + +* Disable the network policy for the OpenTelemetry Collector by configuring the `OpenTelemetryCollector` custom resource (CR): ++ +[source,yaml] +---- +apiVersion: opentelemetry.io/v1beta1 +kind: OpenTelemetryCollector +metadata: + name: otel + namespace: observability +spec: + networkPolicy: + enabled: false # <1> + # ... +---- +<1> Specify whether to enable network policies by setting `networkPolicy.enabled` to `true` (default) or `false`. Setting it to `false` disables the creation of network policies. + diff --git a/observability/distr_tracing/distr-tracing-architecture.adoc b/observability/distr_tracing/distr-tracing-architecture.adoc index 61f1df297e3e..b9fc5f074585 100644 --- a/observability/distr_tracing/distr-tracing-architecture.adoc +++ b/observability/distr_tracing/distr-tracing-architecture.adoc @@ -6,26 +6,24 @@ include::_attributes/common-attributes.adoc[] toc::[] -Every time a user takes an action in an application, a request is executed by the architecture that may require dozens of different services to participate to produce a response. -{DTProductName} lets you perform distributed tracing, which records the path of a request through various microservices that make up an application. +include::modules/distr-tracing-tempo-key-concepts-in-distributed-tracing.adoc[leveloffset=+1] -_Distributed tracing_ is a technique that is used to tie the information about different units of work together — usually executed in different processes or hosts — to understand a whole chain of events in a distributed transaction. -Developers can visualize call flows in large microservice architectures with distributed tracing. -It is valuable for understanding serialization, parallelism, and sources of latency. - -{DTProductName} records the execution of individual requests across the whole stack of microservices, and presents them as traces. A _trace_ is a data/execution path through the system. An end-to-end trace is comprised of one or more spans. - -A _span_ represents a logical unit of work in {DTProductName} that has an operation name, the start time of the operation, and the duration, as well as potentially tags and logs. Spans may be nested and ordered to model causal relationships. - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +// xreffing to the installation page until further notice because OTEL content is currently planned for internal restructuring across pages that is likely to result in renamed page files +* xref:../../observability/otel/otel-installing.adoc#install-otel[{OTELName}] +* xref:../../observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc#distributed-tracing-ui-plugin[Distributed tracing UI plugin] include::modules/distr-tracing-features.adoc[leveloffset=+1] include::modules/distr-tracing-architecture.adoc[leveloffset=+1] +//// [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources // xreffing to the installation page until further notice because OTEL content is currently planned for internal restructuring across pages that is likely to result in renamed page files * xref:../../observability/otel/otel-installing.adoc#install-otel[{OTELName}] +* xref:../../observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc#distributed-tracing-ui-plugin[Distributed tracing UI plugin] +//// \ No newline at end of file diff --git a/observability/distr_tracing/distr-tracing-rn.adoc b/observability/distr_tracing/distr-tracing-rn.adoc index 56e51a072866..745b4ff61a1f 100644 --- a/observability/distr_tracing/distr-tracing-rn.adoc +++ b/observability/distr_tracing/distr-tracing-rn.adoc @@ -1,1955 +1,29 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="distr-tracing-rn"] -= Release notes for the {TempoName} += Release notes for the {TempoName} 3.7 :context: distr-tracing-rn -toc::[] -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] +toc::[] -You can use the {TempoName} xref:../../observability/otel/otel-forwarding-telemetry-data.adoc#otel-forwarding-telemetry-data[in combination with] the xref:../../observability/otel/otel-rn.adoc#otel_rn[{OTELName}]. +include::modules/distr-tracing-tempo-about-rn.adoc[leveloffset=+1] include::snippets/distr-tracing-and-otel-disclaimer-about-docs-for-supported-features-only.adoc[] -[id="distr-tracing_3-6-1_{context}"] -== Release notes for the {TempoName} 3.6.1 - -The {TempoName} 3.6.1 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/tempo-operator-bundle/642c3e0eacf1b5bdbba7654a/history[{TempoOperator} 0.16.0]. - -The {TempoName} 3.6.1 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.7.2. - -[id="distr-tracing_3-6-1_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-2025-4673[CVE-2025-4673] -* link:https://access.redhat.com/security/cve/CVE-2025-6020[CVE-2025-6020] - -[id="distr-tracing_3-6-1_tempo-release-notes_known-issues_{context}"] -=== Known issues - -The {TempoName} 3.6.1 has the following known issue: - -* Currently, when the `openshift` tenancy mode is enabled, the `ServiceAccount` object of the gateway component of either a `TempoStack` or `TempoMonolithic` instance requires the `TokenReview` and `SubjectAccessReview` permissions for authorization. -+ -Workaround: Deploy the instance in a dedicated namespace, and carefully audit which users have the permission to read the secrets in this namespace. - -[id="distr-tracing_3-6_{context}"] -== Release notes for {DTShortName} 3.6 - -[id="distr-tracing_3-6_tempo-release-notes_{context}"] -=== {TempoName} - -The {TempoName} 3.6 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/tempo-operator-bundle/642c3e0eacf1b5bdbba7654a/history[{TempoOperator} 0.16.0]. - -The {TempoName} 3.6 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.7.2. - -[WARNING] -==== -This is the first release of the {DTProductName} that is shipped only with the {TempoName} and without the deprecated {JaegerName}. - -If you have not migrated from the deprecated {JaegerName} Operator to the {TempoOperator} and the {OTELName} Operator for distributed tracing collection and storage, see "Release notes for {DTProductName} 3.5". -==== - -[id="distr-tracing_3-6_tempo-release-notes_technology-preview-features_{context}"] -==== Technology Preview features - -This update introduces the following Technology Preview feature: - -* TempoStack deployment combined with the distributed tracing UI plugin of the {coo-first} supports fine-grained query role-based access control (RBAC). With the enabled RBAC, your users can see the attributes only from the namespaces to which they are given access. - -:FeatureName: The fine-grained query RBAC for the UI plugin -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="distr-tracing_3-6_tempo-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements: - -* Support for authentication using the Google Cloud Platform (GCP) Workload Identity Federation short-lived tokens. This enables secure and temporary credential access for workloads running with the GCP. - -* Support for authentication using the Azure Workload Identity Federation short-lived tokens. This allows secure and temporary access for workloads federated with the Azure Active Directory. - -* Support for the AWS Security Token Service (STS) through the CloudCredential Operator. This allows the use of dynamic and temporary AWS credentials for workloads. - -//// -[id="distr-tracing_3-6_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* ??? -//// - -[id="distr-tracing_3-6_tempo-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fixes: - -* Before this update, the per-tenant retention configuration was not properly configured in the `TempoStack` instance. With this update, the per-tenant retention is properly configured in the `TempoStack` deployment. - -* Before this update, the `oauth-proxy` container did not have any compute resources assigned to it. With this update, the container correctly sets the resources as specified in the `TempoStack` custom resource. - -[id="distr-tracing_3-6_tempo-release-notes_known-issues_{context}"] -==== Known issues - -The {TempoName} 3.6 has the following known issue: - -* Currently, when the `openshift` tenancy mode is enabled, the `ServiceAccount` object of the gateway component of either a `TempoStack` or `TempoMonolithic` instance requires the `TokenReview` and `SubjectAccessReview` permissions for authorization. -+ -Workaround: Deploy the instance in a dedicated namespace, and carefully audit which users have the permission to read the secrets in this namespace. - -[id="distr-tracing_3-5_{context}"] -== Release notes for {DTProductName} 3.5 - -This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}. - -[IMPORTANT] -==== -The {TempoName} 3.5.1 patch release has been released. -==== - -//// -[id="distr-tracing_3-5_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* ??? -//// - -[id="distr-tracing_3-5_tempo-release-notes_{context}"] -=== {TempoName} 3.5 - -The {TempoName} 3.5 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/tempo-operator-bundle/642c3e0eacf1b5bdbba7654a/history[{TempoOperator} 0.15.3]. - -[NOTE] -==== -The {TempoName} 3.5 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.7.1. -==== - -[id="distr-tracing_3-5_tempo-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements: - -* With this update, you can configure the Tempo backend services to report the internal tracing data by using the OpenTelemetry Protocol (OTLP). -* With this update, the `traces.span.metrics` namespace becomes the default metrics namespace on which the Jaeger query retrieves the Prometheus metrics. The purpose of this change is to provide compatibility with the OpenTelemetry Collector version 0.109.0 and later where this namespace is the default. Customers who are still using an earlier OpenTelemetry Collector version can configure this namespace by adding the following field and value: `spec.template.queryFrontend.jaegerQuery.monitorTab.redMetricsNamespace: ""`. - -[id="distr-tracing_3-5_tempo-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fix: - -//// -* Before this update, the `oauth-proxy` container did not have any compute resources assigned to it. With this update, the container correctly sets the resources as specified in the `TempoStack` custom resource. -//// - -* Before this update, the {TempoOperator} failed when the `TempoStack` custom resource had the `spec.storage.tls.enabled` field set to `true` and used an Amazon S3 object store with the Security Token Service (STS) authentication. With this update, such a `TempoStack` custom resource configuration does not cause the {TempoOperator} to fail. - -[id="distr-tracing_3-5_tempo-release-notes_known-issues_{context}"] -==== Known issues - -The {TempoName} 3.5 has the following known issue: - -* Currently, when the OpenShift tenancy mode is enabled, the `ServiceAccount` object of the gateway component of a `TempoStack` or `TempoMonolithic` instance requires the `TokenReview` and `SubjectAccessReview` permissions for authorization. -+ -Workaround: Deploy the instance in a dedicated namespace, and carefully audit which users have the permission to read the secrets in this namespace. - -[id="distr-tracing_3-5-1_tempo-release-notes_{context}"] -=== {TempoName} 3.5.1 - -The {TempoName} 3.5.1 is a patch release. - -[id="distr-tracing_3-5-1_tempo-release-notes_cves_{context}"] -==== CVEs - -The {TempoName} 3.5.1 patch release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-2025-2786[CVE-2025-2786] - -* link:https://access.redhat.com/security/cve/CVE-2025-2842[CVE-2025-2842] - -* link:https://access.redhat.com/security/cve/CVE-2025-30204[CVE-2025-30204] - -[id="distr-tracing_3-5-1_tempo-release-notes_breaking-changes_{context}"] -==== Breaking changes - -The {TempoName} 3.5.1 update introduces the following breaking change: - -* With this update, for a user to create or modify a `TempoStack` or `TempoMonolithic` custom resource with enabled multi-tenancy, the user must have permissions to create the `TokenReview` and `SubjectAccessReview` authorization objects. - -[id="distr-tracing_3-5-1_tempo-release-notes_known-issues_{context}"] -==== Known issues - -The {TempoName} 3.5.1 has the following known issue: - -* Currently, when the OpenShift tenancy mode is enabled, the `ServiceAccount` object of the gateway component of a `TempoStack` or `TempoMonolithic` instance requires the `TokenReview` and `SubjectAccessReview` permissions for authorization. -+ -Workaround: Deploy the instance in a dedicated namespace, and carefully audit which users have the permission to read the secrets in this namespace. - -[id="distr-tracing_3-5_jaeger-release-notes_{context}"] -=== {JaegerName} 3.5 - -The {JaegerName} 3.5 is the last release of the {JaegerName} that Red Hat plans to support. - -In the {DTProductName} 3.5, Jaeger and support for Elasticsearch remain deprecated. - -[WARNING] -==== -Support for the {JaegerName} ends on November 3, 2025. - -The {JaegerOperator} Operator (Jaeger) will be removed from the `redhat-operators` catalog on November 3, 2025. -==== - -You must migrate to the {OTELName} Operator and the {TempoOperator} for distributed tracing collection and storage. For more information, see the following resources: - -* xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating] ({OTELShortName} documentation) - -* xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] ({OTELName} documentation) - -* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing] ({TempoShortName} documentation) - -* link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift] (Red Hat Knowledgebase solution) - -[NOTE] -==== -The {JaegerName} 3.5 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.65.0. -==== -// 1.62.0 was fixed until Jaeger's removal - -The {JaegerName} 3.5 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/jaeger-operator-bundle/613b50f3a052bb39f2c5f31e/history[{JaegerOperator} Operator 1.65.0]. - -[IMPORTANT] -==== -Jaeger does not use FIPS validated cryptographic modules. -==== - -[id="distr-tracing_3-5_jaeger-release-notes_support-for-elasticsearch-operator_{context}"] -==== Support for the {es-op} - -The {JaegerName} 3.5 is supported for use with the {es-op} 5.6, 5.7, and 5.8. - -[role="_additional-resources"] -.Additional resources -* link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift] (Red Hat Knowledgebase) -* xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating] ({OTELName} documentation) -* xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] ({OTELName} documentation) -* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing] ({DTShortName} documentation) - -//// -[id="distr-tracing_3-5_jaeger-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fix: - -* ??? - -//// - -[id="distr-tracing_3-5_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -There are currently known issues: - -* Currently, Apache Spark is not supported. - -ifndef::openshift-rosa[] - -* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -[id="distr-tracing_3-4_{context}"] -== Release notes for {DTProductName} 3.4 - -This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}. - -[id="distr-tracing_3-4_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-2024-21536[CVE-2024-21536] -* link:https://access.redhat.com/security/cve/CVE-2024-43796[CVE-2024-43796] -* link:https://access.redhat.com/security/cve/CVE-2024-43799[CVE-2024-43799] -* link:https://access.redhat.com/security/cve/CVE-2024-43800[CVE-2024-43800] -* link:https://access.redhat.com/security/cve/CVE-2024-45296[CVE-2024-45296] -* link:https://access.redhat.com/security/cve/CVE-2024-45590[CVE-2024-45590] -* link:https://access.redhat.com/security/cve/CVE-2024-45811[CVE-2024-45811] -* link:https://access.redhat.com/security/cve/CVE-2024-45812[CVE-2024-45812] -* link:https://access.redhat.com/security/cve/CVE-2024-47068[CVE-2024-47068] -* link:https://bugzilla.redhat.com/show_bug.cgi?id=2312579[Cross-site Scripting (XSS) in `serialize-javascript`] - -[id="distr-tracing_3-4_tempo-release-notes_{context}"] -=== {TempoName} - -The {TempoName} 3.4 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/tempo-operator-bundle/642c3e0eacf1b5bdbba7654a/history[{TempoOperator} 0.14.1]. - -[NOTE] -==== -The {TempoName} 3.4 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.6.1. -==== - -[id="distr-tracing_3-4_tempo-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements: - -* The monitor tab in the Jaeger UI for TempoStack instances uses a new default metrics namespace: `traces.span.metrics`. Before this update, the Jaeger UI used an empty namespace. The new `traces.span.metrics` namespace default is also used by the OpenTelemetry Collector 0.113.0. You can set the empty value for the metrics namespace by using the following field in the `TempoStack` custom resouce: `spec.template.queryFrontend.monitorTab.redMetricsNamespace: ""`. -+ -[WARNING] -==== -This is a breaking change. If you are using both the {TempoName} and {OTELName}, you must upgrade to the {OTELName} 3.4 before upgrading to the {TempoName} 3.4. -==== - -* New and optional `spec.timeout` field in the `TempoStack` and `TempoMonolithic` custom resource definitions for configuring one timeout value for all components. The timeout value is set to 30 seconds, `30s`, by default. -+ -[WARNING] -==== -This is a breaking change. -==== - -[id="distr-tracing_3-4_tempo-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fixes: - -* Before this update, the {TempoShortName} failed on the {ibm-z-title} (`s390x`) architecture. With this update, the {TempoShortName} is available for the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) -* Before this update, the {TempoShortName} failed on clusters with non-private networks. With this update, you can deploy the {TempoShortName} on clusters with non-private networks. (link:https://issues.redhat.com/browse/TRACING-4507[TRACING-4507]) -* Before this update, the Jaeger UI might fail due to reaching a trace quantity limit, resulting in the *504 Gateway Timeout* error in the `tempo-query` logs. After this update, the issue is resolved by introducing two optional fields in the `tempostack` or `tempomonolithic` custom resource: -+ -** New `spec.timeout` field for configuring the timeout. -** New `spec.template.queryFrontend.jaegerQuery.findTracesConcurrentRequests` field for improving the query performance of the Jaeger UI. -+ -[TIP] -==== -One querier can handle up to 20 concurrent queries by default. Increasing the number of concurrent queries further is achieved by scaling up the querier instances. -==== - -[id="distr-tracing_3-4_jaeger-release-notes_{context}"] -=== {JaegerName} - -The {JaegerName} 3.4 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/jaeger-operator-bundle/613b50f3a052bb39f2c5f31e/history[{JaegerOperator} Operator 1.62.0]. - -[NOTE] -==== -The {JaegerName} 3.4 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.62.0. -==== -// 1.62.0 is fixed until Jaeger's removal - -[IMPORTANT] -==== -Jaeger does not use FIPS validated cryptographic modules. -==== - -[id="distr-tracing_3-4_jaeger-release-notes_support-for-elasticsearch-operator_{context}"] -==== Support for the {es-op} - -The {JaegerName} 3.4 is supported for use with the {es-op} 5.6, 5.7, and 5.8. - -[id="distr-tracing_3-4_jaeger-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {DTProductName} 3.4, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. -Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements. - -The {JaegerOperator} Operator (Jaeger) will be removed from the `redhat-operators` catalog in a future release. For more information, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift]. - -You must migrate to the {OTELName} Operator and the {TempoOperator} for distributed tracing collection and storage. For more information, see xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating] in the {OTELShortName} documentation, xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] in the {OTELName} documentation, and xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing] in the {TempoShortName} documentation. - -[role="_additional-resources"] -.Additional resources -* link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift (Red Hat Knowledgebase)] -* xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating ({OTELName} documentation)] -* xref:../../observability/otel/otel-installing.adoc#install-otel[Installing ({OTELName} documentation)] -* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing ({DTShortName} documentation)] - -[id="distr-tracing_3-4_jaeger-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fix: - -* Before this update, the Jaeger UI could fail with the *502 - Bad Gateway Timeout* error. After this update, you can configure timeout in ingress annotations. (link:https://issues.redhat.com/browse/TRACING-4238[TRACING-4238]) - -[id="distr-tracing_3-4_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -There are currently known issues: - -* Currently, Apache Spark is not supported. - -ifndef::openshift-rosa[] - -* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -[id="distr-tracing_3-3-1_{context}"] -== Release notes for {DTProductName} 3.3.1 - -The {DTProductName} 3.3.1 is a maintenance release with no changes because the {DTProductName} is bundled with the {OTELName} that is xref:../../observability/otel/otel-rn.adoc#otel_rn[released] with a bug fix. - -This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}. - -//// -[id="distr-tracing_3-3-1_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-202?-????/[CVE-202?-????] -//// - -[id="distr-tracing_3-3-1_tempo-release-notes_{context}"] -=== {TempoName} - -The {TempoName} is provided through the {TempoOperator}. - -The {TempoName} 3.3.1 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.5.0. - -//// -[id="distr-tracing_3-3-1_tempo-release-notes_technology-preview-features_{context}"] -==== Technology Preview features - -This update introduces the following Technology Preview feature: - -* ???. - -:FeatureName: The Tempo monolithic deployment -include::snippets/technology-preview.adoc[leveloffset=+1] -//// - -//// -[id="distr-tracing_3-3-1_tempo-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements: - -* ???. -//// - -//// -[id="distr-tracing_3-3-1_tempo-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {TempoName} 3.3.1, ???. -//// - -//// -[id="distr-tracing_3-3-1_tempo-release-notes_removal-notice_{context}"] -==== Removal notice - -In the {TempoName} 3.3.1, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -//// -[id="distr-tracing_3-3-1_tempo-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fixes: - -* ????. (link:https://issues.redhat.com/browse/TRACING-????[TRACING-????]) -//// - -[id="distr-tracing_3-3-1_tempo-release-notes_known-issues_{context}"] -==== Known issues - -There is currently a known issue: - -* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -[id="distr-tracing_3-3-1_jaeger-release-notes_{context}"] -=== {JaegerName} - -The {JaegerName} is provided through the {JaegerOperator} Operator. - -The {JaegerName} 3.3.1 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.57.0. - -[IMPORTANT] -==== -Jaeger does not use FIPS validated cryptographic modules. -==== - -[id="distr-tracing_3-3-1_jaeger-release-notes_support-for-elasticsearch-operator_{context}"] -==== Support for the {es-op} - -The {JaegerName} 3.3.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8. - -[id="distr-tracing_3-3-1_jaeger-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {DTProductName} 3.3.1, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. -Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements. - -The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[migrate] to the xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[{TempoOperator}] and the xref:../../observability/otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage. - -//// -[id="distr-tracing_3-3-1_jaeger-release-notes_removal-notice_{context}"] -==== Removal notice - -In the {JaegerName} 3.3.1, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -//// -[id="distr-tracing_3-3-1_jaeger-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fixes: - -* Before this update, ???. With this update, ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????]) -//// - -[id="distr-tracing_3-3-1_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -There are currently known issues: - -* Currently, Apache Spark is not supported. - -ifndef::openshift-rosa[] - -* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -[id="distr-tracing_3-3_{context}"] -== Release notes for {DTProductName} 3.3 - -This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}. - -//// -[id="distr-tracing_3-3_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-202?-????/[CVE-202?-????] -//// - -[id="distr-tracing_3-3_tempo-release-notes_{context}"] -=== {TempoName} - -The {TempoName} is provided through the {TempoOperator}. - -The {TempoName} 3.3 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.5.0. - -//// -[id="distr-tracing_3-3_tempo-release-notes_technology-preview-features_{context}"] -==== Technology Preview features - -This update introduces the following Technology Preview feature: - -* ???. - -:FeatureName: The Tempo monolithic deployment -include::snippets/technology-preview.adoc[leveloffset=+1] -//// - -[id="distr-tracing_3-3_tempo-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements: - -* Support for securing the Jaeger UI and Jaeger APIs with the OpenShift OAuth Proxy. (link:https://issues.redhat.com/browse/TRACING-4108[TRACING-4108]) -* Support for using the service serving certificates, which are generated by {product-title}, on ingestion APIs when multitenancy is disabled. (link:https://issues.redhat.com/browse/TRACING-3954[TRACING-3954]) -* Support for ingesting by using the OTLP/HTTP protocol when multitenancy is enabled. (link:https://issues.redhat.com/browse/TRACING-4171[TRACING-4171]) -* Support for the AWS S3 Secure Token authentication. (link:https://issues.redhat.com/browse/TRACING-4176[TRACING-4176]) -* Support for automatically reloading certificates. (link:https://issues.redhat.com/browse/TRACING-4185[TRACING-4185]) -* Support for configuring the duration for which service names are available for querying. (link:https://issues.redhat.com/browse/TRACING-4214[TRACING-4214]) - -//// -[id="distr-tracing_3-3_tempo-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {TempoName} 3.3, ???. -//// - -//// -[id="distr-tracing_3-3_tempo-release-notes_removal-notice_{context}"] -==== Removal notice - -In the {TempoName} 3.3, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -[id="distr-tracing_3-3_tempo-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fixes: - -* Before this update, storage certificate names did not support dots. With this update, storage certificate name can contain dots. (link:https://issues.redhat.com/browse/TRACING-4348[TRACING-4348]) -* Before this update, some users had to select a certificate when accessing the gateway route. With this update, there is no prompt to select a certificate. (link:https://issues.redhat.com/browse/TRACING-4431[TRACING-4431]) -* Before this update, the gateway component was not scalable. With this update, the gateway component is scalable. (link:https://issues.redhat.com/browse/TRACING-4497[TRACING-4497]) -* Before this update the Jaeger UI might fail with the *504 Gateway Time-out* error when accessed via a route. With this update, users can specify route annotations for increasing timeout, such as `haproxy.router.openshift.io/timeout: 3m`, when querying large data sets. (link:https://issues.redhat.com/browse/TRACING-4511[TRACING-4511]) - -[id="distr-tracing_3-3_tempo-release-notes_known-issues_{context}"] -==== Known issues - -There is currently a known issue: - -* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -[id="distr-tracing_3-3_jaeger-release-notes_{context}"] -=== {JaegerName} - -The {JaegerName} is provided through the {JaegerOperator} Operator. - -The {JaegerName} 3.3 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.57.0. - -[IMPORTANT] -==== -Jaeger does not use FIPS validated cryptographic modules. -==== - -[id="distr-tracing_3-3_jaeger-release-notes_support-for-elasticsearch-operator_{context}"] -==== Support for the {es-op} - -The {JaegerName} 3.3 is supported for use with the {es-op} 5.6, 5.7, and 5.8. - -[id="distr-tracing_3-3_jaeger-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {DTProductName} 3.3, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. -Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements. - -The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[migrate] to the xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[{TempoOperator}] and the xref:../../observability/otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage. - -//// -[id="distr-tracing_3-3_jaeger-release-notes_removal-notice_{context}"] -==== Removal notice - -In the {JaegerName} 3.3, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -//// -[id="distr-tracing_3-3_jaeger-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fixes: - -* Before this update, ???. With this update, ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????]) -//// - -[id="distr-tracing_3-3_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -There are currently known issues: - -* Currently, Apache Spark is not supported. - -ifndef::openshift-rosa[] - -* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -[id="distr-tracing_3-2-2_{context}"] -== Release notes for {DTProductName} 3.2.2 - -This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}. - -[id="distr-tracing_3-2-2_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-2023-2953/[CVE-2023-2953] -* link:https://access.redhat.com/security/cve/CVE-2024-28182[CVE-2024-28182] - -[id="distr-tracing_3-2-2_tempo-release-notes_{context}"] -=== {TempoName} - -The {TempoName} is provided through the {TempoOperator}. - -//// -[id="distr-tracing_3-2-2_tempo-release-notes_technology-preview-features_{context}"] -==== Technology Preview features - -This update introduces the following Technology Preview feature: - -* Support for the Tempo monolithic deployment. - -:FeatureName: The Tempo monolithic deployment -include::snippets/technology-preview.adoc[leveloffset=+1] -//// - -//// -[id="distr-tracing_3-2-2_tempo-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements: - -* {TempoName} 3.2.2 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.4.1. -//// - -//// -[id="distr-tracing_3-2-2_tempo-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {TempoName} 3.2.2, ??? -//// - -//// -[id="distr-tracing_3-2-2_tempo-release-notes_removal-notice_{context}"] -==== Removal notice - -In {TempoName} 3.2.2, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -[id="distr-tracing_3-2-2_tempo-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fix: - -* Before this update, secrets were perpetually generated on {product-title} 4.16 because the operator tried to reconcile a new `openshift.io/internal-registry-pull-secret-ref` annotation for service accounts, causing a loop. With this update, the operator ignores this new annotation. (link:https://issues.redhat.com/browse/TRACING-4434/[TRACING-4434]) - -[id="distr-tracing_3-2-2_tempo-release-notes_known-issues_{context}"] -==== Known issues - -There is currently a known issue: - -* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - - -[id="distr-tracing_3-2-2_jaeger-release-notes_{context}"] -=== {JaegerName} - -The {JaegerName} is provided through the {JaegerOperator} Operator. - -[IMPORTANT] -==== -Jaeger does not use FIPS validated cryptographic modules. -==== - -//// -[id="distr-tracing_3-2-2_jaeger-release-notes_support-for-elasticsearch-operator_{context}"] -==== Support for {es-op} - -{JaegerName} 3.2.2 is supported for use with the {es-op} 5.6, 5.7, and 5.8. -//// - -//// -[id="distr-tracing_3-2-2_jaeger-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {DTProductName} 3.2.2, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. -Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements. -The {TempoOperator} and the {OTELName} are the preferred Operators for distributed tracing collection and storage. -Users must adopt the OpenTelemetry and Tempo distributed tracing stack because it is the stack to be enhanced going forward. - -In the {DTProductName} 3.2.2, the Jaeger agent is deprecated and planned to be removed in the following release. -Red{nbsp}Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed. -The OpenTelemetry Collector provided by the {OTELName} is the preferred Operator for injecting the trace collector agent. -//// - -//// -[id="distr-tracing_3-2-2_jaeger-release-notes_removal-notice_{context}"] -==== Removal notice - -In {DTProductName} 3.2.2, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -//// -[id="distr-tracing_3-2-2_jaeger-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements for the {JaegerShortName}: - -* {JaegerName} 3.2.2 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.57.0. -//// - -[id="distr-tracing_3-2-2_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -There is currently a known issue: - -* Currently, Apache Spark is not supported. - -ifndef::openshift-rosa[] - -* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -[id="distr-tracing_3-2-1_{context}"] -== Release notes for {DTProductName} 3.2.1 - -This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}. - -[id="distr-tracing_3-2-1_cves_{context}"] -=== CVEs - -This release fixes link:https://access.redhat.com/security/cve/CVE-2024-25062/[CVE-2024-25062]. - -[id="distr-tracing_3-2-1_tempo-release-notes_{context}"] -=== {TempoName} - -The {TempoName} is provided through the {TempoOperator}. - -//// -[id="distr-tracing_3-2-1_tempo-release-notes_technology-preview-features_{context}"] -==== Technology Preview features - -This update introduces the following Technology Preview feature: - -* Support for the Tempo monolithic deployment. - -:FeatureName: The Tempo monolithic deployment -include::snippets/technology-preview.adoc[leveloffset=+1] -//// - -//// -[id="distr-tracing_3-2-1_tempo-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements: - -* {TempoName} 3.2.1 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.4.1. -//// - -//// -[id="distr-tracing_3-2-1_tempo-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {TempoName} 3.2.1, ??? -//// - -//// -[id="distr-tracing_3-2-1_tempo-release-notes_removal-notice_{context}"] -==== Removal notice - -In {TempoName} 3.2.1, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -//// -[id="distr-tracing_3-2-1_tempo-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fixes: - -* Before this update, ... . (link:https://issues.redhat.com/browse/TRACING-????[TRACING-????]) -//// - -[id="distr-tracing_3-2-1_tempo-release-notes_known-issues_{context}"] -==== Known issues - -There is currently a known issue: - -* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - - -[id="distr-tracing_3-2-1_jaeger-release-notes_{context}"] -=== {JaegerName} - -The {JaegerName} is provided through the {JaegerOperator} Operator. - -[IMPORTANT] -==== -Jaeger does not use FIPS validated cryptographic modules. -==== - -//// -[id="distr-tracing_3-2-1_jaeger-release-notes_support-for-elasticsearch-operator_{context}"] -==== Support for {es-op} - -{JaegerName} 3.2.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8. -//// - -//// -[id="distr-tracing_3-2-1_jaeger-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {DTProductName} 3.2.1, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. -Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements. -The {TempoOperator} and the {OTELName} are the preferred Operators for distributed tracing collection and storage. -Users must adopt the OpenTelemetry and Tempo distributed tracing stack because it is the stack to be enhanced going forward. - -In the {DTProductName} 3.2.1, the Jaeger agent is deprecated and planned to be removed in the following release. -Red{nbsp}Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed. -The OpenTelemetry Collector provided by the {OTELName} is the preferred Operator for injecting the trace collector agent. -//// - -//// -[id="distr-tracing_3-2-1_jaeger-release-notes_removal-notice_{context}"] -==== Removal notice - -In {DTProductName} 3.2.1, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -//// -[id="distr-tracing_3-2-1_jaeger-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements for the {JaegerShortName}: - -* {JaegerName} 3.2.1 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.57.0. -//// - -[id="distr-tracing_3-2-1_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -There is currently a known issue: - -* Currently, Apache Spark is not supported. - -ifndef::openshift-rosa[] - -* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - - -[id="distr-tracing_3-2_{context}"] -== Release notes for {DTProductName} 3.2 - -This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}. - -//// -[id="distr-tracing_3-2_cves_{context}"] -=== CVEs - -This release fixes link:https://access.redhat.com/security/cve/cve-202?-?????[CVE-202?-?????]. -//// - -[id="distr-tracing_3-2_tempo-release-notes_{context}"] -=== {TempoName} - -The {TempoName} is provided through the {TempoOperator}. - -[id="distr-tracing_3-2_tempo-release-notes_technology-preview-features_{context}"] -==== Technology Preview features - -This update introduces the following Technology Preview feature: - -* Support for the Tempo monolithic deployment. - -:FeatureName: The Tempo monolithic deployment -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="distr-tracing_3-2_tempo-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements: - -* {TempoName} 3.2 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.4.1. -* Allowing the overriding of resources per component. - -//// -[id="distr-tracing_3-2_tempo-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {TempoName} 3.2, ??? -//// - -//// -[id="distr-tracing_3-2_tempo-release-notes_removal-notice_{context}"] -==== Removal notice - -In {TempoName} 3.2, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -[id="distr-tracing_3-2_tempo-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fixes: - -* Before this update, the Jaeger UI only displayed services that sent traces in the previous 15 minutes. With this update, the availability of the service and operation names can be configured by using the following field: `spec.template.queryFrontend.jaegerQuery.servicesQueryDuration`. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139]) -* Before this update, the `query-frontend` pod might get stopped when out-of-memory (OOM) as a result of searching a large trace. With this update, resource limits can be set to prevent this issue. (link:https://issues.redhat.com/browse/TRACING-4009[TRACING-4009]) - -[id="distr-tracing_3-2_tempo-release-notes_known-issues_{context}"] -==== Known issues - -There is currently a known issue: - -* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -[id="distr-tracing_3-2_jaeger-release-notes_{context}"] -=== {JaegerName} - -The {JaegerName} is provided through the {JaegerOperator} Operator. - -[IMPORTANT] -==== -Jaeger does not use FIPS validated cryptographic modules. -==== - -[id="distr-tracing_3-2_jaeger-release-notes_support-for-elasticsearch-operator_{context}"] -==== Support for {es-op} - -{JaegerName} 3.2 is supported for use with the {es-op} 5.6, 5.7, and 5.8. - -[id="distr-tracing_3-2_jaeger-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {DTProductName} 3.2, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. -Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements. -The {TempoOperator} and the {OTELName} are the preferred Operators for distributed tracing collection and storage. -Users must adopt the OpenTelemetry and Tempo distributed tracing stack because it is the stack to be enhanced going forward. - -In the {DTProductName} 3.2, the Jaeger agent is deprecated and planned to be removed in the following release. -Red{nbsp}Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed. -The OpenTelemetry Collector provided by the {OTELName} is the preferred Operator for injecting the trace collector agent. - -//// -[id="distr-tracing_3-2_jaeger-release-notes_removal-notice_{context}"] -==== Removal notice - -In {DTProductName} 3.2, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -[id="distr-tracing_3-2_jaeger-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements for the {JaegerShortName}: - -* {JaegerName} 3.2 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.57.0. - -[id="distr-tracing_3-2_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -There is currently a known issue: - -* Currently, Apache Spark is not supported. - -ifndef::openshift-rosa[] - -* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -[id="distr-tracing_3-1-1_{context}"] -== Release notes for {DTProductName} 3.1.1 - -This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}. - -[id="distr-tracing_3-1-1_cves_{context}"] -=== CVEs - -This release fixes link:https://access.redhat.com/security/cve/cve-2023-39326[CVE-2023-39326]. - -// Tempo section -[id="distr-tracing_3-1-1_tempo-release-notes_{context}"] -=== {TempoName} - -The {TempoName} is provided through the {TempoOperator}. - -[id="distr-tracing_3-1-1_tempo-release-notes_known-issues_{context}"] -==== Known issues - -//There is currently a known issue: -There are currently known issues: - -* Currently, when used with the {TempoOperator}, the Jaeger UI only displays services that have sent traces in the last 15 minutes. For services that did not send traces in the last 15 minutes, traces are still stored but not displayed in the Jaeger UI. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139]) -* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -// Jaeger section -[id="distr-tracing_3-1-1_jaeger-release-notes_{context}"] -=== {JaegerName} - -The {JaegerName} is provided through the {JaegerOperator} Operator. - -[IMPORTANT] -==== -Jaeger does not use FIPS validated cryptographic modules. -==== - -[id="distr-tracing_3-1-1_jaeger-release-notes_support-for-elasticsearch-operator_{context}"] -==== Support for {es-op} - -{JaegerName} 3.1.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8. - -[id="distr-tracing_3-1-1_jaeger-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {DTProductName} 3.1.1, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. Red{nbsp}Hat will provide critical and above CVE bug fixes and support for these components during the current release lifecycle, but these components will no longer receive feature enhancements. - -In the {DTProductName} 3.1.1, Tempo provided by the {TempoOperator} and the OpenTelemetry Collector provided by the {OTELName} are the preferred Operators for distributed tracing collection and storage. The OpenTelemetry and Tempo distributed tracing stack is to be adopted by all users because this will be the stack that will be enhanced going forward. - -[id="distr-tracing_3-1-1_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -//There is currently a known issue: -There are currently known issues: - -* Currently, Apache Spark is not supported. - -ifndef::openshift-rosa[] - -* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -[id="distr-tracing_3-1_{context}"] -== Release notes for {DTProductName} 3.1 - -This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}. - -// Tempo section -[id="distr-tracing_3-1_tempo-release-notes_{context}"] -=== {TempoName} - -The {TempoName} is provided through the {TempoOperator}. - -//// -[id="technology-preview-features_jaeger-release-notes_distributed-tracing-rn-3-1_{context}"] -==== Technology Preview features - -This update introduces the following Technology Preview feature for the {TempoShortName}: - -* Monolithic custom resource. - -:FeatureName: The monolithic custom resource -include::snippets/technology-preview.adoc[leveloffset=+1] -//// - -[id="distr-tracing_3-1_tempo-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements for the {TempoShortName}: - -* {TempoName} 3.1 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.3.1. -* Support for cluster-wide proxy environments. -* Support for TraceQL to Gateway component. - -[id="distr-tracing_3-1_tempo-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fixes for the {TempoShortName}: - -* Before this update, when a TempoStack instance was created with the `monitorTab` enabled in {product-title} 4.15, the required `tempo-redmetrics-cluster-monitoring-view` ClusterRoleBinding was not created. This update resolves the issue by fixing the Operator RBAC for the monitor tab when the Operator is deployed in an arbitrary namespace. (link:https://issues.redhat.com/browse/TRACING-3786[TRACING-3786]) -* Before this update, when a TempoStack instance was created on an {product-title} cluster with only an IPv6 networking stack, the compactor and ingestor pods ran in the `CrashLoopBackOff` state, resulting in multiple errors. This update provides support for IPv6 clusters.(link:https://issues.redhat.com/browse/TRACING-3226[TRACING-3226]) - -[id="distr-tracing_3-1_tempo-release-notes_known-issues_{context}"] -==== Known issues - -//There is currently a known issue: -There are currently known issues: - -* Currently, when used with the {TempoOperator}, the Jaeger UI only displays services that have sent traces in the last 15 minutes. For services that did not send traces in the last 15 minutes, traces are still stored but not displayed in the Jaeger UI. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139]) -* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -// Jaeger section -[id="distr-tracing_3-1_jaeger-release-notes_{context}"] -=== {JaegerName} - -The {JaegerName} is provided through the {JaegerOperator} Operator. - -[IMPORTANT] -==== -Jaeger does not use FIPS validated cryptographic modules. -==== - -[id="distr-tracing_3-1_jaeger-release-notes_support-for-elasticsearch-operator_{context}"] -==== Support for {es-op} - -{JaegerName} 3.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8. - -[id="distr-tracing_3-1_jaeger-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {DTProductName} 3.1, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. Red{nbsp}Hat will provide critical and above CVE bug fixes and support for these components during the current release lifecycle, but these components will no longer receive feature enhancements. - -In the {DTProductName} 3.1, Tempo provided by the {TempoOperator} and the OpenTelemetry Collector provided by the {OTELName} are the preferred Operators for distributed tracing collection and storage. The OpenTelemetry and Tempo distributed tracing stack is to be adopted by all users because this will be the stack that will be enhanced going forward. - -[id="distr-tracing_3-1_jaeger-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements for the {JaegerShortName}: - -* {JaegerName} 3.1 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.53.0. - -[id="distr-tracing_3-1_jaeger-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fix for the {JaegerShortName}: - -* Before this update, the connection target URL for the `jaeger-agent` container in the `jager-query` pod was overwritten with another namespace URL in {product-title} 4.13. This was caused by a bug in the sidecar injection code in the `jaeger-operator`, causing nondeterministic `jaeger-agent` injection. With this update, the Operator prioritizes the Jaeger instance from the same namespace as the target deployment. (link:https://issues.redhat.com/browse/TRACING-3722[TRACING-3722]) - -[id="distr-tracing_3-1_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -//There is currently a known issue: -There are currently known issues: - -* Currently, Apache Spark is not supported. - -ifndef::openshift-rosa[] - -* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -[id="distr-tracing_3.0_{context}"] -== Release notes for {DTProductName} 3.0 - -[id="distr-tracing_3-0_component-versions_{context}"] -=== Component versions in the {DTProductName} 3.0 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.51.0 - -|{TempoName} -|Tempo -|2.3.0 -|=== - -// Jaeger section -[id="distr-tracing_3-0_jaeger-release-notes_{context}"] -=== {JaegerName} - -[id="distr-tracing_3-0_jaeger-release-notes_deprecated-functionality_{context}"] -==== Deprecated functionality - -In the {DTProductName} 3.0, Jaeger and support for Elasticsearch are deprecated, and both are planned to be removed in a future release. Red{nbsp}Hat will provide critical and above CVE bug fixes and support for these components during the current release lifecycle, but these components will no longer receive feature enhancements. - -In the {DTProductName} 3.0, Tempo provided by the {TempoOperator} and the OpenTelemetry Collector provided by the {OTELName} are the preferred Operators for distributed tracing collection and storage. The OpenTelemetry and Tempo distributed tracing stack is to be adopted by all users because this will be the stack that will be enhanced going forward. - -[id="distr-tracing_3-0_jaeger-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements for the {JaegerShortName}: - -* Support for the ARM architecture. -* Support for cluster-wide proxy environments. - -[id="distr-tracing_3-0_jaeger-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fix for the {JaegerShortName}: - -* Before this update, the {JaegerName} Operator used other images than `relatedImages`. This caused the *ImagePullBackOff* error in disconnected network environments when launching the `jaeger` pod because the `oc adm catalog mirror` command mirrors images specified in `relatedImages`. This update provides support for disconnected environments when using the `oc adm catalog mirror` CLI command. (link:https://issues.redhat.com/browse/TRACING-3546[TRACING-3546]) - -[id="distr-tracing_3-0_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -There is currently a known issue: -//There are currently known issues: - -* Currently, Apache Spark is not supported. - -ifndef::openshift-rosa[] - -* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -// Tempo section -[id="distr-tracing_3-0_tempo-release-notes_{context}"] -=== {TempoName} - -[id="distr-tracing_3-0_tempo-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This update introduces the following enhancements for the {TempoShortName}: - -* Support for the ARM architecture. -* Support for span request count, duration, and error count (RED) metrics. The metrics can be visualized in the Jaeger console deployed as part of Tempo or in the web console in the *Observe* menu. - -[id="distr-tracing_3-0_tempo-release-notes_bug-fixes_{context}"] -==== Bug fixes - -This update introduces the following bug fixes for the {TempoShortName}: - -* Before this update, the `TempoStack` CRD was not accepting custom CA certificate despite the option to choose CA certificates. This update fixes support for the custom TLS CA option for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) -* Before this update, when mirroring the {DTProductName} Operator images to a mirror registry for use in a disconnected cluster, the related Operator images for `tempo`, `tempo-gateway`, `opa-openshift`, and `tempo-query` were not mirrored. This update fixes support for disconnected environments when using the `oc adm catalog mirror` CLI command. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) -* Before this update, the query frontend service of the {DTProductName} was using internal mTLS when gateway was not deployed. This caused endpoint failure errors. This update fixes mTLS when Gateway is not deployed. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) - -[id="distr-tracing_3-0_tempo-release-notes_known-issues_{context}"] -==== Known issues - -//There is currently a known issue: -There are currently known issues: - -* Currently, when used with the {TempoOperator}, the Jaeger UI only displays services that have sent traces in the last 15 minutes. For services that did not send traces in the last 15 minutes, traces are still stored but not displayed in the Jaeger UI. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139]) -* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -[id="distr-tracing_2-9-2_{context}"] -== Release notes for {DTProductName} 2.9.2 - -[id="distr-tracing_2-9-2_component-versions_{context}"] -=== Component versions in the {DTProductName} 2.9.2 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.47.0 - -|{TempoName} -|Tempo -|2.1.1 -|=== - -=== CVEs - -This release fixes link:https://bugzilla.redhat.com/show_bug.cgi?id=2246470[CVE-2023-46234]. - -[id="distr-tracing_2-9-2_jaeger-release-notes_{context}"] -=== {JaegerName} - -[id="distr-tracing_2-9-2_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -//There is currently a known issue: -There are currently known issues: - -* Apache Spark is not supported. -ifndef::openshift-rosa[] - -* The streaming deployment via AMQ/Kafka is unsupported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -[id="distr-tracing_2-9-2_tempo-release-notes_{context}"] -=== {TempoName} - -:FeatureName: The {TempoName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="distr-tracing_2-9-2_tempo-release-notes_known-issues_{context}"] -==== Known issues - -//There is currently a known issue: -There are currently known issues: - -* Currently, the custom TLS CA option is not implemented for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) - -* Currently, when used with the {TempoOperator}, the Jaeger UI only displays services that have sent traces in the last 15 minutes. For services that did not send traces in the last 15 minutes, traces are still stored but not displayed in the Jaeger UI. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139]) - -* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -* Currently, the Tempo query frontend service must not use internal mTLS when Gateway is not deployed. This issue does not affect the Jaeger Query API. The workaround is to disable mTLS. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) -+ -.Workaround -+ -Disable mTLS as follows: -+ -. Open the {TempoOperator} ConfigMap for editing by running the following command: -+ -[source,terminal] ----- -$ oc edit configmap tempo-operator-manager-config -n openshift-tempo-operator <1> ----- -<1> The project where the {TempoOperator} is installed. - -. Disable the mTLS in the Operator configuration by updating the YAML file: -+ -[source,yaml] ----- -data: - controller_manager_config.yaml: | - featureGates: - httpEncryption: false - grpcEncryption: false - builtInCertManagement: - enabled: false ----- - -. Restart the {TempoOperator} pod by running the following command: -+ -[source,terminal] ----- -$ oc rollout restart deployment.apps/tempo-operator-controller -n openshift-tempo-operator ----- - - -* Missing images for running the {TempoOperator} in restricted environments. The {TempoName} CSV is missing references to the operand images. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) -+ -.Workaround -+ -Add the {TempoOperator} related images in the mirroring tool to mirror the images to the registry: -+ -[source,yaml] ----- -kind: ImageSetConfiguration -apiVersion: mirror.openshift.io/v1alpha2 -archiveSize: 20 -storageConfig: - local: - path: /home/user/images -mirror: - operators: - - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.13 - packages: - - name: tempo-product - channels: - - name: stable - additionalImages: - - name: registry.redhat.io/rhosdt/tempo-rhel8@sha256:e4295f837066efb05bcc5897f31eb2bdbd81684a8c59d6f9498dd3590c62c12a - - name: registry.redhat.io/rhosdt/tempo-gateway-rhel8@sha256:b62f5cedfeb5907b638f14ca6aaeea50f41642980a8a6f87b7061e88d90fac23 - - name: registry.redhat.io/rhosdt/tempo-gateway-opa-rhel8@sha256:8cd134deca47d6817b26566e272e6c3f75367653d589f5c90855c59b2fab01e9 - - name: registry.redhat.io/rhosdt/tempo-query-rhel8@sha256:0da43034f440b8258a48a0697ba643b5643d48b615cdb882ac7f4f1f80aad08e ----- - -[id="distr-tracing_2-9-1_{context}"] -== Release notes for {DTProductName} 2.9.1 - -[id="distr-tracing_2-9-1_component-versions_{context}"] -=== Component versions in the {DTProductName} 2.9.1 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.47.0 - -|{TempoName} -|Tempo -|2.1.1 -|=== - -=== CVEs - -This release fixes link:https://access.redhat.com/security/cve/cve-2023-44487[CVE-2023-44487]. - -[id="distr-tracing_2-9-1_jaeger-release-notes_{context}"] -=== {JaegerName} - -[id="distr-tracing_2-9-1_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -//There is currently a known issue: -There are currently known issues: - -* Apache Spark is not supported. -ifndef::openshift-rosa[] - -* The streaming deployment via AMQ/Kafka is unsupported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -[id="distr-tracing_2-9-1_tempo-release-notes_{context}"] -=== {TempoName} - -:FeatureName: The {TempoName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="distr-tracing_2-9-1_tempo-release-notes_known-issues_{context}"] -==== Known issues - -//There is currently a known issue: -There are currently known issues: - -* Currently, the custom TLS CA option is not implemented for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) - -* Currently, when used with the {TempoOperator}, the Jaeger UI only displays services that have sent traces in the last 15 minutes. For services that did not send traces in the last 15 minutes, traces are still stored but not displayed in the Jaeger UI. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139]) - -* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -* Currently, the Tempo query frontend service must not use internal mTLS when Gateway is not deployed. This issue does not affect the Jaeger Query API. The workaround is to disable mTLS. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) -+ -.Workaround -+ -Disable mTLS as follows: -+ -. Open the {TempoOperator} ConfigMap for editing by running the following command: -+ -[source,terminal] ----- -$ oc edit configmap tempo-operator-manager-config -n openshift-tempo-operator <1> ----- -<1> The project where the {TempoOperator} is installed. - -. Disable the mTLS in the Operator configuration by updating the YAML file: -+ -[source,yaml] ----- -data: - controller_manager_config.yaml: | - featureGates: - httpEncryption: false - grpcEncryption: false - builtInCertManagement: - enabled: false ----- - -. Restart the {TempoOperator} pod by running the following command: -+ -[source,terminal] ----- -$ oc rollout restart deployment.apps/tempo-operator-controller -n openshift-tempo-operator ----- - -* Missing images for running the {TempoOperator} in restricted environments. The {TempoName} CSV is missing references to the operand images. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) -+ -.Workaround -+ -Add the {TempoOperator} related images in the mirroring tool to mirror the images to the registry: -+ -[source,yaml] ----- -kind: ImageSetConfiguration -apiVersion: mirror.openshift.io/v1alpha2 -archiveSize: 20 -storageConfig: - local: - path: /home/user/images -mirror: - operators: - - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.13 - packages: - - name: tempo-product - channels: - - name: stable - additionalImages: - - name: registry.redhat.io/rhosdt/tempo-rhel8@sha256:e4295f837066efb05bcc5897f31eb2bdbd81684a8c59d6f9498dd3590c62c12a - - name: registry.redhat.io/rhosdt/tempo-gateway-rhel8@sha256:b62f5cedfeb5907b638f14ca6aaeea50f41642980a8a6f87b7061e88d90fac23 - - name: registry.redhat.io/rhosdt/tempo-gateway-opa-rhel8@sha256:8cd134deca47d6817b26566e272e6c3f75367653d589f5c90855c59b2fab01e9 - - name: registry.redhat.io/rhosdt/tempo-query-rhel8@sha256:0da43034f440b8258a48a0697ba643b5643d48b615cdb882ac7f4f1f80aad08e ----- - -[id="distr-tracing_2-9_{context}"] -== Release notes for {DTProductName} 2.9 - -[id="distr-tracing_2-9_component-versions_{context}"] -=== Component versions in the {DTProductName} 2.9 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.47.0 - -|{TempoName} -|Tempo -|2.1.1 -|=== - -[id="distr-tracing_2-9_jaeger-release-notes_{context}"] -=== {JaegerName} - -//// -[id="distr-tracing_2-9_jaeger-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements -* None. -//// - -//// -[id="technology-preview-features_jaeger-release-notes_distributed-tracing-rn-2-9_{context}"] -==== Technology Preview features -None. -//// - -[id="distr-tracing_2-9_jaeger-release-notes_bug-fixes_{context}"] -==== Bug fixes - -* Before this update, connection was refused due to a missing gRPC port on the `jaeger-query` deployment. This issue resulted in `transport: Error while dialing: dial tcp :16685: connect: connection refused` error message. With this update, the Jaeger Query gRPC port (16685) is successfully exposed on the Jaeger Query service. (link:https://issues.redhat.com/browse/TRACING-3322[TRACING-3322]) - -* Before this update, the wrong port was exposed for `jaeger-production-query`, resulting in refused connection. With this update, the issue is fixed by exposing the Jaeger Query gRPC port (16685) on the Jaeger Query deployment. (link:https://issues.redhat.com/browse/TRACING-2968[TRACING-2968]) - -* Before this update, when deploying {SMProductShortName} on {sno} clusters in disconnected environments, the Jaeger pod frequently went into the `Pending` state. With this update, the issue is fixed. (link:https://issues.redhat.com/browse/TRACING-3312[TRACING-3312]) - -* Before this update, the Jaeger Operator pod restarted with the default memory value due to the `reason: OOMKilled` error message. With this update, this issue is fixed by removing the resource limits. (link:https://issues.redhat.com/browse/TRACING-3173[TRACING-3173]) - -[id="distr-tracing_2-9_jaeger-release-notes_known-issues_{context}"] -==== Known issues - -//There is currently a known issue: -There are currently known issues: - -* Apache Spark is not supported. -ifndef::openshift-rosa[] - -* The streaming deployment via AMQ/Kafka is unsupported on the {ibm-z-title} and {ibm-power-title} architectures. -endif::openshift-rosa[] - -[id="distr-tracing_2-9_tempo-release-notes_{context}"] -=== {TempoName} - -:FeatureName: The {TempoName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="distr-tracing_2-9_tempo-release-notes_new-features-and-enhancements_{context}"] -==== New features and enhancements - -This release introduces the following enhancements for the {TempoShortName}: - -* Support the link:https://operatorframework.io/operator-capabilities/[operator maturity] Level IV, Deep Insights, which enables upgrading, monitoring, and alerting of the TempoStack instances and the {TempoOperator}. - -* Add Ingress and Route configuration for the Gateway. - -* Support the `managed` and `unmanaged` states in the `TempoStack` custom resource. - -* Expose the following additional ingestion protocols in the Distributor service: Jaeger Thrift binary, Jaeger Thrift compact, Jaeger gRPC, and Zipkin. When the Gateway is enabled, only the OpenTelemetry protocol (OTLP) gRPC is enabled. - -* Expose the Jaeger Query gRPC endpoint on the Query Frontend service. - -* Support multitenancy without Gateway authentication and authorization. - -//// -[id="2-9_tempo-release-notes_technology-preview-features_{context}"] -=== Technology Preview features -None. -//// - -[id="distr-tracing_2-9_tempo-release-notes_bug-fixes_{context}"] -==== Bug fixes - -* Before this update, the {TempoOperator} was not compatible with disconnected environments. With this update, the {TempoOperator} supports disconnected environments. (link:https://issues.redhat.com/browse/TRACING-3145[TRACING-3145]) - -* Before this update, the {TempoOperator} with TLS failed to start on {product-title}. With this update, the mTLS communication is enabled between Tempo components, the Operand starts successfully, and the Jaeger UI is accessible. (link:https://issues.redhat.com/browse/TRACING-3091[TRACING-3091]) - -* Before this update, the resource limits from the {TempoOperator} caused error messages such as `reason: OOMKilled`. With this update, the resource limits for the {TempoOperator} are removed to avoid such errors. (link:https://issues.redhat.com/browse/TRACING-3204[TRACING-3204]) - -[id="distr-tracing_2-9_tempo-release-notes_known-issues_{context}"] -==== Known issues - -//There is currently a known issue: -There are currently known issues: - -* Currently, the custom TLS CA option is not implemented for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) - -* Currently, when used with the {TempoOperator}, the Jaeger UI only displays services that have sent traces in the last 15 minutes. For services that did not send traces in the last 15 minutes, traces are still stored but not displayed in the Jaeger UI. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139]) - -* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -* Currently, the Tempo query frontend service must not use internal mTLS when Gateway is not deployed. This issue does not affect the Jaeger Query API. The workaround is to disable mTLS. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) -+ -.Workaround -+ -Disable mTLS as follows: -+ -. Open the {TempoOperator} ConfigMap for editing by running the following command: -+ -[source,terminal] ----- -$ oc edit configmap tempo-operator-manager-config -n openshift-tempo-operator <1> ----- -<1> The project where the {TempoOperator} is installed. - -. Disable the mTLS in the Operator configuration by updating the YAML file: -+ -[source,yaml] ----- -data: - controller_manager_config.yaml: | - featureGates: - httpEncryption: false - grpcEncryption: false - builtInCertManagement: - enabled: false ----- - -. Restart the {TempoOperator} pod by running the following command: -+ -[source,terminal] ----- -$ oc rollout restart deployment.apps/tempo-operator-controller -n openshift-tempo-operator ----- - - -* Missing images for running the {TempoOperator} in restricted environments. The {TempoName} CSV is missing references to the operand images. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) -+ -.Workaround -+ -Add the {TempoOperator} related images in the mirroring tool to mirror the images to the registry: -+ -[source,yaml] ----- -kind: ImageSetConfiguration -apiVersion: mirror.openshift.io/v1alpha2 -archiveSize: 20 -storageConfig: - local: - path: /home/user/images -mirror: - operators: - - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.13 - packages: - - name: tempo-product - channels: - - name: stable - additionalImages: - - name: registry.redhat.io/rhosdt/tempo-rhel8@sha256:e4295f837066efb05bcc5897f31eb2bdbd81684a8c59d6f9498dd3590c62c12a - - name: registry.redhat.io/rhosdt/tempo-gateway-rhel8@sha256:b62f5cedfeb5907b638f14ca6aaeea50f41642980a8a6f87b7061e88d90fac23 - - name: registry.redhat.io/rhosdt/tempo-gateway-opa-rhel8@sha256:8cd134deca47d6817b26566e272e6c3f75367653d589f5c90855c59b2fab01e9 - - name: registry.redhat.io/rhosdt/tempo-query-rhel8@sha256:0da43034f440b8258a48a0697ba643b5643d48b615cdb882ac7f4f1f80aad08e ----- - -[id="distr-tracing_2-8_{context}"] -== Release notes for {DTProductName} 2.8 - -[id="distr-tracing_2-8_component-versions_{context}"] -=== Component versions in the {DTProductName} 2.8 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.42 - -|{TempoName} -|Tempo -|0.1.0 -|=== - -[id="distr-tracing_2-8_technology-preview-features_{context}"] -=== Technology Preview features - -This release introduces support for the {TempoName} as a link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] feature for {DTProductName}. - -:FeatureName: The {TempoName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -The feature uses version 0.1.0 of the {TempoName} and version 2.0.1 of the upstream {TempoShortName} components. - -You can use the {TempoShortName} to replace Jaeger so that you can use S3-compatible storage instead of ElasticSearch. -Most users who use the {TempoShortName} instead of Jaeger will not notice any difference in functionality because the {TempoShortName} supports the same ingestion and query protocols as Jaeger and uses the same user interface. - -If you enable this Technology Preview feature, note the following limitations of the current implementation: - -* The {TempoShortName} currently does not support disconnected installations. (link:https://issues.redhat.com/browse/TRACING-3145[TRACING-3145]) - -* When you use the Jaeger user interface (UI) with the {TempoShortName}, the Jaeger UI lists only services that have sent traces within the last 15 minutes. For services that have not sent traces within the last 15 minutes, those traces are still stored even though they are not visible in the Jaeger UI. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139]) - -Expanded support for the {TempoOperator} is planned for future releases of the {DTProductName}. -Possible additional features might include support for TLS authentication, multitenancy, and multiple clusters. -For more information about the {TempoOperator}, see the link:https://tempo-operator.netlify.app[Tempo community documentation]. - -[id="distr-tracing_2-8_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -[id="distr-tracing_2-7_{context}"] -== Release notes for {DTProductName} 2.7 - -[id="distr-tracing_2-7_component-versions_{context}"] -=== Component versions in the {DTProductName} 2.7 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.39 -|=== - -[id="distr-tracing_2-7_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -[id="distr-tracing_2-6_{context}"] -== Release notes for {DTProductName} 2.6 - -[id="distr-tracing_2-6_component-versions_{context}"] -=== Component versions in the {DTProductName} 2.6 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.38 -|=== - -[id="distr-tracing_2-6_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -[id="distr-tracing_2-5_{context}"] -== Release notes for {DTProductName} 2.5 - -[id="distr-tracing_2-5_component-versions_{context}"] -=== Component versions in the {DTProductName} 2.5 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.36 -|=== - -[id="distr-tracing_2-5_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This release introduces support for ingesting OpenTelemetry protocol (OTLP) to the {JaegerName} Operator. -The Operator now automatically enables the OTLP ports: - -* Port 4317 for the OTLP gRPC protocol. -* Port 4318 for the OTLP HTTP protocol. - -This release also adds support for collecting Kubernetes resource attributes to the {OTELName} Operator. - -[id="distr-tracing_2-5_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -[id="distr-tracing_2-4_{context}"] -== Release notes for {DTProductName} 2.4 - -[id="distr-tracing_2-4_component-versions_{context}"] -=== Component versions in the {DTProductName} 2.4 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.34.1 -|=== - -[id="distr-tracing_2-4_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This release adds support for auto-provisioning certificates using the {es-op}. - -Self-provisioning by using the {JaegerName} Operator to call the {es-op} during installation. - -[IMPORTANT] -==== -When upgrading to the {DTProductName} 2.4, the Operator recreates the Elasticsearch instance, which might take five to ten minutes. Distributed tracing will be down and unavailable for that period. -==== - -[id="distr-tracing_2-4_technology-preview-features_{context}"] -=== Technology Preview features - -Creating the Elasticsearch instance and certificates first and then configuring the {JaegerShortName} to use the certificate is a link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] for this release. - -[id="distr-tracing_2-4_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -[id="distr-tracing_2-3_{context}"] -== Release notes for {DTProductName} 2.3 - -[id="distr-tracing_2-3_component-versions_2-3-1_{context}"] -=== Component versions in the {DTProductName} 2.3.1 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.30.2 -|=== - -[id="distr-tracing_2-3_component-versions_2-3-0_{context}"] -=== Component versions in the {DTProductName} 2.3.0 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.30.1 -|=== - -[id="distr-tracing_2-3_new-features-and-enhancements_{context}"] -=== New features and enhancements - -With this release, the {JaegerName} Operator is now installed to the `openshift-distributed-tracing` namespace by default. Before this update, the default installation had been in the `openshift-operators` namespace. - -[id="distr-tracing_2-3_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -[id="distr-tracing_2-2_{context}"] -== Release notes for {DTProductName} 2.2 - -[id="distr-tracing_2-2_technology-preview-features_{context}"] -=== Technology Preview features - -The unsupported OpenTelemetry Collector components included in the 2.1 release are removed. - -[id="distr-tracing_2-2_bug-fixes_{context}"] -=== Bug fixes - -This release of the {DTProductName} addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -[id="distr-tracing_2-1_{context}"] -== Release notes for {DTProductName} 2.1 - -[id="distr-tracing_2-1_component-versions_{context}"] -=== Component versions in the {DTProductName} 2.1 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.29.1 -|=== - -[id="distr-tracing_2-1_technology-preview-features_{context}"] -=== Technology Preview features - -* This release introduces a breaking change to how to configure certificates in the OpenTelemetry custom resource file. With this update, the `ca_file` moves under `tls` in the custom resource, as shown in the following examples. -+ -.CA file configuration for OpenTelemetry version 0.33 -+ -[source,yaml] ----- -spec: - mode: deployment - config: | - exporters: - jaeger: - endpoint: jaeger-production-collector-headless.tracing-system.svc:14250 - ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt" ----- -+ -.CA file configuration for OpenTelemetry version 0.41.1 -+ -[source,yaml] ----- -spec: - mode: deployment - config: | - exporters: - jaeger: - endpoint: jaeger-production-collector-headless.tracing-system.svc:14250 - tls: - ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt" ----- - -[id="distr-tracing_2-1_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -[id="distr-tracing_2-0_{context}"] -== Release notes for {DTProductName} 2.0 - -[id="distr-tracing_2-0_component-versions_{context}"] -=== Component versions in the {DTProductName} 2.0 - -[options="header_{context}"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.28.0 -|=== - -[id="distr-tracing_2-0_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This release introduces the following new features and enhancements: - -* Rebrands Red{nbsp}Hat OpenShift Jaeger as the {DTProductName}. - -* Updates {JaegerName} Operator to Jaeger 1.28. Going forward, the {DTProductName} will only support the `stable` Operator channel. -Channels for individual releases are no longer supported. - -* Adds support for OpenTelemetry protocol (OTLP) to the Query service. - -* Introduces a new distributed tracing icon that appears in the OperatorHub. +include::modules/distr-tracing-tempo-rn-enhancements.adoc[leveloffset=+1] -* Includes rolling updates to the documentation to support the name change and new features. +// None included with this release +// include::modules/distr-tracing-tempo-rn-technology-preview-features.adoc[leveloffset=+1] -[id="distr-tracing_2-0_technology-preview-features_{context}"] -=== Technology Preview features +// None included with this release +// include::modules/distr-tracing-tempo-rn-deprecated-features.adoc[leveloffset=+1] -This release adds the {OTELName} as a link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview], which you install using the {OTELName} Operator. {OTELName} is based on the link:https://opentelemetry.io/[OpenTelemetry] APIs and instrumentation. The {OTELName} includes the OpenTelemetry Operator and Collector. You can use the Collector to receive traces in the OpenTelemetry or Jaeger protocol and send the trace data to the {DTProductName}. Other capabilities of the Collector are not supported at this time. The OpenTelemetry Collector allows developers to instrument their code with vendor agnostic APIs, avoiding vendor lock-in and enabling a growing ecosystem of observability tooling. +// None included with this release +// include::modules/distr-tracing-tempo-rn-removed-features.adoc[leveloffset=+1] -[id="distr-tracing_2-0_bug-fixes_{context}"] -=== Bug fixes +include::modules/distr-tracing-tempo-rn-known-issues.adoc[leveloffset=+1] -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. +include::modules/distr-tracing-tempo-rn-bug-fixes.adoc[leveloffset=+1] include::modules/support.adoc[leveloffset=+1] diff --git a/observability/distr_tracing/distr-tracing-tempo-configuring.adoc b/observability/distr_tracing/distr-tracing-tempo-configuring.adoc index c27c964f1a38..27be9b53902d 100644 --- a/observability/distr_tracing/distr-tracing-tempo-configuring.adoc +++ b/observability/distr_tracing/distr-tracing-tempo-configuring.adoc @@ -33,6 +33,12 @@ include::modules/distr-tracing-tempo-config-query-frontend.adoc[leveloffset=+1] .Additional resources * xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations] +include::modules/distr-tracing-tempo-coo-ui-plugin.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources +* xref:../../observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc#distributed-tracing-ui-plugin[Distributed tracing UI plugin] + include::modules/distr-tracing-tempo-config-spanmetrics.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/observability/otel/otel-architecture.adoc b/observability/otel/otel-architecture.adoc new file mode 100644 index 000000000000..09ed4cc7e1ff --- /dev/null +++ b/observability/otel/otel-architecture.adoc @@ -0,0 +1,9 @@ +:_mod-docs-content-type: ASSEMBLY +include::_attributes/common-attributes.adoc[] +[id="otel-architecture"] += About {OTELName} +:context: otel-architecture + +toc::[] + +include::modules/otel-about.adoc[leveloffset=+1] diff --git a/observability/otel/otel-collector/otel-collector-configuration-intro.adoc b/observability/otel/otel-collector/otel-collector-configuration-intro.adoc index ee280a5ff4a9..718fd0111864 100644 --- a/observability/otel/otel-collector/otel-collector-configuration-intro.adoc +++ b/observability/otel/otel-collector/otel-collector-configuration-intro.adoc @@ -8,6 +8,8 @@ toc::[] The {OTELName} Operator uses a custom resource definition (CRD) file that defines the architecture and configuration settings to be used when creating and deploying the {OTELShortName} resources. You can install the default configuration or modify the file. +include::modules/otel-collector-deployment-modes.adoc[leveloffset=+1] + include::modules/otel-collector-config-options.adoc[leveloffset=+1] include::modules/otel-creating-required-RBAC-resources-automatically.adoc[leveloffset=+1] diff --git a/observability/otel/otel-collector/otel-collector-processors.adoc b/observability/otel/otel-collector/otel-collector-processors.adoc index e433dae779cb..fd6fd3d86a35 100644 --- a/observability/otel/otel-collector/otel-collector-processors.adoc +++ b/observability/otel/otel-collector/otel-collector-processors.adoc @@ -18,7 +18,6 @@ Currently, the following General Availability and Technology Preview processors - xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#span-processor_otel-collector-processors[Span Processor] - xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#kubernetes-attributes-processor_otel-collector-processors[Kubernetes Attributes Processor] - xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#filter-processor_otel-collector-processors[Filter Processor] -- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#routing-processor_otel-collector-processors[Routing Processor] - xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#cumulativetodelta-processor_otel-collector-processors[Cumulative-to-Delta Processor] - xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#groupbyattrsprocessor-processor_otel-collector-processors[Group-by-Attributes Processor] - xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#transform-processor_otel-collector-processors[Transform Processor] @@ -372,40 +371,6 @@ include::snippets/technology-preview.adoc[] <2> Filters the spans that have the `container.name == app_container_1` attribute. <3> Filters the spans that have the `host.name == localhost` resource attribute. -[id="routing-processor_{context}"] -== Routing Processor - -The Routing Processor routes logs, metrics, or traces to specific exporters. This processor can read a header from an incoming gRPC or plain HTTP request or read a resource attribute, and then direct the trace information to relevant exporters according to the read value. - -:FeatureName: The Routing Processor -include::snippets/technology-preview.adoc[] - -.OpenTelemetry Collector custom resource with an enabled OTLP Exporter -[source,yaml] ----- -# ... - config: - processors: - routing: - from_attribute: X-Tenant # <1> - default_exporters: # <2> - - jaeger - table: # <3> - - value: acme - exporters: [jaeger/acme] - exporters: - jaeger: - endpoint: localhost:14250 - jaeger/acme: - endpoint: localhost:24250 -# ... ----- -<1> The HTTP header name for the lookup value when performing the route. -<2> The default exporter when the attribute value is not present in the table in the next section. -<3> The table that defines which values are to be routed to which exporters. - -Optionally, you can create an `attribute_source` configuration, which defines where to look for the attribute that you specify in the `from_attribute` field. The supported values are `context` for searching the context including the HTTP headers, and `resource` for searching the resource attributes. - [id="cumulativetodelta-processor_{context}"] == Cumulative-to-Delta Processor @@ -924,6 +889,8 @@ You can choose and combine policies from the following list: * link:https://opentelemetry.io/blog/2022/tail-sampling/[Tail Sampling with OpenTelemetry: Why it’s useful, how to do it, and what to consider] (OpenTelemetry Blog) * link:https://opentelemetry.io/docs/collector/deployment/gateway/[Gateway] (OpenTelemetry Documentation) +include::modules/otel-processors-probabilistic-sampling-processor.adoc[leveloffset=+1] + [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources diff --git a/observability/otel/otel-collector/otel-collector-receivers.adoc b/observability/otel/otel-collector/otel-collector-receivers.adoc index 039e99004fda..def2528cf108 100644 --- a/observability/otel/otel-collector/otel-collector-receivers.adoc +++ b/observability/otel/otel-collector/otel-collector-receivers.adoc @@ -593,6 +593,11 @@ subjects: The OpenCensus Receiver provides backwards compatibility with the OpenCensus project for easier migration of instrumented codebases. It receives metrics and traces in the OpenCensus format via gRPC or HTTP and Json. +[WARNING] +==== +The OpenCensus Receiver is deprecated and might be removed in a future major release. +==== + .OpenTelemetry Collector custom resource with the enabled OpenCensus Receiver [source,yaml] ---- diff --git a/observability/otel/otel-forwarding-telemetry-data.adoc b/observability/otel/otel-forwarding-telemetry-data.adoc index 938baee81a51..47128f1f2617 100644 --- a/observability/otel/otel-forwarding-telemetry-data.adoc +++ b/observability/otel/otel-forwarding-telemetry-data.adoc @@ -11,3 +11,10 @@ You can use the OpenTelemetry Collector to forward your telemetry data. include::modules/otel-forwarding-traces.adoc[leveloffset=+1] include::modules/otel-forwarding-logs-to-tempostack.adoc[leveloffset=+1] + +include::modules/otel-forwarding-data-to-third-party-systems.adoc[leveloffset=+1] + +[role="_additional-resources"] +[id="additional-resources_{context}"] +== Additional resources +* link:https://opentelemetry.io/docs/specs/otlp/[OpenTelemetry Protocol (OTLP)] diff --git a/observability/otel/otel-rn.adoc b/observability/otel/otel-rn.adoc index 81cabf36e832..987ebd26a3f8 100644 --- a/observability/otel/otel-rn.adoc +++ b/observability/otel/otel-rn.adoc @@ -1,1036 +1,27 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="otel_rn"] -= Release notes for the {OTELName} += Release notes for the {OTELName} 3.7 :context: otel-rn toc::[] -include::modules/otel-product-overview.adoc[leveloffset=+1] - -You can use the {OTELName} xref:../../observability/otel/otel-forwarding-telemetry-data.adoc#otel-forwarding-telemetry-data[in combination with] the xref:../../observability/distr_tracing/distr-tracing-rn.adoc#distr-tracing-rn[{TempoName}]. +include::modules/otel-about-rn.adoc[leveloffset=+1] include::snippets/distr-tracing-and-otel-disclaimer-about-docs-for-supported-features-only.adoc[] -[id="otel_3-6-1_{context}"] -== Release notes for {OTELName} 3.6.1 - -The {OTELName} 3.6.1 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/opentelemetry-operator-bundle/615618406feffc5384e84400/history[{OTELOperator} 0.127.0]. - -[NOTE] -==== -The {OTELName} 3.6.1 is based on the open source link:https://opentelemetry.io/docs/collector/[OpenTelemetry] release 0.127.0. -==== - -[id="otel_3-6-1_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-2025-4673[CVE-2025-4673] -* link:https://access.redhat.com/security/cve/CVE-2025-6020[CVE-2025-6020] - -[id="otel_3-6-1_known-issues_{context}"] -=== Known issues - -There is currently a known issue with the following exporters: - -* AWS CloudWatch Logs Exporter -* AWS EMF Exporter -* AWS X-Ray Exporter - -This known issue affects deployments that use the optional `endpoint` field of the exporter configuration in the `OpenTelemetryCollector` custom resource. Not specifying the protocol, such as `https://`, as part of the endpoint value results in the `unsupported protocol scheme` error. - -Workaround: Include the protocol, such as `https://`, as part of the endpoint value. - -[id="otel_3-6_{context}"] -== Release notes for {OTELName} 3.6 - -The {OTELName} 3.6 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/opentelemetry-operator-bundle/615618406feffc5384e84400/history[{OTELOperator} 0.127.0]. - -[NOTE] -==== -The {OTELName} 3.6 is based on the open source link:https://opentelemetry.io/docs/collector/[OpenTelemetry] release 0.127.0. -==== - -[id="otel_3-6_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* https://access.redhat.com/security/cve/CVE-2025-22868[CVE-2025-22868] -* https://access.redhat.com/security/cve/CVE-2025-22871[CVE-2025-22871] - -[id="otel_3-6_technology-preview-features_{context}"] -=== Technology Preview features - -This update introduces the following Technology Preview features: - -* Tail Sampling Processor - -* Cumulative-to-Delta Processor - -:FeatureName: Each of these features -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="otel_3-6_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This update introduces the following enhancements: - -* The following link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] features reach General Availability: - -** Kafka Exporter - -** Attributes Processor - -** Resource Processor - -** Prometheus Receiver - -* With this update, the OpenTelemetry Collector can read TLS certificates in the `tss2` format according to the TPM Software Stack specification (TSS) 2.0 of the Trusted Platform Module (TPM) 2.0 Library by the Trusted Computing Group (TCG). - -* With this update, the {OTELOperator} automatically upgrades all `OpenTelemetryCollector` custom resources during its startup. The Operator reconciles all managed instances during its startup. If there is an error, the Operator retries the upgrade at exponential backoff. If an upgrade fails, the Operator will retry the upgrade again when it restarts. - -//// -[id="otel_3-6_deprecated-functionality_{context}"] -=== Deprecated functionality - -In the {OTELName} 3.6, ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????]) -//// - - -[id="otel_3-6_removal-notice_{context}"] -=== Removal notice - -In the {OTELName} 3.6, the Loki Exporter, which is a temporary Technology Preview feature, is removed. If you currently use the Loki Exporter for Loki 3.0 or later, replace the Loki Exporter with the OTLP HTTP Exporter. - -:FeatureName: The Loki Exporter -include::snippets/technology-preview.adoc[leveloffset=+1] - -// In the {OTELName} 3.6, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. - -//// -[id="otel_3-6_bug-fixes_{context}"] -=== Bug fixes - -This update introduces the following bug fix: - -* ??? (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????]) -//// - -[id="otel_3-6_known-issues_{context}"] -=== Known issues - -There is currently a known issue with the following exporters: - -* AWS CloudWatch Logs Exporter -* AWS EMF Exporter -* AWS X-Ray Exporter - -This known issue affects deployments that use the optional `endpoint` field of the exporter configuration in the `OpenTelemetryCollector` custom resource. Not specifying the protocol, such as `https://`, as part of the endpoint value results in the `unsupported protocol scheme` error. - -Workaround: Include the protocol, such as `https://`, as part of the endpoint value. - -[id="otel_3-5-1_{context}"] -== Release notes for {OTELName} 3.5.1 - -The {OTELName} 3.5.1 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/opentelemetry-operator-bundle/615618406feffc5384e84400/history[{OTELOperator} 0.119.0]. - -[NOTE] -==== -The {OTELName} 3.5.1 is based on the open source link:https://opentelemetry.io/docs/collector/[OpenTelemetry] release 0.119.0. -==== - -[id="distr-tracing_3-5-1_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-2025-22868[CVE-2025-22868] -* link:https://access.redhat.com/security/cve/CVE-2025-27144[CVE-2025-27144] -* link:https://access.redhat.com/security/cve/CVE-2025-29786[CVE-2025-29786] -* link:https://access.redhat.com/security/cve/CVE-2025-30204[CVE-2025-30204] - -[id="otel_3-5_{context}"] -== Release notes for {OTELName} 3.5 - -The {OTELName} 3.5 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/opentelemetry-operator-bundle/615618406feffc5384e84400/history[{OTELOperator} 0.119.0]. - -[NOTE] -==== -The {OTELName} 3.5 is based on the open source link:https://opentelemetry.io/docs/collector/[OpenTelemetry] release 0.119.0. -==== - -[id="otel_3-5_technology-preview-features_{context}"] -=== Technology Preview features - -This update introduces the following Technology Preview features: - -* AWS CloudWatch Exporter -* AWS EMF Exporter -* AWS X-Ray Exporter - -:FeatureName: Each of these features -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="otel_3-5_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This update introduces the following enhancements: - -* The following link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] features reach General Availability: -** Host Metrics Receiver -** Kubelet Stats Receiver -* With this update, the OpenTelemetry Collector uses the OTLP HTTP Exporter to push logs to a LokiStack instance. -* With this update, the Operator automatically creates RBAC rules for the Kubernetes Events Receiver (`k8sevents`), Kubernetes Cluster Receiver (`k8scluster`), and Kubernetes Objects Receiver (`k8sobjects`) if the Operator has sufficient permissions. For more information, see "Creating the required RBAC resources automatically" in _Configuring the Collector_. - -[id="otel_3-5_deprecated-functionality_{context}"] -=== Deprecated functionality - -In the {OTELName} 3.5, the Loki Exporter, which is a temporary Technology Preview feature, is deprecated. The Loki Exporter is planned to be removed in the {OTELName} 3.6. If you currently use the Loki Exporter for the OpenShift Logging 6.1 or later, replace the Loki Exporter with the OTLP HTTP Exporter. - -:FeatureName: The Loki Exporter -include::snippets/technology-preview.adoc[leveloffset=+1] - -//// -In the {OTELName} 3.5, ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????]) -//// - -//// -[id="otel_3-5_removal-notice_{context}"] -=== Removal notice - -In the {OTELName} 3.5, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -[id="otel_3-5_bug-fixes_{context}"] -=== Bug fixes - -This update introduces the following bug fix: - -* Before this update, manually created routes for the Collector services were unintentionally removed when the Operator pod was restarted. With this update, restarting the Operator pod does not result in the removal of the manually created routes. - -//// -[id="otel_3-5_known-issues_{context}"] -=== Known issues - -There are currently known issues: - -* ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????]) -//// - -[id="otel_3-4_{context}"] -== Release notes for {OTELName} 3.4 - -The {OTELName} 3.4 is provided through the link:https://catalog.redhat.com/software/containers/rhosdt/opentelemetry-operator-bundle/615618406feffc5384e84400/history[{OTELOperator} 0.113.0]. - -The {OTELName} 3.4 is based on the open source link:https://opentelemetry.io/docs/collector/[OpenTelemetry] release 0.113.0. - -[id="otel_3-4_technology-preview-features_{context}"] -=== Technology Preview features - -This update introduces the following Technology Preview features: - -* OpenTelemetry Protocol (OTLP) JSON File Receiver -* Count Connector - -:FeatureName: Each of these features -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="otel_3-4_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This update introduces the following enhancements: - -* The following link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] features reach General Availability: -** BearerTokenAuth Extension -** Kubernetes Attributes Processor -** Spanmetrics Connector -* You can use the `instrumentation.opentelemetry.io/inject-sdk` annotation with the `Instrumentation` custom resource to enable injection of the OpenTelemetry SDK environment variables into multi-container pods. - -[id="otel_3-4_removal-notice_{context}"] -=== Removal notice - -- In the {OTELName} 3.4, the Logging Exporter has been removed from the Collector. As an alternative, you must use the Debug Exporter instead. -+ -[WARNING] -==== -If you have the Logging Exporter configured, upgrading to the {OTELName} 3.4 will cause crash loops. To avoid such issues, you must configure the {OTELName} to use the Debug Exporter instead of the Logging Exporter before upgrading to the {OTELName} 3.4. -==== - -- In the {OTELName} 3.4, the link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] Memory Ballast Extension has been removed. As an alternative, you can use the `GOMEMLIMIT` environment variable instead. - -[id="otel_3-3-1_{context}"] -== Release notes for {OTELName} 3.3.1 - -The {OTELName} is provided through the {OTELOperator}. - -The {OTELName} 3.3.1 is based on the open source link:https://opentelemetry.io/docs/collector/[OpenTelemetry] release 0.107.0. - -//// -[id="otel_3-3-1_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-2024-????[CVE-2024-????] -//// - -//// -[id="otel_3-3-1_technology-preview-features_{context}"] -=== Technology Preview features - -This update introduces the following Technology Preview features: - -* ???. - -:FeatureName: Each of these features -include::snippets/technology-preview.adoc[leveloffset=+1] -//// - -//// -[id="otel_3-3-1_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This update introduces the following enhancements: - -* ???. -//// - -//// -[id="otel_3-3-1_deprecated-functionality_{context}"] -=== Deprecated functionality - -In the {OTELName} 3.3.1, ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????]) -//// - -//// -[id="otel_3-3-1_removal-notice_{context}"] -=== Removal notice - -In the {OTELName} 3.3.1, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -[id="otel_3-3-1_bug-fixes_{context}"] -=== Bug fixes - -This update introduces the following bug fix: - -* Before this update, injection of the NGINX auto-instrumentation failed when copying the instrumentation libraries into the application container. With this update, the copy command is configured correctly, which fixes the issue. (link:https://issues.redhat.com/browse/TRACING-4673[TRACING-4673]) - -//// -[id="otel_3-3-1_known-issues_{context}"] -=== Known issues - -There are currently known issues: - -* ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????]) -//// - -[id="otel_3-3_{context}"] -== Release notes for {OTELName} 3.3 - -The {OTELName} is provided through the {OTELOperator}. - -The {OTELName} 3.3 is based on the open source link:https://opentelemetry.io/docs/collector/[OpenTelemetry] release 0.107.0. - -[id="otel_3-3_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-2024-6104[CVE-2024-6104] -* link:https://access.redhat.com/security/cve/CVE-2024-42368[CVE-2024-42368] - -[id="otel_3-3_technology-preview-features_{context}"] -=== Technology Preview features - -This update introduces the following Technology Preview features: - -* Group-by-Attributes Processor -* Transform Processor -* Routing Connector -* Prometheus Remote Write Exporter -* Exporting logs to the LokiStack log store - -:FeatureName: Each of these features -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="otel_3-3_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This update introduces the following enhancements: - -* Collector dashboard for the internal Collector metrics and analyzing Collector health and performance. (link:https://issues.redhat.com/browse/TRACING-3768[TRACING-3768]) -* Support for automatically reloading certificates in both the OpenTelemetry Collector and instrumentation. (link:https://issues.redhat.com/browse/TRACING-4186[TRACING-4186]) - -//// -[id="otel_3-3_deprecated-functionality_{context}"] -=== Deprecated functionality - -In the {OTELName} 3.3, ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????]) -//// - -//// -[id="otel_3-3_removal-notice_{context}"] -=== Removal notice - -In the {OTELName} 3.3, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -[id="otel_3-3_bug-fixes_{context}"] -=== Bug fixes - -This update introduces the following bug fixes: - -* Before this update, the `ServiceMonitor` object was failing to scrape operator metrics due to missing permissions for accessing the metrics endpoint. With this update, this issue is fixed by creating the `ServiceMonitor` custom resource when operator monitoring is enabled. (link:https://issues.redhat.com/browse/TRACING-4288[TRACING-4288]) -* Before this update, the Collector service and the headless service were both monitoring the same endpoints, which caused duplication of metrics collection and `ServiceMonitor` objects. With this update, this issue is fixed by not creating the headless service. (link:https://issues.redhat.com/browse/OBSDA-773[OBSDA-773]) - -//// -[id="otel_3-3_known-issues_{context}"] -=== Known issues - -There are currently known issues: - -* ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????]) -//// - -[id="otel_3-2-2_{context}"] -== Release notes for {OTELName} 3.2.2 - -The {OTELName} is provided through the {OTELOperator}. - -[id="otel_3-2-2_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-2023-2953/[CVE-2023-2953] -* link:https://access.redhat.com/security/cve/CVE-2024-28182[CVE-2024-28182] - -//// -[id="otel_3-2-2_technology-preview-features_{context}"] -=== Technology Preview features - -This update introduces the following Technology Preview features: - -* - -:FeatureName: Each of these features -include::snippets/technology-preview.adoc[leveloffset=+1] -//// - -//// -[id="otel_3-2-2_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This update introduces the following enhancement: - -* {OTELName} 3.2.2 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.102.1. -//// - -//// -[id="otel_3-2-2_deprecated-functionality_{context}"] -=== Deprecated functionality - -In the {OTELName} 3.2.2, ... -//// - -//// -[id="otel_3-2-2_removal-notice_{context}"] -=== Removal notice - -In the {OTELName} 3.2.2, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -[id="otel_3-2-2_bug-fixes_{context}"] -=== Bug fixes - -This update introduces the following bug fix: - -* Before this update, secrets were perpetually generated on {product-title} 4.16 because the operator tried to reconcile a new `openshift.io/internal-registry-pull-secret-ref` annotation for service accounts, causing a loop. With this update, the operator ignores this new annotation. (link:https://issues.redhat.com/browse/TRACING-4435/[TRACING-4435]) - -//// -[id="otel_3-2-2_known-issues_{context}"] -=== Known issues - -There are currently known issues: - -* ??? -//// - -[id="otel_rn-3-2-1_{context}"] -== Release notes for {OTELName} 3.2.1 - -The {OTELName} is provided through the {OTELOperator}. - -[id="otel_3-2-1_cves_{context}"] -=== CVEs - -This release fixes the following CVEs: - -* link:https://access.redhat.com/security/cve/CVE-2024-25062/[CVE-2024-25062] -* link:https://opentelemetry.io/blog/2024/cve-2024-36129/[Upstream CVE-2024-36129] - -//// -[id="otel_3-2-1_technology-preview-features_{context}"] -=== Technology Preview features - -This update introduces the following Technology Preview features: - -* - -:FeatureName: Each of these features -include::snippets/technology-preview.adoc[leveloffset=+1] -//// - -[id="otel_3-2-1_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This update introduces the following enhancement: - -* {OTELName} 3.2.1 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.102.1. - -//// -[id="otel_3-2-1_deprecated-functionality_{context}"] -=== Deprecated functionality - -In the {OTELName} 3.2.1, ... -//// - -//// -[id="otel_3-2-1_removal-notice_{context}"] -=== Removal notice - -In the {OTELName} 3.2.1, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -//// -[id="otel_3-2-1_bug-fixes_{context}"] -=== Bug fixes - -This update introduces the following bug fix: - -* Before this update, the checkbox to enable Operator monitoring was not available in the web console when installing the {OTELOperator}. As a result, a *ServiceMonitor* resource was not created in the `openshift-opentelemetry-operator` namespace. With this update, the checkbox appears for the {OTELOperator} in the web console so that Operator monitoring can be enabled during installation. (link:https://issues.redhat.com/browse/TRACING-3761[TRACING-3761]) -//// - -//// -[id="otel_3-2-1_known-issues_{context}"] -=== Known issues - -There are currently known issues: - -* ??? -//// - -[id="otel_rn-3-2_{context}"] -== Release notes for {OTELName} 3.2 - -The {OTELName} is provided through the {OTELOperator}. - -//// -[id="otel_3-2_cves_{context}"] -=== CVEs - -This release fixes link:https://access.redhat.com/security/cve/cve-202?-?????[CVE-202?-?????]. -//// - -[id="otel_3-2_technology-preview-features_{context}"] -=== Technology Preview features - -This update introduces the following Technology Preview features: - -* Host Metrics Receiver -* OIDC Auth Extension -* Kubernetes Cluster Receiver -* Kubernetes Events Receiver -* Kubernetes Objects Receiver -* Load-Balancing Exporter -* Kubelet Stats Receiver -* Cumulative to Delta Processor -* Forward Connector -* Journald Receiver -* Filelog Receiver -* File Storage Extension - -:FeatureName: Each of these features -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="otel_3-2_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This update introduces the following enhancement: - -* {OTELName} 3.2 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.100.0. - -[id="otel_3-2_deprecated-functionality_{context}"] -=== Deprecated functionality - -In {OTELName} 3.2, use of empty values and `null` keywords in the OpenTelemetry Collector custom resource is deprecated and planned to be unsupported in a future release. Red Hat will provide bug fixes and support for this syntax during the current release lifecycle, but this syntax will become unsupported. As an alternative to empty values and `null` keywords, you can update the OpenTelemetry Collector custom resource to contain empty JSON objects as open-closed braces `{}` instead. - -//// -[id="otel_3-2_removal-notice_{context}"] -=== Removal notice - -In the {OTELName} 3.2, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead. -//// - -[id="otel_3-2_bug-fixes_{context}"] -=== Bug fixes - -This update introduces the following bug fix: - -* Before this update, the checkbox to enable Operator monitoring was not available in the web console when installing the {OTELOperator}. As a result, a *ServiceMonitor* resource was not created in the `openshift-opentelemetry-operator` namespace. With this update, the checkbox appears for the {OTELOperator} in the web console so that Operator monitoring can be enabled during installation. (link:https://issues.redhat.com/browse/TRACING-3761[TRACING-3761]) - -//// -[id="otel_3-2_known-issues_{context}"] -=== Known issues - -There are currently known issues: - -* ??? -//// - -[id="otel_rn-3-1-1_{context}"] -== Release notes for {OTELName} 3.1.1 - -The {OTELName} is provided through the {OTELOperator}. - -[id="otel_3-1-1_cves_{context}"] -=== CVEs - -This release fixes link:https://access.redhat.com/security/cve/cve-2023-39326[CVE-2023-39326]. - -[id="otel_rn-3-1_{context}"] -== Release notes for {OTELName} 3.1 - -The {OTELName} is provided through the {OTELOperator}. - -[id="otel_3-1_technology-preview-features_{context}"] -=== Technology Preview features - -This update introduces the following Technology Preview feature: - -* The target allocator is an optional component of the OpenTelemetry Operator that shards Prometheus receiver scrape targets across the deployed fleet of OpenTelemetry Collector instances. The target allocator provides integration with the Prometheus `PodMonitor` and `ServiceMonitor` custom resources. - -//// -* Support for the target allocator in the OpenTelemetry Collector. The target allocator is an optional component of the OpenTelemetry Operator that shards Prometheus receiver scrape targets across the deployed fleet of OpenTelemetry Collector instances. The target allocator provides integration with the Prometheus `PodMonitor` and `ServiceMonitor` custom resources. -//// - -:FeatureName: The target allocator -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="otel_3-1_new-features-and-enhancements_{context}"] -=== New features and enhancements - -//plural: `enhancements:` -This update introduces the following enhancement: - -* {OTELName} 3.1 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.93.0. - -//// -[id="otel_3-1_removal-notice_{context}"] -==== Removal notice -* -//// - -//// -[id="otel_3-1_bug-fixes_{context}"] -==== Bug fixes -This update introduces the following bug fixes: -* Fixed support for ... -//// - -//// -[id="otel_3-1_known-issues_{context}"] -==== Known issues -//There is currently a known issue: -//There are currently known issues: -//// - -[id="otel_3-0_{context}"] -== Release notes for {OTELName} 3.0 - -[id="otel_3-0_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This update introduces the following enhancements: - -* {OTELName} 3.0 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.89.0. -* The *OpenShift distributed tracing data collection Operator* is renamed as the *{OTELOperator}*. -* Support for the ARM architecture. -* Support for the Prometheus receiver for metrics collection. -* Support for the Kafka receiver and exporter for sending traces and metrics to Kafka. -* Support for cluster-wide proxy environments. -* The {OTELOperator} creates the Prometheus `ServiceMonitor` custom resource if the Prometheus exporter is enabled. -* The Operator enables the `Instrumentation` custom resource that allows injecting upstream OpenTelemetry auto-instrumentation libraries. - -[id="otel_3-0_removal-notice_{context}"] -=== Removal notice - -In {OTELName} 3.0, the Jaeger exporter has been removed. Bug fixes and support are provided only through the end of the 2.9 lifecycle. As an alternative to the Jaeger exporter for sending data to the Jaeger collector, you can use the OTLP exporter instead. - -[id="otel_3-0_bug-fixes_{context}"] -=== Bug fixes - -This update introduces the following bug fixes: - -* Fixed support for disconnected environments when using the `oc adm catalog mirror` CLI command. - -[id="otel_3-0_known-issues_{context}"] -=== Known issues - -There is currently a known issue: -//There are currently known issues: - -* Currently, the cluster monitoring of the {OTELOperator} is disabled due to a bug (link:https://issues.redhat.com/browse/TRACING-3761[TRACING-3761]). The bug is preventing the cluster monitoring from scraping metrics from the {OTELOperator} due to a missing label `openshift.io/cluster-monitoring=true` that is required for the cluster monitoring and service monitor object. -+ -.Workaround -+ -You can enable the cluster monitoring as follows: -+ -. Add the following label in the Operator namespace: `oc label namespace openshift-opentelemetry-operator openshift.io/cluster-monitoring=true` -+ -. Create a service monitor, role, and role binding: -+ -[source,yaml] ----- -apiVersion: monitoring.coreos.com/v1 -kind: ServiceMonitor -metadata: - name: opentelemetry-operator-controller-manager-metrics-service - namespace: openshift-opentelemetry-operator -spec: - endpoints: - - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token - path: /metrics - port: https - scheme: https - tlsConfig: - insecureSkipVerify: true - selector: - matchLabels: - app.kubernetes.io/name: opentelemetry-operator - control-plane: controller-manager ---- -apiVersion: rbac.authorization.k8s.io/v1 -kind: Role -metadata: - name: otel-operator-prometheus - namespace: openshift-opentelemetry-operator - annotations: - include.release.openshift.io/self-managed-high-availability: "true" - include.release.openshift.io/single-node-developer: "true" -rules: -- apiGroups: - - "" - resources: - - services - - endpoints - - pods - verbs: - - get - - list - - watch ---- -apiVersion: rbac.authorization.k8s.io/v1 -kind: RoleBinding -metadata: - name: otel-operator-prometheus - namespace: openshift-opentelemetry-operator - annotations: - include.release.openshift.io/self-managed-high-availability: "true" - include.release.openshift.io/single-node-developer: "true" -roleRef: - apiGroup: rbac.authorization.k8s.io - kind: Role - name: otel-operator-prometheus -subjects: -- kind: ServiceAccount - name: prometheus-k8s - namespace: openshift-monitoring ----- - -[id="otel_2-9-2_{context}"] -== Release notes for {OTELName} 2.9.2 - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -{OTELName} 2.9.2 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.81.0. - -[id="otel_2-9-2_cves_{context}"] -=== CVEs - -* This release fixes link:https://bugzilla.redhat.com/show_bug.cgi?id=2246470[CVE-2023-46234]. - -[id="otel_2-9-2_known-issues_{context}"] -=== Known issues - -There is currently a known issue: -//There are currently known issues: - -* Currently, you must manually set link:https://operatorframework.io/operator-capabilities/[Operator maturity] to Level IV, Deep Insights. (link:https://issues.redhat.com/browse/TRACING-3431[TRACING-3431]) - -[id="otel_2-9-1_{context}"] -== Release notes for {OTELName} 2.9.1 - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -{OTELName} 2.9.1 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.81.0. - -[id="otel_2-9-1_cves_{context}"] -=== CVEs - -* This release fixes link:https://access.redhat.com/security/cve/cve-2023-44487[CVE-2023-44487]. - -[id="otel_2-9-1_known-issues_{context}"] -=== Known issues - -There is currently a known issue: -//There are currently known issues: - -* Currently, you must manually set link:https://operatorframework.io/operator-capabilities/[Operator maturity] to Level IV, Deep Insights. (link:https://issues.redhat.com/browse/TRACING-3431[TRACING-3431]) - -[id="otel_2-9_{context}"] -== Release notes for {OTELName} 2.9 - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -{OTELName} 2.9 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.81.0. - -[id="otel_2-9_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This release introduces the following enhancements for the {OTELShortName}: - -* Support OTLP metrics ingestion. The metrics can be forwarded and stored in the `user-workload-monitoring` via the Prometheus exporter. - -* Support the link:https://operatorframework.io/operator-capabilities/[Operator maturity] Level IV, Deep Insights, which enables upgrading and monitoring of `OpenTelemetry Collector` instances and the {OTELOperator}. - -* Report traces and metrics from remote clusters using OTLP or HTTP and HTTPS. - -* Collect {product-title} resource attributes via the `resourcedetection` processor. - -* Support the `managed` and `unmanaged` states in the `OpenTelemetryCollector` custom resouce. - -//// -[id="otel_2-9_technology-preview-features_{context}"] -==== Technology Preview features -None. -//// - -//// -[id="otel_2-9_bug-fixes_{context}"] -==== Bug fixes -None. -//// - -[id="otel_2-9_known-issues_{context}"] -=== Known issues - -There is currently a known issue: -//There are currently known issues: - -* Currently, you must manually set link:https://operatorframework.io/operator-capabilities/[Operator maturity] to Level IV, Deep Insights. (link:https://issues.redhat.com/browse/TRACING-3431[TRACING-3431]) - -[id="otel_2-8_{context}"] -== Release notes for {OTELName} 2.8 - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -{OTELName} 2.8 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.74.0. - -[id="otel_2-8_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -//// -[id="otel_2-8_known-issues_{context}"] -== Known issues -None. -//// - -[id="otel_2-7_{context}"] -== Release notes for {OTELName} 2.7 - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -{OTELName} 2.7 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.63.1. - -[id="otel_2-7_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -[id="otel_2-6_{context}"] -== Release notes for {OTELName} 2.6 - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -{OTELName} 2.6 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.60. - -[id="otel_2-6_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -[id="otel_2-5_{context}"] -== Release notes for {OTELName} 2.5 - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -{OTELName} 2.5 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.56. - -[id="otel_2-5_new-features-and-enhancements_{context}"] -=== New features and enhancements - -This update introduces the following enhancement: - -* Support for collecting Kubernetes resource attributes to the {OTELName} Operator. - -[id="otel_2-5_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -[id="otel_2-4_{context}"] -== Release notes for {OTELName} 2.4 - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -{OTELName} 2.4 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.49. - -[id="otel_2-4_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -//// -[id="otel_2-4_known-issues_{context}"] -=== Known issues -None. -//// - -[id="otel_2-3_{context}"] -== Release notes for {OTELName} 2.3 - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -{OTELName} 2.3.1 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.44.1. - -{OTELName} 2.3.0 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.44.0. - -[id="otel_2-3_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -//// -[id="otel_2-3_known-issues_{context}"] -=== Known issues -None. -//// - -[id="otel_2-2_{context}"] -== Release notes for {OTELName} 2.2 - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -{OTELName} 2.2 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.42.0. - -[id="otel_2-2_technology-preview-features_{context}"] -=== Technology Preview features - -The unsupported OpenTelemetry Collector components included in the 2.1 release are removed. - -[id="otel_2-2_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -//// -[id="otel_2-2_known-issues_{context}"] -=== Known issues -None. -//// - -[id="otel_2-1_{context}"] -== Release notes for {OTELName} 2.1 - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -{OTELName} 2.1 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.41.1. - -[id="otel_2-1_technology-preview-features_{context}"] -=== Technology Preview features - -This release introduces a breaking change to how to configure certificates in the OpenTelemetry custom resource file. With this update, the `ca_file` moves under `tls` in the custom resource, as shown in the following examples. - -.CA file configuration for OpenTelemetry version 0.33 - -[source,yaml] ----- -spec: - mode: deployment - config: | - exporters: - jaeger: - endpoint: jaeger-production-collector-headless.tracing-system.svc:14250 - ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt" ----- - -.CA file configuration for OpenTelemetry version 0.41.1 - -[source,yaml] ----- -spec: - mode: deployment - config: | - exporters: - jaeger: - endpoint: jaeger-production-collector-headless.tracing-system.svc:14250 - tls: - ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt" ----- - -[id="otel_2-1_bug-fixes_{context}"] -=== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -//// -[id="otel_2-1_known-issues_{context}"] -=== Known issues -None. -//// +include::modules/otel-rn-enhancements.adoc[leveloffset=+1] -[id="otel_2-0_{context}"] -== Release notes for {OTELName} 2.0 +include::modules/otel-rn-technology-preview-features.adoc[leveloffset=+1] -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] +include::modules/otel-rn-deprecated-features.adoc[leveloffset=+1] -{OTELName} 2.0 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.33.0. +include::modules/otel-rn-removed-features.adoc[leveloffset=+1] -This release adds the {OTELName} as a link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview], which you install using the {OTELName} Operator. {OTELName} is based on the link:https://opentelemetry.io/[OpenTelemetry] APIs and instrumentation. The {OTELName} includes the OpenTelemetry Operator and Collector. You can use the Collector to receive traces in the OpenTelemetry or Jaeger protocol and send the trace data to the {OTELName}. Other capabilities of the Collector are not supported at this time. The OpenTelemetry Collector allows developers to instrument their code with vendor agnostic APIs, avoiding vendor lock-in and enabling a growing ecosystem of observability tooling. +// None included with this release +// include::modules/otel-rn-known-issues.adoc[leveloffset=+1] -//// -[id="otel_2-0_known-issues_{context}"] -=== Known issues -None. -//// +// None included with this release +// include::modules/otel-rn-bug-fixes.adoc[leveloffset=+1] include::modules/support.adoc[leveloffset=+1] diff --git a/observability/otel/otel-troubleshooting.adoc b/observability/otel/otel-troubleshooting.adoc index 8dfe822118c4..eef97f272c68 100644 --- a/observability/otel/otel-troubleshooting.adoc +++ b/observability/otel/otel-troubleshooting.adoc @@ -20,6 +20,8 @@ include::modules/otel-troubleshoot-metrics.adoc[leveloffset=+1] include::modules/otel-troubleshoot-debug-exporter-stdout.adoc[leveloffset=+1] +include::modules/otel-troubleshoot-network-policies.adoc[leveloffset=+1] + include::modules/otel-troubleshoot-network-traffic.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/serverless/observability/tracing/serverless-tracing.adoc b/serverless/observability/tracing/serverless-tracing.adoc index 05a7c0ce62aa..8406a31c5b81 100644 --- a/serverless/observability/tracing/serverless-tracing.adoc +++ b/serverless/observability/tracing/serverless-tracing.adoc @@ -10,7 +10,7 @@ toc::[] Distributed tracing records the path of a request through the various services that make up an application. It is used to tie information about different units of work together, to understand a whole chain of events in a distributed transaction. The units of work might be executed in different processes or hosts. ifdef::openshift-enterprise[] -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] +include::modules/distr-tracing-tempo-key-concepts-in-distributed-tracing.adoc[leveloffset=+1] endif::[] ifdef::openshift-enterprise[] diff --git a/service_mesh/v1x/ossm-architecture.adoc b/service_mesh/v1x/ossm-architecture.adoc index c4e52acb8727..3404c95936c2 100644 --- a/service_mesh/v1x/ossm-architecture.adoc +++ b/service_mesh/v1x/ossm-architecture.adoc @@ -38,7 +38,7 @@ Jaeger records the execution of individual requests across the whole stack of mi A *span* represents a logical unit of work in Jaeger that has an operation name, the start time of the operation, and the duration. Spans may be nested and ordered to model causal relationships. -include::modules/distr-tracing-product-overview.adoc[leveloffset=+2] +include::modules/distr-tracing-tempo-key-concepts-in-distributed-tracing.adoc[leveloffset=+2] include::modules/jaeger-architecture.adoc[leveloffset=+2] diff --git a/service_mesh/v2x/ossm-architecture.adoc b/service_mesh/v2x/ossm-architecture.adoc index e2b13b9c8132..980c5c4e53e3 100644 --- a/service_mesh/v2x/ossm-architecture.adoc +++ b/service_mesh/v2x/ossm-architecture.adoc @@ -37,7 +37,7 @@ The {JaegerShortName} records the execution of individual requests across the wh A *span* represents a logical unit of work that has an operation name, the start time of the operation, and the duration. Spans may be nested and ordered to model causal relationships. -include::modules/distr-tracing-product-overview.adoc[leveloffset=+2] +include::modules/distr-tracing-tempo-key-concepts-in-distributed-tracing.adoc[leveloffset=+2] include::modules/distr-tracing-architecture.adoc[leveloffset=+2] diff --git a/snippets/otel-collector-custom-resource.adoc b/snippets/otel-collector-custom-resource.adoc index 1e165290e6b0..5b2be2300767 100644 --- a/snippets/otel-collector-custom-resource.adoc +++ b/snippets/otel-collector-custom-resource.adoc @@ -14,9 +14,9 @@ metadata: name: otel namespace: # <1> spec: - mode: deployment + mode: # <2> config: - receivers: # <2> + receivers: # <3> otlp: protocols: grpc: @@ -28,13 +28,13 @@ spec: thrift_compact: {} thrift_http: {} zipkin: {} - processors: # <3> + processors: # <4> batch: {} memory_limiter: check_interval: 1s limit_percentage: 50 spike_limit_percentage: 30 - exporters: # <4> + exporters: # <5> debug: {} service: pipelines: @@ -44,6 +44,7 @@ spec: exporters: [debug] ---- <1> The project that you have chosen for the `OpenTelemetryCollector` deployment. Project names beginning with the `openshift-` prefix are not permitted. -<2> For details, see the "Receivers" page. -<3> For details, see the "Processors" page. -<4> For details, see the "Exporters" page. +<2> The deployment mode with the following supported values: the default `deployment`, `daemonset`, `statefulset`, or `sidecar`. For details, see _Deployment Modes_. +<3> For details, see _Receivers_. +<4> For details, see _Processors_. +<5> For details, see _Exporters_.