Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OBSDOCS-1415: Release notes for the Distributed Tracing 3.3.1 patch #83636

Merged
merged 1 commit into from
Oct 23, 2024
Merged

OBSDOCS-1415: Release notes for the Distributed Tracing 3.3.1 patch #83636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 149 additions & 12 deletions observability/distr_tracing/distr-tracing-rn.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,143 @@ You can use the {TempoName} xref:../otel/otel-forwarding-telemetry-data.adoc#ote

include::snippets/distr-tracing-and-otel-disclaimer-about-docs-for-supported-features-only.adoc[]

// git rebase marker 1

// git rebase marker 2

[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:../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 {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.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-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[]

// git rebase marker 3

[id="distr-tracing_3-3_{context}"]
== Release notes for {DTProductName} 3.3

Expand Down Expand Up @@ -109,12 +246,12 @@ The {JaegerName} 3.3 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
==== 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 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.
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 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.
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.

////
Expand Down Expand Up @@ -235,12 +372,12 @@ Jaeger does not use FIPS validated cryptographic modules.
==== 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 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.
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 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.
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.
////

Expand Down Expand Up @@ -361,12 +498,12 @@ Jaeger does not use FIPS validated cryptographic modules.
==== 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 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.
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 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.
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.
////

Expand Down Expand Up @@ -482,12 +619,12 @@ Jaeger does not use FIPS validated cryptographic modules.
==== 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 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.
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 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.
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.

////
Expand Down Expand Up @@ -560,7 +697,7 @@ Jaeger does not use FIPS validated cryptographic modules.
[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 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, 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.

Expand Down Expand Up @@ -645,7 +782,7 @@ Jaeger does not use FIPS validated cryptographic modules.
[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 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, 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.

Expand Down Expand Up @@ -701,7 +838,7 @@ endif::openshift-rosa[]
[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 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, 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.

Expand Down Expand Up @@ -1435,7 +1572,7 @@ This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes

This release introduces the following new features and enhancements:

* Rebrands Red Hat OpenShift Jaeger as the {DTProductName}.
* 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.
Expand Down
73 changes: 73 additions & 0 deletions observability/otel/otel-rn.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,79 @@ You can use the {OTELName} xref:otel-forwarding-telemetry-data.adoc#otel-forward

include::snippets/distr-tracing-and-otel-disclaimer-about-docs-for-supported-features-only.adoc[]

// git rebase marker 1

// git rebase marker 2

[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_jaeger-release-notes_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-????])
////

// git rebase marker 3

[id="otel_3-3_{context}"]
== Release notes for {OTELName} 3.3

Expand Down