Skip to content

Commit e16479f

Browse files
authored
Merge pull request #72525 from max-cx/OBSDOCS-694
OBSDOCS-694: Update Distributed Tracing doc links and topic map position
2 parents 3bd9429 + 248eb14 commit e16479f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+154
-156
lines changed

_topic_maps/_topic_map.yml

Lines changed: 74 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -2599,7 +2599,80 @@ Distros: openshift-enterprise,openshift-origin
25992599
Topics:
26002600
- Name: Observability overview
26012601
File: index
2602-
- Name: Power monitoring
2602+
- Name: Distributed tracing
2603+
Dir: distr_tracing
2604+
Distros: openshift-enterprise
2605+
Topics:
2606+
- Name: Release notes
2607+
Dir: distr_tracing_rn
2608+
Topics:
2609+
- Name: Distributed tracing 3.1
2610+
File: distr-tracing-rn-3-1
2611+
- Name: Past releases
2612+
File: distr-tracing-rn-past-releases
2613+
- Name: Distributed tracing architecture
2614+
Dir: distr_tracing_arch
2615+
Topics:
2616+
- Name: Distributed tracing architecture
2617+
File: distr-tracing-architecture
2618+
- Name: Distributed tracing platform (Tempo)
2619+
Dir: distr_tracing_tempo
2620+
Topics:
2621+
- Name: Installation
2622+
File: distr-tracing-tempo-installing
2623+
- Name: Configuration
2624+
File: distr-tracing-tempo-configuring
2625+
- Name: Updating
2626+
File: distr-tracing-tempo-updating
2627+
- Name: Removal
2628+
File: distr-tracing-tempo-removing
2629+
- Name: Distributed tracing platform (Jaeger)
2630+
Dir: distr_tracing_jaeger
2631+
Topics:
2632+
- Name: Installation
2633+
File: distr-tracing-jaeger-installing
2634+
- Name: Configuration
2635+
File: distr-tracing-jaeger-configuring
2636+
- Name: Updating
2637+
File: distr-tracing-jaeger-updating
2638+
- Name: Removal
2639+
File: distr-tracing-jaeger-removing
2640+
- Name: Red Hat build of OpenTelemetry
2641+
Dir: otel
2642+
Distros: openshift-enterprise
2643+
Topics:
2644+
- Name: Release notes
2645+
Dir: otel_rn
2646+
Topics:
2647+
- Name: Red Hat build of OpenTelemetry 3.1
2648+
File: otel-rn-3.1
2649+
- Name: Past releases
2650+
File: otel-rn-past-releases
2651+
- Name: Installation
2652+
File: otel-installing
2653+
- Name: Configuration of the OpenTelemetry Collector
2654+
File: otel-configuration-of-otel-collector
2655+
- Name: Configuration of the instrumentation
2656+
File: otel-configuration-of-instrumentation
2657+
- Name: Sending traces and metrics to the Collector
2658+
File: otel-sending-traces-and-metrics-to-otel-collector
2659+
- Name: Sending metrics to the monitoring stack
2660+
File: otel-config-send-metrics-monitoring-stack
2661+
- Name: Forwarding traces to a TempoStack
2662+
File: otel-forwarding
2663+
- Name: Configuring the Collector metrics
2664+
File: otel-configuring-otelcol-metrics
2665+
- Name: Gathering the observability data from multiple clusters
2666+
File: otel-config-multicluster
2667+
- Name: Troubleshooting
2668+
File: otel-troubleshooting
2669+
- Name: Migration
2670+
File: otel-migrating
2671+
- Name: Updating
2672+
File: otel-updating
2673+
- Name: Removal
2674+
File: otel-removing
2675+
- Name: Power Monitoring
26032676
Dir: power_monitoring
26042677
Distros: openshift-enterprise,openshift-origin
26052678
Topics:
@@ -2766,81 +2839,6 @@ Topics:
27662839
- Name: Configuring the Cluster Observability Operator to monitor a service
27672840
File: configuring-the-cluster-observability-operator-to-monitor-a-service
27682841
---
2769-
Name: Distributed tracing
2770-
Dir: distr_tracing
2771-
Distros: openshift-enterprise
2772-
Topics:
2773-
- Name: Release notes
2774-
Dir: distr_tracing_rn
2775-
Topics:
2776-
- Name: Distributed tracing 3.1
2777-
File: distr-tracing-rn-3-1
2778-
- Name: Past releases
2779-
File: distr-tracing-rn-past-releases
2780-
- Name: Distributed tracing architecture
2781-
Dir: distr_tracing_arch
2782-
Topics:
2783-
- Name: Distributed tracing architecture
2784-
File: distr-tracing-architecture
2785-
- Name: Distributed tracing platform (Tempo)
2786-
Dir: distr_tracing_tempo
2787-
Topics:
2788-
- Name: Installation
2789-
File: distr-tracing-tempo-installing
2790-
- Name: Configuration
2791-
File: distr-tracing-tempo-configuring
2792-
- Name: Updating
2793-
File: distr-tracing-tempo-updating
2794-
- Name: Removal
2795-
File: distr-tracing-tempo-removing
2796-
- Name: Distributed tracing platform (Jaeger)
2797-
Dir: distr_tracing_jaeger
2798-
Topics:
2799-
- Name: Installation
2800-
File: distr-tracing-jaeger-installing
2801-
- Name: Configuration
2802-
File: distr-tracing-jaeger-configuring
2803-
- Name: Updating
2804-
File: distr-tracing-jaeger-updating
2805-
- Name: Removal
2806-
File: distr-tracing-jaeger-removing
2807-
---
2808-
Name: Red Hat build of OpenTelemetry
2809-
Dir: otel
2810-
Distros: openshift-enterprise
2811-
Topics:
2812-
- Name: Release notes
2813-
Dir: otel_rn
2814-
Topics:
2815-
- Name: Red Hat build of OpenTelemetry 3.1
2816-
File: otel-rn-3.1
2817-
- Name: Past releases
2818-
File: otel-rn-past-releases
2819-
- Name: Installation
2820-
File: otel-installing
2821-
- Name: Configuration of the OpenTelemetry Collector
2822-
File: otel-configuration-of-otel-collector
2823-
- Name: Configuration of the instrumentation
2824-
File: otel-configuration-of-instrumentation
2825-
- Name: Sending traces and metrics to the Collector
2826-
File: otel-sending-traces-and-metrics-to-otel-collector
2827-
- Name: Sending metrics to the monitoring stack
2828-
File: otel-config-send-metrics-monitoring-stack
2829-
- Name: Forwarding traces to a TempoStack
2830-
File: otel-forwarding
2831-
- Name: Configuring the Collector metrics
2832-
File: otel-configuring-otelcol-metrics
2833-
- Name: Gathering the observability data from multiple clusters
2834-
File: otel-config-multicluster
2835-
- Name: Troubleshooting
2836-
File: otel-troubleshooting
2837-
- Name: Migration
2838-
File: otel-migrating
2839-
- Name: Updating
2840-
File: otel-updating
2841-
- Name: Removal
2842-
File: otel-removing
2843-
---
28442842
Name: Network Observability
28452843
Dir: network_observability
28462844
Distros: openshift-enterprise,openshift-origin

