mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OBSDOCS-1629: Flatten the Distributed tracing docs structure
This commit is contained in:
Max Leonov
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
fbec0b81f2
commit
a48ff262dd
@@ -115,21 +115,21 @@ ifdef::openshift-origin[]
|
||||
:CNVSubscriptionSpecSource: community-operators
|
||||
:CNVSubscriptionSpecName: community-kubevirt-hyperconverged
|
||||
endif::[]
|
||||
// distributed tracing
|
||||
:DTProductName: Red Hat OpenShift distributed tracing platform
|
||||
:DTShortName: distributed tracing platform
|
||||
//distributed tracing
|
||||
:DTProductName: Red Hat OpenShift Distributed Tracing Platform
|
||||
:DTShortName: Distributed Tracing Platform
|
||||
:DTProductVersion: 3.1
|
||||
:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger)
|
||||
:JaegerOperator: Red Hat OpenShift distributed tracing platform
|
||||
:JaegerShortName: distributed tracing platform (Jaeger)
|
||||
:JaegerOperator: Red Hat OpenShift distributed tracing platform
|
||||
:JaegerName: Red Hat OpenShift Distributed Tracing Platform (Jaeger)
|
||||
:JaegerOperator: Red Hat OpenShift Distributed Tracing Platform
|
||||
:JaegerShortName: Distributed Tracing Platform (Jaeger)
|
||||
:JaegerOperator: Red Hat OpenShift Distributed Tracing Platform
|
||||
:JaegerVersion: 1.53.0
|
||||
:OTELName: Red Hat build of OpenTelemetry
|
||||
:OTELShortName: Red Hat build of OpenTelemetry
|
||||
:OTELOperator: Red Hat build of OpenTelemetry Operator
|
||||
:OTELVersion: 0.93.0
|
||||
:TempoName: Red Hat OpenShift distributed tracing platform (Tempo)
|
||||
:TempoShortName: distributed tracing platform (Tempo)
|
||||
:TempoName: Red Hat OpenShift Distributed Tracing Platform
|
||||
:TempoShortName: Distributed Tracing Platform
|
||||
:TempoOperator: Tempo Operator
|
||||
:TempoVersion: 2.3.1
|
||||
// telco
|
||||
|
||||
@@ -2900,48 +2900,42 @@ Topics:
|
||||
File: logging-5-6-reference
|
||||
- Name: Glossary
|
||||
File: logging-common-terms
|
||||
- Name: Distributed tracing
|
||||
- Name: Distributed Tracing
|
||||
Dir: distr_tracing
|
||||
Distros: openshift-enterprise
|
||||
Topics:
|
||||
- Name: Release notes
|
||||
- Name: Release notes for the Distributed Tracing Platform
|
||||
File: distr-tracing-rn
|
||||
- Name: Distributed tracing architecture
|
||||
Dir: distr_tracing_arch
|
||||
Topics:
|
||||
- Name: Distributed tracing architecture
|
||||
File: distr-tracing-architecture
|
||||
- Name: Distributed tracing platform (Tempo)
|
||||
Dir: distr_tracing_tempo
|
||||
Topics:
|
||||
- Name: Installing
|
||||
File: distr-tracing-tempo-installing
|
||||
- Name: Configuring
|
||||
File: distr-tracing-tempo-configuring
|
||||
- Name: Troubleshooting
|
||||
File: distr-tracing-tempo-troubleshooting
|
||||
- Name: Upgrading
|
||||
File: distr-tracing-tempo-updating
|
||||
- Name: Removing
|
||||
File: distr-tracing-tempo-removing
|
||||
- Name: Distributed tracing platform (Jaeger)
|
||||
- Name: About the Distributed Tracing Platform
|
||||
File: distr-tracing-architecture
|
||||
- Name: Installing the Distributed Tracing Platform
|
||||
File: distr-tracing-tempo-installing
|
||||
- Name: Configuring the Distributed Tracing Platform
|
||||
File: distr-tracing-tempo-configuring
|
||||
- Name: Troubleshooting the Distributed Tracing Platform
|
||||
File: distr-tracing-tempo-troubleshooting
|
||||
- Name: Upgrading the Distributed Tracing Platform
|
||||
File: distr-tracing-tempo-updating
|
||||
- Name: Removing the Distributed Tracing Platform
|
||||
File: distr-tracing-tempo-removing
|
||||
- Name: Distributed Tracing Platform (Jaeger)
|
||||
Dir: distr_tracing_jaeger
|
||||
Topics:
|
||||
- Name: Installing
|
||||
- Name: Installing the Distributed Tracing Platform (Jaeger)
|
||||
File: distr-tracing-jaeger-installing
|
||||
- Name: Configuring
|
||||
- Name: Configuring the Distributed Tracing Platform (Jaeger)
|
||||
File: distr-tracing-jaeger-configuring
|
||||
- Name: Upgrading
|
||||
- Name: Upgrading the Distributed Tracing Platform (Jaeger)
|
||||
File: distr-tracing-jaeger-updating
|
||||
- Name: Removing
|
||||
- Name: Removing the Distributed Tracing Platform (Jaeger)
|
||||
File: distr-tracing-jaeger-removing
|
||||
- Name: Red Hat build of OpenTelemetry
|
||||
Dir: otel
|
||||
Distros: openshift-enterprise
|
||||
Topics:
|
||||
- Name: Release notes
|
||||
- Name: Release notes for the Red Hat build of OpenTelemetry
|
||||
File: otel-rn
|
||||
- Name: Installing
|
||||
- Name: Installing the Red Hat build of OpenTelemetry
|
||||
File: otel-installing
|
||||
- Name: Configuring the Collector
|
||||
Dir: otel-collector
|
||||
@@ -2972,13 +2966,13 @@ Topics:
|
||||
File: otel-configuring-otelcol-metrics
|
||||
- Name: Gathering the observability data from multiple clusters
|
||||
File: otel-config-multicluster
|
||||
- Name: Troubleshooting
|
||||
- Name: Troubleshooting the Red Hat build of OpenTelemetry
|
||||
File: otel-troubleshooting
|
||||
- Name: Migrating
|
||||
- Name: Migrating to the Red Hat build of OpenTelemetry
|
||||
File: otel-migrating
|
||||
- Name: Upgrading
|
||||
- Name: Upgrading the Red Hat build of OpenTelemetry
|
||||
File: otel-updating
|
||||
- Name: Removing
|
||||
- Name: Removing the Red Hat build of OpenTelemetry
|
||||
File: otel-removing
|
||||
- Name: Network Observability
|
||||
Dir: network_observability
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * service_mesh/v2x/ossm-architecture.adoc
|
||||
// * observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc
|
||||
// * observability/distr_tracing/distr-tracing-architecture.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="distr-tracing-architecture_{context}"]
|
||||
@@ -27,6 +27,8 @@
|
||||
|
||||
** *OpenTelemetry Collector* - The OpenTelemetry Collector is a vendor-agnostic way to receive, process, and export telemetry data. The OpenTelemetry Collector supports open-source observability data formats, for example, Jaeger and Prometheus, sending to one or more open-source or commercial back-ends. The Collector is the default location instrumentation libraries export their telemetry data.
|
||||
|
||||
// when removing the Jaeger docs, remove all the following lines to the end of the file
|
||||
|
||||
* *{JaegerName}* - This component is based on the open source link:https://www.jaegertracing.io/[Jaeger project].
|
||||
+
|
||||
:FeatureName: The {JaegerName}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * service_mesh/v2x/ossm-architecture.adoc
|
||||
// * observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc
|
||||
// * observability/distr_tracing/distr-tracing-architecture.adoc
|
||||
|
||||
[id="distr-tracing-features_{context}"]
|
||||
= {DTProductName} features
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// * 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_arch/distr-tracing-architecture.adoc
|
||||
// * observability/distr-tracing-architecture.adoc
|
||||
// * service_mesh/v2x/ossm-architecture.adoc
|
||||
// * serverless/serverless-tracing.adoc
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_jaeger/dist-tracing-removing.adoc
|
||||
// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-removing.adoc
|
||||
|
||||
[id="distr-tracing-removing-instance-cli_{context}"]
|
||||
= Removing a {JaegerShortName} instance by using the CLI
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_jaeger/dist-tracing-removing.adoc
|
||||
// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-removing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-removing-instance_{context}"]
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="dist-tracing-sidecar-automatic_{context}"]
|
||||
[id="distr-tracing-sidecar-automatic_{context}"]
|
||||
= Automatically injecting sidecars
|
||||
|
||||
The {JaegerName} Operator can inject Jaeger Agent sidecars into deployment workloads. To enable automatic injection of sidecars, add the `sidecar.jaegertracing.io/inject` annotation set to either the string `true` or to the {JaegerShortName} instance name that is returned by running `$ oc get jaegers`.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="distr-tracing-tempo-config-default_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="distr-tracing-tempo-config-query_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="distr-tracing-tempo-config-receiver-tls-for-tempomonolithic_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="distr-tracing-tempo-config-receiver-tls-for-tempostack_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-config-spanmetrics_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="configuring-tempooperator-metrics-and-alerts_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="configuring-tempostack-metrics-and-alerts_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-install-cli_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-install-gateway-read-permissions_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-install-gateway-write-permissions_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-install-tempomonolithic-cli_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-install-tempomonolithic-web-console_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-install-tempostack-cli_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-install-tempostack-web-console_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-installing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-install-web-console_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
|
||||
//* observability/distr_tracing/distr-tracing-tempo-installing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-object-storage-setup-aws-sts-install_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
|
||||
//* observability/distr_tracing/distr-tracing-tempo-installing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-object-storage-setup-ibm-storage_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* observability/distr_tracing/distr_tracing_tempo/dist-tracing-tempo-removing.adoc
|
||||
//* observability/distr_tracing/distr-tracing-tempo-removing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-removing-tempo-instance-cli_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
//Module included in the following assemblies:
|
||||
//
|
||||
//* observability/distr_tracing/distr_tracing_tempo/dist-tracing-tempo-removing.adoc
|
||||
//* observability/distr_tracing/distr-tracing-tempo-removing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-removing-tempo-instance_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc
|
||||
//* observability/distr_tracing/distr-tracing-tempo-installing.adoc
|
||||
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="distr-tracing-tempo-object-storage-setup_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.adoc
|
||||
// * observability/distr_tracing/distr-tracing-tempo-troubleshooting.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="distr-tracing-tempo-collecting-diagnostic-data-from-command-line_{context}"]
|
||||
|
||||
@@ -28,7 +28,7 @@ kind: ConfigMap
|
||||
apiVersion: v1
|
||||
metadata:
|
||||
name: cabundle
|
||||
namespce: observability
|
||||
namespace: observability
|
||||
annotations:
|
||||
service.beta.openshift.io/inject-cabundle: "true" # <2>
|
||||
---
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="distr-tracing-architecture"]
|
||||
= Distributed tracing architecture
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="distr-tracing-architecture"]
|
||||
= About the {DTShortName}
|
||||
:context: distributed-tracing-architecture
|
||||
|
||||
toc::[]
|
||||
@@ -28,4 +28,4 @@ include::modules/distr-tracing-architecture.adoc[leveloffset=+1]
|
||||
== Additional resources
|
||||
|
||||
// xreffing to the installation page until further notice because OTEL content is currently planned for internal restructuring across pages that is likely to result in renamed page files
|
||||
* xref:../../otel/otel-installing.adoc#install-otel[{OTELName}]
|
||||
* xref:../../observability/otel/otel-installing.adoc#install-otel[{OTELName}]
|
||||
@@ -1,7 +1,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="distr-tracing-rn"]
|
||||
= Release notes for the {DTProductName}
|
||||
= Release notes for the {DTShortName}
|
||||
:context: distr-tracing-rn
|
||||
|
||||
toc::[]
|
||||
@@ -117,11 +117,11 @@ The {JaegerOperator} Operator (Jaeger) will be removed from the `redhat-operator
|
||||
|
||||
You must migrate to the {OTELName} Operator and the {TempoOperator} for distributed tracing collection and storage. For more information, see the following resources:
|
||||
|
||||
* xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating] ({OTELShortName} documentation)
|
||||
* xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating] ({OTELShortName} documentation)
|
||||
|
||||
* xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] ({OTELName} documentation)
|
||||
|
||||
* xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] ({TempoShortName} documentation)
|
||||
* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing] ({TempoShortName} documentation)
|
||||
|
||||
* link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift] (Red Hat Knowledgebase solution)
|
||||
|
||||
@@ -146,9 +146,9 @@ The {JaegerName} 3.5 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift] (Red Hat Knowledgebase)
|
||||
* xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating] ({OTELName} documentation)
|
||||
* xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating] ({OTELName} documentation)
|
||||
* xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] ({OTELName} documentation)
|
||||
* xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] (Distributed tracing platform (Tempo) documentation)
|
||||
* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing] ({DTShortName} documentation)
|
||||
|
||||
////
|
||||
[id="distr-tracing_3-5_jaeger-release-notes_bug-fixes_{context}"]
|
||||
@@ -268,14 +268,14 @@ Red{nbsp}Hat will provide support for these components and fixes for CVEs and bu
|
||||
|
||||
The {JaegerOperator} Operator (Jaeger) will be removed from the `redhat-operators` catalog in a future release. For more information, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift].
|
||||
|
||||
You must migrate to the {OTELName} Operator and the {TempoOperator} for distributed tracing collection and storage. For more information, see xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating] in the {OTELShortName} documentation, xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] in the {OTELName} documentation, and xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] in the {TempoShortName} documentation.
|
||||
You must migrate to the {OTELName} Operator and the {TempoOperator} for distributed tracing collection and storage. For more information, see xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating] in the {OTELShortName} documentation, xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] in the {OTELName} documentation, and xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing] in the {TempoShortName} documentation.
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift (Red Hat Knowledgebase)]
|
||||
* xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating ({OTELName} documentation)]
|
||||
* xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating ({OTELName} documentation)]
|
||||
* xref:../../observability/otel/otel-installing.adoc#install-otel[Installing ({OTELName} documentation)]
|
||||
* xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing (Distributed tracing platform (Tempo) documentation)]
|
||||
* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing ({DTShortName} documentation)]
|
||||
|
||||
[id="distr-tracing_3-4_jaeger-release-notes_bug-fixes_{context}"]
|
||||
==== Bug fixes
|
||||
@@ -299,7 +299,7 @@ endif::openshift-rosa[]
|
||||
[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.
|
||||
The {DTProductName} 3.3.1 is a maintenance release with no changes because the {DTProductName} is bundled with the {OTELName} that is xref:../../observability/otel/otel-rn.adoc#otel_rn[released] with a bug fix.
|
||||
|
||||
This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}.
|
||||
|
||||
@@ -393,7 +393,7 @@ The {JaegerName} 3.3.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
|
||||
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 {JaegerOperator} Operator (Jaeger) 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.
|
||||
The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[migrate] to the xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-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-3-1_jaeger-release-notes_removal-notice_{context}"]
|
||||
@@ -522,7 +522,7 @@ 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 {JaegerOperator} Operator (Jaeger) 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.
|
||||
The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[migrate] to the xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-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-3_jaeger-release-notes_removal-notice_{context}"]
|
||||
|
||||
@@ -1,38 +1,43 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="distr-tracing-tempo-configuring"]
|
||||
= Configuring
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="distr-tracing-tempo-configuring"]
|
||||
= Configuring the {DTShortName}
|
||||
:context: distr-tracing-tempo-configuring
|
||||
|
||||
toc::[]
|
||||
|
||||
[TIP]
|
||||
====
|
||||
For information about configuring the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-jaeger-configuring[Configuring] in the {JaegerShortName} documentation.
|
||||
====
|
||||
|
||||
The {TempoOperator} uses a custom resource definition (CRD) file that defines the architecture and configuration settings for creating and deploying the {TempoShortName} resources. You can install the default configuration or modify the file.
|
||||
|
||||
ifdef::openshift-enterprise,openshift-dedicated[]
|
||||
[id="configuring-storages_{context}"]
|
||||
== Configuring back-end storage
|
||||
|
||||
For information about configuring the back-end storage, see xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] and the relevant configuration section for your chosen storage option.
|
||||
For information about configuring the back-end storage, see xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] and the relevant configuration section for your chosen storage option.
|
||||
endif::[]
|
||||
|
||||
include::modules/distr-tracing-tempo-config-default.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing a TempoStack instance]
|
||||
* xref:../../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing a TempoMonolithic instance]
|
||||
* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing a TempoStack instance]
|
||||
* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing a TempoMonolithic instance]
|
||||
|
||||
include::modules/distr-tracing-tempo-config-query-frontend.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations]
|
||||
* xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations]
|
||||
|
||||
include::modules/distr-tracing-tempo-config-spanmetrics.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Configuring the permissions and tenants]
|
||||
* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Configuring the permissions and tenants]
|
||||
|
||||
[id="config-receiver-tls_{context}"]
|
||||
== Configuring the receiver TLS
|
||||
@@ -44,16 +49,16 @@ include::modules/distr-tracing-tempo-config-receiver-tls-for-tempostack.adoc[lev
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates]
|
||||
* xref:../../../security/certificate_types_descriptions/service-ca-certificates.adoc#cert-types-service-ca-certificates[Service CA certificates]
|
||||
* xref:../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates]
|
||||
* xref:../../security/certificate_types_descriptions/service-ca-certificates.adoc#cert-types-service-ca-certificates[Service CA certificates]
|
||||
|
||||
include::modules/distr-tracing-tempo-config-receiver-tls-for-tempomonolithic.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates]
|
||||
* xref:../../../security/certificate_types_descriptions/service-ca-certificates.adoc#cert-types-service-ca-certificates[Service CA certificates]
|
||||
* xref:../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates]
|
||||
* xref:../../security/certificate_types_descriptions/service-ca-certificates.adoc#cert-types-service-ca-certificates[Service CA certificates]
|
||||
|
||||
[id="taints-and-tolerations_{context}"]
|
||||
== Using taints and tolerations
|
||||
@@ -69,6 +74,6 @@ include::modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.a
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
|
||||
* xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
|
||||
|
||||
include::modules/distr-tracing-tempo-configuring-tempooperator-metrics-and-alerts.adoc[leveloffset=+2]
|
||||
@@ -1,11 +1,16 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="dist-tracing-tempo-installing"]
|
||||
= Installing
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dist-tracing-tempo-installing
|
||||
[id="distr-tracing-tempo-installing"]
|
||||
= Installing the {DTShortName}
|
||||
:context: distr-tracing-tempo-installing
|
||||
|
||||
toc::[]
|
||||
|
||||
[TIP]
|
||||
====
|
||||
For information about installing the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc#distr-tracing-jaeger-installing[Installing] in the {JaegerShortName} documentation.
|
||||
====
|
||||
|
||||
Installing the {TempoShortName} involves the following steps:
|
||||
|
||||
. Installing the {TempoOperator}.
|
||||
@@ -38,7 +43,7 @@ include::modules/distr-tracing-tempo-object-storage-setup-aws-sts-install.adoc[l
|
||||
|
||||
* link:https://docs.aws.amazon.com/iam/[AWS Identity and Access Management Documentation] (AWS documentation)
|
||||
* link:https://docs.aws.amazon.com/cli/[AWS Command Line Interface Documentation] (AWS documentation)
|
||||
* xref:../../../authentication/identity_providers/configuring-oidc-identity-provider.adoc#configuring-oidc-identity-provider[Configuring an OpenID Connect identity provider]
|
||||
* xref:../../authentication/identity_providers/configuring-oidc-identity-provider.adoc#configuring-oidc-identity-provider[Configuring an OpenID Connect identity provider]
|
||||
* link:https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html[Identify AWS resources with Amazon Resource Names (ARNs)] (AWS documentation)
|
||||
|
||||
include::modules/distr-tracing-tempo-object-storage-setup-ibm-storage.adoc[leveloffset=+2]
|
||||
@@ -46,7 +51,7 @@ include::modules/distr-tracing-tempo-object-storage-setup-ibm-storage.adoc[level
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[Getting started with the OpenShift CLI]
|
||||
* xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[Getting started with the OpenShift CLI]
|
||||
* link:https://cloud.ibm.com/docs/cli?topic=cli-getting-started[Getting started with the {ibm-cloud-title} CLI] ({ibm-cloud-title} Docs)
|
||||
* link:https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-provision[Choosing a plan and creating an instance] ({ibm-cloud-title} Docs)
|
||||
* link:https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage&q=credential&tags=cloud-object-storage&offset=10#getting-started[Getting started with {ibm-cloud-title} Object Storage: Before you begin] ({ibm-cloud-title} Docs)
|
||||
@@ -86,7 +91,7 @@ include::modules/distr-tracing-tempo-install-gateway-write-permissions.adoc[leve
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../../observability/otel/otel-installing.adoc#install-otel[Creating the required RBAC resources automatically]
|
||||
* xref:../../observability/otel/otel-installing.adoc#install-otel[Creating the required RBAC resources automatically]
|
||||
|
||||
[id="installing-a-tempostack-instance_{context}"]
|
||||
== Installing a TempoStack instance
|
||||
@@ -125,9 +130,9 @@ include::modules/distr-tracing-tempo-install-tempomonolithic-cli.adoc[leveloffse
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_{context}"]
|
||||
== Additional resources
|
||||
* xref:../../../post_installation_configuration/preparing-for-users.adoc#creating-cluster-admin_post-install-preparing-for-users[Creating a cluster admin]
|
||||
* xref:../../post_installation_configuration/preparing-for-users.adoc#creating-cluster-admin_post-install-preparing-for-users[Creating a cluster admin]
|
||||
* link:https://operatorhub.io/[OperatorHub.io]
|
||||
* xref:../../../web_console/web-console.adoc#web-console[Accessing the web console]
|
||||
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]
|
||||
* xref:../../../operators/user/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[Creating applications from installed Operators]
|
||||
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
|
||||
* xref:../../web_console/web-console.adoc#web-console[Accessing the web console]
|
||||
* xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]
|
||||
* xref:../../operators/user/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[Creating applications from installed Operators]
|
||||
* xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
|
||||
@@ -0,0 +1,29 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="distr-tracing-tempo-removing"]
|
||||
= Removing the {DTShortName}
|
||||
:context: distr-tracing-tempo-removing
|
||||
|
||||
toc::[]
|
||||
|
||||
[TIP]
|
||||
====
|
||||
For information about removing the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc#distr-tracing-jaeger-removing[Removing] in the {JaegerShortName} documentation.
|
||||
====
|
||||
|
||||
The steps for removing the {TempoName} from an {product-title} cluster are as follows:
|
||||
|
||||
. Shut down all {TempoShortName} pods.
|
||||
. Remove any TempoStack instances.
|
||||
. Remove the {TempoOperator}.
|
||||
|
||||
include::modules/distr-tracing-tempo-remove-web-console.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/distr-tracing-tempo-remove-cli.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_{context}"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster]
|
||||
* xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
|
||||
@@ -1,8 +1,8 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="dist-tracing-tempo-troubleshooting"]
|
||||
= Troubleshooting
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dist-tracing-tempo-troubleshooting
|
||||
[id="distr-tracing-tempo-troubleshooting"]
|
||||
= Troubleshooting the {DTShortName}
|
||||
:context: distr-tracing-tempo-troubleshooting
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -1,11 +1,16 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="dist-tracing-tempo-updating"]
|
||||
= Upgrading
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dist-tracing-tempo-updating
|
||||
[id="distr-tracing-tempo-updating"]
|
||||
= Upgrading
|
||||
:context: distr-tracing-tempo-updating
|
||||
|
||||
toc::[]
|
||||
|
||||
[TIP]
|
||||
====
|
||||
For information about upgrading the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc#distr-tracing-jaeger-updating[Upgrading] in the {JaegerShortName} documentation.
|
||||
====
|
||||
|
||||
For version upgrades, the {TempoOperator} uses the Operator Lifecycle Manager (OLM), which controls installation, upgrade, and role-based access control (RBAC) of Operators in a cluster.
|
||||
|
||||
The OLM runs in the {product-title} by default. The OLM queries for available Operators as well as upgrades for installed Operators.
|
||||
@@ -15,5 +20,5 @@ When the {TempoOperator} is upgraded to the new version, it scans for running Te
|
||||
[id="additional-resources_{context}"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager concepts and resources]
|
||||
* xref:../../../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Updating installed Operators]
|
||||
* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager concepts and resources]
|
||||
* xref:../../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Updating installed Operators]
|
||||
@@ -1 +0,0 @@
|
||||
../../_attributes/
|
||||
@@ -1 +0,0 @@
|
||||
../../images/
|
||||
@@ -1 +0,0 @@
|
||||
../../modules/
|
||||
@@ -1 +0,0 @@
|
||||
../../snippets/
|
||||
@@ -1,6 +1,6 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="distr-tracing-jaeger-configuring"]
|
||||
= Configuring
|
||||
= Configuring the {JaegerShortName}
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: distr-tracing-jaeger-configuring
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="dist-tracing-jaeger-installing"]
|
||||
= Installing
|
||||
[id="distr-tracing-jaeger-installing"]
|
||||
= Installing the {JaegerShortName}
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dist-tracing-jaeger-installing
|
||||
:context: distr-tracing-jaeger-installing
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="dist-tracing-jaeger-removing"]
|
||||
= Removing
|
||||
[id="distr-tracing-jaeger-removing"]
|
||||
= Removing the {JaegerShortName}
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dist-tracing-jaeger-removing
|
||||
:context: distr-tracing-jaeger-removing
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="dist-tracing-jaeger-updating"]
|
||||
= Upgrading
|
||||
[id="distr-tracing-jaeger-updating"]
|
||||
= Upgrading the {JaegerShortName}
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dist-tracing-jaeger-updating
|
||||
:context: distr-tracing-jaeger-updating
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
../../_attributes/
|
||||
@@ -1,24 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="dist-tracing-tempo-removing"]
|
||||
= Removing
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dist-tracing-tempo-removing
|
||||
|
||||
toc::[]
|
||||
|
||||
The steps for removing the {TempoName} from an {product-title} cluster are as follows:
|
||||
|
||||
. Shut down all {TempoShortName} pods.
|
||||
. Remove any TempoStack instances.
|
||||
. Remove the {TempoOperator}.
|
||||
|
||||
include::modules/distr-tracing-tempo-remove-web-console.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/distr-tracing-tempo-remove-cli.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_{context}"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster]
|
||||
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
|
||||
@@ -1 +0,0 @@
|
||||
../../images/
|
||||
@@ -1 +0,0 @@
|
||||
../../modules/
|
||||
@@ -1 +0,0 @@
|
||||
../../snippets/
|
||||
@@ -9,4 +9,5 @@ toc::[]
|
||||
The {OTELName} Operator uses a custom resource definition (CRD) file that defines the architecture and configuration settings to be used when creating and deploying the {OTELShortName} resources. You can install the default configuration or modify the file.
|
||||
|
||||
include::modules/otel-collector-config-options.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/otel-creating-required-RBAC-resources-automatically.adoc[leveloffset=+1]
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="otel-gathering-observability-data-from-multiple-clusters"]
|
||||
= Gathering the observability data from multiple clusters
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: otel-gathering-observability-data-from-multiple-clusters
|
||||
|
||||
For a multicluster configuration, you can create one OpenTelemetry Collector instance in each one of the remote clusters and then forward all the telemetry data to one OpenTelemetry Collector instance.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="otel-configuration-of-instrumentation"]
|
||||
= Configuring the instrumentation
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: otel-configuration-of-instrumentation
|
||||
|
||||
toc::[]
|
||||
@@ -10,4 +10,5 @@ toc::[]
|
||||
The {OTELName} Operator uses an `Instrumentation` custom resource that defines the configuration of the instrumentation.
|
||||
|
||||
include::modules/otel-autoinstrumentation.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/otel-config-instrumentation.adoc[leveloffset=+1]
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="otel-configuring-metrics-for-monitoring-stack"]
|
||||
= Configuring metrics for the monitoring stack
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: otel-configuring-metrics-for-monitoring-stack
|
||||
|
||||
toc::[]
|
||||
@@ -13,6 +13,7 @@ As a cluster administrator, you can configure the OpenTelemetry Collector custom
|
||||
* Configure the Prometheus receiver to scrape metrics from the in-cluster monitoring stack.
|
||||
|
||||
include::modules/otel-config-send-metrics-monitoring-stack.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/otel-config-receive-metrics-monitoring-stack.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="otel-configuring-metrics"]
|
||||
= Configuring the OpenTelemetry Collector metrics
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: otel-configuring-metrics
|
||||
|
||||
//[id="setting-up-monitoring-for-otel"]
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="otel-forwarding-telemetry-data"]
|
||||
= Forwarding telemetry data
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: otel-forwarding-telemetry-data
|
||||
|
||||
toc::[]
|
||||
@@ -9,6 +9,7 @@ toc::[]
|
||||
You can use the OpenTelemetry Collector to forward your telemetry data.
|
||||
|
||||
include::modules/otel-forwarding-traces.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/otel-forwarding-logs-to-tempostack.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="install-otel"]
|
||||
= Installing
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: install-otel
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="dist-tracing-otel-migrating"]
|
||||
= Migrating
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dist-tracing-otel-migrating
|
||||
[id="otel-migrating"]
|
||||
= Migrating
|
||||
:context: otel-migrating
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="dist-tracing-otel-removing"]
|
||||
= Removing
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dist-tracing-otel-removing
|
||||
[id="otel-removing"]
|
||||
= Removing
|
||||
:context: otel-removing
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="otel-sending-traces-and-metrics-to-otel-collector"]
|
||||
= Sending traces and metrics to the OpenTelemetry Collector
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: otel-sending-traces-and-metrics-to-otel-collector
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="otel-troubleshoot"]
|
||||
= Troubleshooting
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: otel-troubleshoot
|
||||
|
||||
toc::[]
|
||||
@@ -9,9 +9,13 @@ toc::[]
|
||||
The OpenTelemetry Collector offers multiple ways to measure its health as well as investigate data ingestion issues.
|
||||
|
||||
include::modules/otel-troubleshoot-collecting-diagnostic-data-from-command-line.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/otel-troubleshoot-collector-logs.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/otel-troubleshoot-metrics.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/otel-troubleshoot-debug-exporter-stdout.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/otel-troubleshoot-network-traffic.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
@@ -30,4 +34,5 @@ To troubleshoot the instrumentation, look for any of the following issues:
|
||||
* Issues with data generation by the instrumentation libraries
|
||||
|
||||
include::modules/otel-troubleshooting-instrumentation-injection-into-your-workload.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/otel-troubleshooting-telemetry-data-generation-by-the-instrumentation-libraries.adoc[leveloffset=+2]
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="dist-tracing-otel-updating"]
|
||||
= Upgrading
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dist-tracing-otel-updating
|
||||
[id="otel-updating"]
|
||||
= Upgrading
|
||||
:context: otel-updating
|
||||
|
||||
toc::[]
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ ifdef::openshift-enterprise,openshift-origin[]
|
||||
== Distributed tracing
|
||||
Store and visualize large volumes of requests passing through distributed systems, across the whole stack of microservices, and under heavy loads. Use it for monitoring distributed transactions, gathering insights into your instrumented services, network profiling, performance and latency optimization, root cause analysis, and troubleshooting the interaction between components in modern cloud-native microservices-based applications.
|
||||
|
||||
For more information, see xref:../../observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture].
|
||||
For more information, see xref:../../observability/distr_tracing/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture].
|
||||
|
||||
[id="otel-release-notes-index_{context}"]
|
||||
== {OTELName}
|
||||
|
||||
@@ -29,7 +29,7 @@ include::modules/ossm-config-sampling.adoc[leveloffset=+2]
|
||||
include::modules/ossm-jaeger-accessing-console.adoc[leveloffset=+1]
|
||||
|
||||
ifdef::openshift-enterprise[]
|
||||
For more information about configuring Jaeger, see the xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-deploy-default_deploying-distributed-tracing-platform[distributed tracing documentation].
|
||||
For more information about configuring Jaeger, see the xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-deploy-default_deploying-distributed-tracing-platform[{DTShortName} documentation].
|
||||
endif::[]
|
||||
|
||||
include::modules/ossm-access-grafana.adoc[leveloffset=+1]
|
||||
@@ -45,6 +45,6 @@ ifndef::openshift-rosa,openshift-dedicated[]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
|
||||
* xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc[Installing the distributed tracing platform (Tempo)]
|
||||
* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing the {DTShortName}]
|
||||
* xref:../../observability/otel/otel-installing.adoc[Installing the Red Hat build of OpenTelemetry]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
|
||||
@@ -293,7 +293,7 @@ Use the Cluster Version Operator (CVO) to upgrade your {product-title} cluster.
|
||||
|
||||
- **xref:../observability/logging/cluster-logging.adoc#cluster-logging[OpenShift Logging]**: Learn about logging and configure different logging components, such as log storage, log collectors, and the logging web console plugin.
|
||||
|
||||
- **xref:../observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distr-tracing-architecture[Red Hat OpenShift distributed tracing platform]**: Store and visualize large volumes of requests passing through distributed systems, across the whole stack of microservices, and under heavy loads. Use the distributed tracing platform for monitoring distributed transactions, gathering insights into your instrumented services, network profiling, performance and latency optimization, root cause analysis, and troubleshooting the interaction between components in modern cloud-native microservices-based applications.
|
||||
- **xref:../observability/distr_tracing/distr-tracing-architecture.adoc#distr-tracing-architecture[Red Hat OpenShift distributed tracing platform]**: Store and visualize large volumes of requests passing through distributed systems, across the whole stack of microservices, and under heavy loads. Use the distributed tracing platform for monitoring distributed transactions, gathering insights into your instrumented services, network profiling, performance and latency optimization, root cause analysis, and troubleshooting the interaction between components in modern cloud-native microservices-based applications.
|
||||
|
||||
// xreffing to the installation page until further notice because OTEL content is currently planned for internal restructuring across pages that is likely to result in renamed page files
|
||||
- **xref:../observability/otel/otel-installing.adoc#install-otel[Red Hat build of OpenTelemetry]**: Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open source backends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate.
|
||||
|
||||
Reference in New Issue
Block a user