Skip to content

Commit

Permalink
OBSDOCS-1414: Release notes for Distributed tracing 3.4
Browse files Browse the repository at this point in the history
  • Loading branch information
max-cx committed Oct 22, 2024
1 parent 18c86e9 commit d629dc5
Show file tree
Hide file tree
Showing 2 changed files with 219 additions and 0 deletions.
144 changes: 144 additions & 0 deletions observability/distr_tracing/distr-tracing-rn.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,150 @@ 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

[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-202?-????/[CVE-202?-????]
////

[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} <x>.<y>.<z>].

[NOTE]
====
The {TempoName} 3.4 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.<y>.0.
====

////
[id="distr-tracing_3-4_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-4_tempo-release-notes_new-features-and-enhancements_{context}"]
==== New features and enhancements
This update introduces the following enhancements:
* ???
////

////
[id="distr-tracing_3-4_tempo-release-notes_deprecated-functionality_{context}"]
==== Deprecated functionality
In the {TempoName} 3.4, ???.
////

////
[id="distr-tracing_3-4_tempo-release-notes_removal-notice_{context}"]
==== Removal notice
In the {TempoName} 3.4, 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-4_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-4_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-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 <x>.<y>.<z>].

[NOTE]
====
The {JaegerName} 3.4 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.<y>.0.
====

[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 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 will be removed from the `redhat-operators` Operator catalog in November 2025.

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.4, 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.
The OpenTelemetry Collector provided by the {OTELName} is the preferred Operator for injecting the trace collector agent.

////
[id="distr-tracing_3-4_jaeger-release-notes_removal-notice_{context}"]
==== Removal notice
In the {JaegerName} 3.4, 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-4_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-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[]

// git rebase marker 2

// git rebase marker 3

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

Expand Down
75 changes: 75 additions & 0 deletions observability/otel/otel-rn.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,81 @@ 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

[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} <x>.<y>.<z>].

The {OTELName} 3.4 is based on the open source link:https://opentelemetry.io/docs/collector/[OpenTelemetry] release 0.<y>.0.

////
[id="otel_3-4_cves_{context}"]
=== CVEs
This release fixes the following CVEs:
* link:https://access.redhat.com/security/cve/CVE-2024-????[CVE-2024-????]
////

////
[id="otel_3-4_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-4_new-features-and-enhancements_{context}"]
=== New features and enhancements
This update introduces the following enhancements:
* ???.
////

////
[id="otel_3-4_jaeger-release-notes_deprecated-functionality_{context}"]
=== Deprecated functionality
In the {OTELName} 3.4, ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????])
////

////
[id="otel_3-4_removal-notice_{context}"]
=== Removal notice
In the {OTELName} 3.4, 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-4_bug-fixes_{context}"]
=== Bug fixes
This update introduces the following bug fixes:
* Before this update, ... . With this update, this issue is fixed by ... . (link:https://issues.redhat.com/browse/TRACING-????[TRACING-????])
////

////
[id="otel_3-4_known-issues_{context}"]
=== Known issues
There are currently known issues:
* ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????])
////

// git rebase marker 2

// git rebase marker 3

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

Expand Down

0 comments on commit d629dc5

Please sign in to comment.