modules/distr-tracing-config-storage.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -229,11 +229,6 @@ The {JaegerName} Operator uses the Elasticsearch instance specified in `spec.sto
229229

230230
* You cannot share or reuse a {product-title} logging Elasticsearch instance with {JaegerShortName}. The Elasticsearch cluster is meant to be dedicated for a single {JaegerShortName} instance.
231231

232-
[NOTE]
233-
====
234-
Red Hat does not provide support for your external Elasticsearch instance. You can review the tested integrations matrix on the link:https://access.redhat.com/articles/5381021[Customer Portal].
235-
====
236-
237232
The following configuration parameters are for an already existing Elasticsearch instance, also known as an _external_ Elasticsearch instance. In this case, you specify configuration options for Elasticsearch under `spec:storage:options:es` in your custom resource file.
238233

239234
.General ES configuration parameters

modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can enable metrics and alerts of TempoStack instances.
1010

1111
.Prerequisites
1212

13-
* Monitoring for user-defined projects is enabled in the cluster. See xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects].
13+
* Monitoring for user-defined projects is enabled in the cluster.
1414
1515
.Procedure
1616

modules/ossm-config-sampling.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The Envoy proxy sampling rate applies for applications that are available to a S
2323
2424
The Jaeger remote sampling rate applies to applications that are external to the Service Mesh, and do not use the Envoy proxy, such as a database. This sampling rate determines how much data the distributed tracing system collects and stores.
2525
ifdef::openshift-enterprise[]
26-
For more information, see xref:../../distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-config-sampling_deploying-distributed-tracing-platform[Distributed tracing configuration options].
26+
For more information, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-config-sampling_deploying-distributed-tracing-platform[Distributed tracing configuration options].
2727
endif::[]
2828
====
2929

File renamed without changes.

0 commit comments

Comments
 (0)