Skip to content

[enterprise-4.16] OBSDOCS-1629: Flatten the Distributed tracing docs structure #93470

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.

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

Open
wants to merge 1 commit into
base: enterprise-4.16
Choose a base branch
from
Open
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
16 changes: 8 additions & 8 deletions _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -112,20 +112,20 @@ ifdef::openshift-origin[]
:CNVSubscriptionSpecName: community-kubevirt-hyperconverged
endif::[]
// distributed tracing
:DTProductName: Red Hat OpenShift distributed tracing platform
:DTShortName: distributed tracing platform
:DTProductName: Red{nbsp}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{nbsp}Hat OpenShift Distributed Tracing Platform (Jaeger)
:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform
:JaegerShortName: Distributed Tracing Platform (Jaeger)
:JaegerOperator: Red{nbsp}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{nbsp}Hat OpenShift Distributed Tracing Platform
:TempoShortName: Distributed Tracing Platform
:TempoOperator: Tempo Operator
:TempoVersion: 2.3.1
// telco
Expand Down
64 changes: 29 additions & 35 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3022,52 +3022,46 @@ Topics:
# File: logging-5-8-reference
# - Name: 5.7 Logging API reference
# File: logging-5-7-reference
- Name: 5.6 Logging API reference
File: logging-5-6-reference
- Name: Glossary
File: logging-common-terms
- Name: Distributed tracing
# - Name: 5.6 Logging API reference
# File: logging-5-6-reference
# - Name: Glossary
# File: logging-common-terms
- 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
Expand Down Expand Up @@ -3098,13 +3092,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
Expand Down
4 changes: 3 additions & 1 deletion modules/distr-tracing-architecture.adoc
Original file line number Diff line number Diff line change
@@ -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}"]
Expand All @@ -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}
Expand Down
2 changes: 1 addition & 1 deletion modules/distr-tracing-features.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion modules/distr-tracing-product-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion modules/distr-tracing-tempo-config-default.adoc
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/distr-tracing-tempo-config-query-frontend.adoc
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/distr-tracing-tempo-config-spanmetrics.adoc
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/distr-tracing-tempo-install-cli.adoc
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/distr-tracing-tempo-install-tempostack-cli.adoc
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/distr-tracing-tempo-install-web-console.adoc
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/distr-tracing-tempo-remove-cli.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//Module included in the following assemblies:
//
//* observability/distr_tracing/distr_tracing_tempo/dist-tracing-tempo-removing.adoc
//* observability/distr_tracing/dist-tracing-tempo-removing.adoc

:_mod-docs-content-type: PROCEDURE
[id="distr-tracing-removing-tempo-instance-cli_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/distr-tracing-tempo-remove-web-console.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//Module included in the following assemblies:
//
//* observability/distr_tracing/distr_tracing_tempo/dist-tracing-tempo-removing.adoc
//* observability/distr_tracing/dist-tracing-tempo-removing.adoc

:_mod-docs-content-type: PROCEDURE
[id="distr-tracing-removing-tempo-instance_{context}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/distr-tracing-tempo-storage-ref.adoc
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
2 changes: 1 addition & 1 deletion modules/otel-config-receive-metrics-monitoring-stack.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ kind: ConfigMap
apiVersion: v1
metadata:
name: cabundle
namespce: observability
namespace: observability
annotations:
service.beta.openshift.io/inject-cabundle: "true" # <2>
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: ASSEMBLY
[id="distr-tracing-architecture"]
= Distributed tracing architecture
= About the {DTShortName}
include::_attributes/common-attributes.adoc[]
:context: distributed-tracing-architecture

Expand Down Expand Up @@ -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:../otel/otel-installing.adoc#install-otel[{OTELName}]
Loading