Skip to content

Commit 81e5d0a

Browse files
committed
OBSDOCS-868: Release notes for Distributed Tracing 3.2
1 parent 4e74e13 commit 81e5d0a

File tree

8 files changed

+283
-98
lines changed

8 files changed

+283
-98
lines changed

_topic_maps/_topic_map.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2805,8 +2805,8 @@ Topics:
28052805
- Name: Release notes
28062806
Dir: distr_tracing_rn
28072807
Topics:
2808-
- Name: Distributed tracing 3.1.1
2809-
File: distr-tracing-rn-3-1-1
2808+
- Name: Distributed tracing 3.2
2809+
File: distr-tracing-rn-3-2
28102810
- Name: Past releases
28112811
File: distr-tracing-rn-past-releases
28122812
- Name: Distributed tracing architecture
@@ -2843,8 +2843,8 @@ Topics:
28432843
- Name: Release notes
28442844
Dir: otel_rn
28452845
Topics:
2846-
- Name: Red Hat build of OpenTelemetry 3.1.1
2847-
File: otel-rn-3-1-1
2846+
- Name: Red Hat build of OpenTelemetry 3.2
2847+
File: otel-rn-3-2
28482848
- Name: Past releases
28492849
File: otel-rn-past-releases
28502850
- Name: Installing

modules/otel-product-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/otel/otel_rn/otel-rn-3-1.adoc
3+
// * observability/otel/otel_rn/otel-rn-3-2.adoc
44
// * observability/otel/otel_rn/otel-rn-past-releases.adoc
55

66
:_mod-docs-content-type: CONCEPT

observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1.adoc

Lines changed: 0 additions & 73 deletions
This file was deleted.
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="distributed-tracing-rn-3-2"]
4+
= Release notes for {DTProductName} 3.2
5+
:context: distributed-tracing-rn-3-2
6+
7+
toc::[]
8+
9+
include::modules/distr-tracing-product-overview.adoc[leveloffset=+1]
10+
11+
You can use the {DTShortName} xref:../../otel/otel-forwarding.adoc#otel-forwarding-traces[in combination with] the xref:../../otel/otel-installing.adoc#install-otel[{OTELName}].
12+
13+
This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}.
14+
15+
////
16+
[id="distributed-tracing-rn_3-2_cves"]
17+
== CVEs
18+
19+
This release fixes link:https://access.redhat.com/security/cve/cve-202?-?????[CVE-202?-?????].
20+
////
21+
22+
[id="distributed-tracing-rn_3-2_tempo-release-notes"]
23+
== {TempoName}
24+
25+
The {TempoName} is provided through the {TempoOperator}.
26+
27+
[id="distributed-tracing-rn_3-2_tempo-release-notes_technology-preview-features"]
28+
=== Technology Preview features
29+
30+
This update introduces the following Technology Preview feature:
31+
32+
* Support for the Tempo monolithic deployment.
33+
34+
:FeatureName: The Tempo monolithic deployment
35+
include::snippets/technology-preview.adoc[leveloffset=+1]
36+
37+
[id="distributed-tracing-rn_3-2_tempo-release-notes_new-features-and-enhancements"]
38+
=== New features and enhancements
39+
40+
This update introduces the following enhancements:
41+
42+
* {TempoName} 3.2 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.4.1.
43+
* Allowing the overriding of resources per component.
44+
45+
////
46+
[id="distributed-tracing-rn_3-2_tempo-release-notes_deprecated-functionality"]
47+
=== Deprecated functionality
48+
49+
In the {TempoName} 3.2, ???
50+
////
51+
52+
////
53+
[id="distributed-tracing-rn_3-2_tempo-release-notes_removal-notice"]
54+
=== Removal notice
55+
56+
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.
57+
////
58+
59+
[id="distributed-tracing-rn_3-2_tempo-release-notes_bug-fixes"]
60+
=== Bug fixes
61+
62+
This update introduces the following bug fixes:
63+
64+
* 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])
65+
* 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])
66+
67+
[id="distributed-tracing-rn_3-2_tempo-release-notes_known-issues"]
68+
=== Known issues
69+
70+
There is currently a known issue:
71+
72+
* Currently, the {TempoShortName} fails on the IBM Z (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545])
73+
74+
[id="distributed-tracing-rn_3-2_jaeger-release-notes"]
75+
== {JaegerName}
76+
77+
The {JaegerName} is provided through the {JaegerOperator} Operator.
78+
79+
[IMPORTANT]
80+
====
81+
Jaeger does not use FIPS validated cryptographic modules.
82+
====
83+
84+
[id="distributed-tracing-rn_3-2_jaeger-release-notes_support-for-elasticsearch-operator"]
85+
=== Support for {es-op}
86+
87+
{JaegerName} 3.2 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
88+
89+
[id="distributed-tracing-rn_3-2_jaeger-release-notes_deprecated-functionality"]
90+
=== Deprecated functionality
91+
92+
In the {DTProductName} 3.2, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release.
93+
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.
94+
The {TempoOperator} and the {OTELName} are the preferred Operators for distributed tracing collection and storage.
95+
Users must adopt the OpenTelemetry and Tempo distributed tracing stack because it is the stack to be enhanced going forward.
96+
97+
In the {DTProductName} 3.2, the Jaeger agent is deprecated and planned to be removed in the following release.
98+
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.
99+
The OpenTelemetry Collector provided by the {OTELName} is the preferred Operator for injecting the trace collector agent.
100+
101+
////
102+
[id="distributed-tracing-rn_3-2_jaeger-release-notes_removal-notice"]
103+
=== Removal notice
104+
105+
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.
106+
////
107+
108+
[id="distributed-tracing-rn_3-2_jaeger-release-notes_new-features-and-enhancements"]
109+
=== New features and enhancements
110+
111+
This update introduces the following enhancements for the {JaegerShortName}:
112+
113+
* {JaegerName} 3.2 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.57.0.
114+
115+
[id="distributed-tracing-rn_3-2_jaeger-release-notes_known-issues"]
116+
=== Known issues
117+
118+
There is currently a known issue:
119+
120+
* Currently, Apache Spark is not supported.
121+
122+
ifndef::openshift-rosa[]
123+
124+
* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures.
125+
endif::openshift-rosa[]
126+
127+
include::modules/support.adoc[leveloffset=+1]
128+
129+
include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1]

observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,67 @@ include::modules/distr-tracing-product-overview.adoc[leveloffset=+1]
1010

1111
You can use the {DTShortName} xref:../../otel/otel-forwarding.adoc#otel-forwarding-traces[in combination with] the xref:../../otel/otel-installing.adoc#install-otel[{OTELName}].
1212

13+
[id="distributed-tracing-rn-3-1-1"]
14+
== Release notes for {DTProductName} 3.1.1
15+
16+
This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}.
17+
18+
[id="distributed-tracing-rn_3-1-1_cves"]
19+
=== CVEs
20+
21+
This release fixes link:https://access.redhat.com/security/cve/cve-2023-39326[CVE-2023-39326].
22+
23+
// Tempo section
24+
[id="distributed-tracing-rn_3-1-1_tempo-release-notes"]
25+
=== {TempoName}
26+
27+
The {TempoName} is provided through the {TempoOperator}.
28+
29+
[id="distributed-tracing-rn_3-1-1_tempo-release-notes_known-issues"]
30+
==== Known issues
31+
32+
//There is currently a known issue:
33+
There are currently known issues:
34+
35+
* 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])
36+
* Currently, the {TempoShortName} fails on the IBM Z (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545])
37+
38+
// Jaeger section
39+
[id="distributed-tracing-rn_3-1-1_jaeger-release-notes"]
40+
=== {JaegerName}
41+
42+
The {JaegerName} is provided through the {JaegerOperator} Operator.
43+
44+
[IMPORTANT]
45+
====
46+
Jaeger does not use FIPS validated cryptographic modules.
47+
====
48+
49+
[id="distributed-tracing-rn_3-1-1_jaeger-release-notes_support-for-elasticsearch-operator"]
50+
==== Support for {es-op}
51+
52+
{JaegerName} 3.1.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
53+
54+
[id="distributed-tracing-rn_3-1-1_jaeger-release-notes_deprecated-functionality"]
55+
==== Deprecated functionality
56+
57+
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.
58+
59+
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.
60+
61+
[id="distributed-tracing-rn_3-1-1_jaeger-release-notes_known-issues"]
62+
==== Known issues
63+
64+
//There is currently a known issue:
65+
There are currently known issues:
66+
67+
* Currently, Apache Spark is not supported.
68+
69+
ifndef::openshift-rosa[]
70+
71+
* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures.
72+
endif::openshift-rosa[]
73+
1374
[id="distributed-tracing-rn-3-1"]
1475
== Release notes for {DTProductName} 3.1
1576

observability/otel/otel_rn/otel-rn-3-1-1.adoc

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)