Merge pull request #83770 from max-cx/OBSDOCS-1414

OBSDOCS-1414: Release notes for Distributed tracing 3.4

Author: lahinson

observability/distr_tracing/distr-tracing-rn.adoc

@@ -8,13 +8,124 @@ toc::[]
 
 include::modules/distr-tracing-product-overview.adoc[leveloffset=+1]
 
-You can use the {TempoName} xref:../otel/otel-forwarding-telemetry-data.adoc#otel-forwarding-telemetry-data[in combination with] the xref:../otel/otel-rn.adoc#otel_rn[{OTELName}].
+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::snippets/distr-tracing-and-otel-disclaimer-about-docs-for-supported-features-only.adoc[]
 
-// git rebase marker 1
+[id="distr-tracing_3-4_{context}"]
+== Release notes for {DTProductName} 3.4
 
-// git rebase marker 2
+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 link:https://access.redhat.com/solutions/7083722[is planned to be removed] from the `redhat-operators` catalog in a future release. You must xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[migrate] to the xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-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-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
@@ -147,8 +258,6 @@ 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[]
 
-// git rebase marker 3
-
 [id="distr-tracing_3-3_{context}"]
 == Release notes for {DTProductName} 3.3
 
@@ -247,12 +356,8 @@ The {JaegerName} 3.3 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
 
 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 {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.3, 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.
+The {JaegerOperator} Operator link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../otel/otel-migrating.adoc#dist-tracing-otel-migrating[migrate] to the xref:distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[{TempoOperator}] and the xref:../otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage.
 
 ////
 [id="distr-tracing_3-3_jaeger-release-notes_removal-notice_{context}"]

observability/otel/otel-collector/otel-collector-connectors.adoc

@@ -99,9 +99,6 @@ service:
 
 The Spanmetrics Connector aggregates Request, Error, and Duration (R.E.D) OpenTelemetry metrics from span data.
 
-:FeatureName: The Spanmetrics Connector
-include::snippets/technology-preview.adoc[]
-
 .OpenTelemetry Collector custom resource with an enabled Spanmetrics Connector
 [source,yaml]
 ----

observability/otel/otel-collector/otel-collector-extensions.adoc

@@ -15,9 +15,6 @@ The BearerTokenAuth Extension is an authenticator for receivers and exporters th
 You can use the OpenTelemetry Collector custom resource to configure client authentication and server authentication for the BearerTokenAuth Extension on the receiver and exporter side.
 This extension supports traces, metrics, and logs.
 
-:FeatureName: The BearerTokenAuth Extension
-include::snippets/technology-preview.adoc[]
-
 .OpenTelemetry Collector custom resource with client and server authentication configured for the BearerTokenAuth Extension
 [source,yaml]
 ----
@@ -384,44 +381,6 @@ include::snippets/technology-preview.adoc[]
 <6> The time interval for checking the number of failures. The default is `5m`.
 <7> The threshold of multiple failures until which a container is still marked as healthy. The default is `5`.
 
-[id="memory-ballast-extension_{context}"]
-== Memory Ballast Extension
-
-The Memory Ballast Extension enables applications to configure memory ballast for the process.
-
-:FeatureName: The Memory Ballast Extension
-include::snippets/technology-preview.adoc[]
-
-.OpenTelemetry Collector custom resource with the configured Memory Ballast Extension
-[source,yaml]
-----
-# ...
-  config: |
-    extensions:
-      memory_ballast:
-        size_mib: 64 # <1>
-        size_in_percentage: 20 # <2>
-
-    receivers:
-      otlp:
-        protocols:
-          http: {}
-
-    exporters:
-      otlp:
-
-    service:
-      extensions: [memory_ballast]
-      pipelines:
-        traces:
-          receivers: [otlp]
-          exporters: [otlp]
-# ...
-----
-<1> Sets the memory ballast size in MiB. Takes priority over the `size_in_percentage` if both are specified.
-<2> Sets the memory ballast as a percentage, `1`-`100`, of the total memory. Supports containerized and physical host environments.
-
-
 [id="zpages-extension_{context}"]
 == zPages Extension
 

observability/otel/otel-collector/otel-collector-processors.adoc

@@ -308,9 +308,6 @@ The Kubernetes Attributes Processor enables automatic configuration of spans, me
 This processor supports traces, metrics, and logs.
 This processor automatically identifies the Kubernetes resources, extracts the metadata from them, and incorporates this extracted metadata as resource attributes into relevant spans, metrics, and logs. It utilizes the Kubernetes API to discover all pods operating within a cluster, maintaining records of their IP addresses, pod UIDs, and other relevant metadata. 
 
-:FeatureName: The Kubernetes Attributes Processor
-include::snippets/technology-preview.adoc[]
-
 .Minimum {product-title} permissions required for the Kubernetes Attributes Processor
 [source,yaml]
 ----

observability/otel/otel-rn.adoc

@@ -8,13 +8,50 @@ toc::[]
 
 include::modules/otel-product-overview.adoc[leveloffset=+1]
 
-You can use the {OTELName} xref:otel-forwarding-telemetry-data.adoc#otel-forwarding-telemetry-data[in combination with] the xref:../distr_tracing/distr-tracing-rn.adoc#distr-tracing-rn[{TempoName}].
+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::snippets/distr-tracing-and-otel-disclaimer-about-docs-for-supported-features-only.adoc[]
 
-// git rebase marker 1
+[id="otel_3-4_{context}"]
+== Release notes for {OTELName} 3.4
 
-// git rebase marker 2
+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
@@ -83,8 +120,6 @@ There are currently known issues:
 * ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????])
 ////
 
-// git rebase marker 3
-
 [id="otel_3-3_{context}"]
 == Release notes for {OTELName} 3.3