Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3220,6 +3220,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
Expand Down
14 changes: 14 additions & 0 deletions modules/distr-tracing-tempo-about-rn.adoc
Original file line number Diff line number Diff line change
@@ -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.
====
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
// 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
= About {DTShortName}

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.
You can use {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:
With {DTShortName}, you can perform the following functions:

* Monitor distributed transactions

* Optimize performance and latency

* Perform root cause analysis

You can use {DTShortName} in combination with {OTELName}.
11 changes: 11 additions & 0 deletions modules/distr-tracing-tempo-rn-bug-fixes.adoc
Original file line number Diff line number Diff line change
@@ -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]
9 changes: 9 additions & 0 deletions modules/distr-tracing-tempo-rn-deprecated-features.adoc
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions modules/distr-tracing-tempo-rn-enhancements.adoc
Original file line number Diff line number Diff line change
@@ -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.
14 changes: 14 additions & 0 deletions modules/distr-tracing-tempo-rn-known-issues.adoc
Original file line number Diff line number Diff line change
@@ -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]
9 changes: 9 additions & 0 deletions modules/distr-tracing-tempo-rn-removed-features.adoc
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 12 additions & 0 deletions modules/distr-tracing-tempo-rn-technology-preview-features.adoc
Original file line number Diff line number Diff line change
@@ -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]
14 changes: 14 additions & 0 deletions modules/otel-about-rn.adoc
Original file line number Diff line number Diff line change
@@ -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.
====
13 changes: 7 additions & 6 deletions modules/otel-product-overview.adoc → modules/otel-about.adoc
Original file line number Diff line number Diff line change
@@ -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:

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 do not need to manually instrument their code for basic telemetry data.

Expand All @@ -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}.
7 changes: 6 additions & 1 deletion modules/otel-config-send-metrics-monitoring-stack.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
9 changes: 9 additions & 0 deletions modules/otel-rn-bug-fixes.adoc
Original file line number Diff line number Diff line change
@@ -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.
31 changes: 31 additions & 0 deletions modules/otel-rn-deprecated-features.adoc
Original file line number Diff line number Diff line change
@@ -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
# ...
----
11 changes: 11 additions & 0 deletions modules/otel-rn-enhancements.adoc
Original file line number Diff line number Diff line change
@@ -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.
9 changes: 9 additions & 0 deletions modules/otel-rn-known-issues.adoc
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 13 additions & 0 deletions modules/otel-rn-removed-features.adoc
Original file line number Diff line number Diff line change
@@ -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.
18 changes: 18 additions & 0 deletions modules/otel-rn-technology-preview-features.adoc
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ It is valuable for understanding serialization, parallelism, and sources of late

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]
include::modules/distr-tracing-tempo-product-overview.adoc[leveloffset=+1]

include::modules/distr-tracing-features.adoc[leveloffset=+1]

Expand Down
Loading