Skip to content

Commit 59176ee

Browse files
authored
Merge pull request #40980 from JStickler/OSSMDOC-456A
OSSMDOC-456: Distributed tracing rebranding work in OSSM docs.
2 parents a4fe1bc + 2cf9201 commit 59176ee

Some content is hidden

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

45 files changed

+180
-102
lines changed

_attributes/distr-tracing-document-attributes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
:product-dedicated: Red Hat OpenShift Dedicated
1313
:console-redhat-com: Red Hat OpenShift Cluster Manager
1414

15+
:ProductName: Red Hat OpenShift Service Mesh
16+
1517
:DTProductName: Red Hat OpenShift distributed tracing
1618
:DTShortName: distributed tracing
1719
:DTProductVersion: 2.1

distr_tracing/distr_tracing_install/distr-tracing-deploying-jaeger.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,11 @@ include::modules/distr-tracing-deploy-production-es.adoc[leveloffset=+1]
5858

5959
include::modules/distr-tracing-deploy-streaming.adoc[leveloffset=+1]
6060

61+
[id="validating-your-jaeger-deployment"]
62+
== Validating your deployment
63+
64+
include::modules/distr-tracing-accessing-jaeger-console.adoc[leveloffset=+1]
65+
6166
[id="customizing-your-deployment"]
6267
== Customizing your deployment
6368

distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,8 @@ The {OTELName} Operator uses a custom resource definition (CRD) file that define
1111
// The following include statements pull in the module files that comprise the assembly.
1212

1313
include::modules/distr-tracing-config-otel-collector.adoc[leveloffset=+1]
14+
15+
[id="validating-your-otel-deployment"]
16+
== Validating your deployment
17+
18+
include::modules/distr-tracing-accessing-jaeger-console.adoc[leveloffset=+1]
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
////
2+
Module included in the following assemblies:
3+
4+
////
5+
6+
[id="distr-tracing-accessing-jaeger-console_{context}"]
7+
= Accessing the Jaeger console
8+
9+
To access the Jaeger console you must have either {ProductName} or {DTProductName} installed, and {JaegerName} installed, configured, and deployed.
10+
11+
The installation process creates a route to access the Jaeger console.
12+
13+
If you know the URL for the Jaeger console, you can access it directly. If you do not know the URL, use the following directions.
14+
15+
.Procedure from OpenShift console
16+
. Log in to the {product-title} web console as a user with cluster-admin rights. If you use {product-dedicated}, you must have an account with the `dedicated-admin` role.
17+
18+
. Navigate to *Networking* -> *Routes*.
19+
20+
. On the *Routes* page, select the control plane project, for example `tracing-system`, from the *Namespace* menu.
21+
+
22+
The *Location* column displays the linked address for each route.
23+
+
24+
. If necessary, use the filter to find the `jaeger` route. Click the route *Location* to launch the console.
25+
26+
. Click *Log In With OpenShift*.
27+
28+
////
29+
.Procedure from Kiali console
30+
31+
. Launch the Kiali console.
32+
33+
. Click *Distributed Tracing* in the left navigation pane.
34+
35+
. Click *Log In With OpenShift*.
36+
////
37+
38+
.Procedure from the CLI
39+
40+
. Log in to the {product-title} CLI as a user with the `cluster-admin` role. If you use Red Hat OpenShift Dedicated, you must have an account with the `dedicated-admin` role.
41+
+
42+
[source,terminal]
43+
----
44+
$ oc login https://<HOSTNAME>:6443
45+
----
46+
+
47+
. To query for details of the route using the command line, enter the following command. In this example, `tracing-system` is the control plane namespace.
48+
+
49+
[source,terminal]
50+
----
51+
$ export JAEGER_URL=$(oc get route -n tracing-system jaeger -o jsonpath='{.spec.host}')
52+
----
53+
+
54+
. Launch a browser and navigate to ``\https://<JAEGER_URL>``, where `<JAEGER_URL>` is the route that you discovered in the previous step.
55+
56+
. Log in using the same user name and password that you use to access the {Product-title} console.
57+
58+
. If you have added services to the service mesh and have generated traces, you can use the filters and *Find Traces* button to search your trace data.
59+
+
60+
If you are validating the console installation, there is no trace data to display.

modules/distr-tracing-config-ingester.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The deadlock interval is disabled by default (set to `0`), to avoid terminating
4242
|options:
4343
log-level:
4444
|Logging level for the Ingester.
45-
|Possible values: `trace`, `debug`, `info`, `warning`, `error`, `fatal`, `panic`.
45+
|Possible values: `debug`, `info`, `warn`, `error`, `fatal`, `dpanic`, `panic`.
4646
|===
4747

4848
.Streaming Collector and Ingester example

modules/distr-tracing-config-jaeger-collector.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,5 @@ The Collectors are stateless and thus many instances of Jaeger Collector can be
6262
|options:
6363
log-level:
6464
|Logging level for the Collector.
65-
|Possible values: `debug`, `info`, `warning`, `error`, `fatal`, `panic`.
65+
|Possible values: `debug`, `info`, `warn`, `error`, `fatal`, `panic`.
6666
|===

modules/distr-tracing-config-query.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ Query is a service that retrieves traces from storage and hosts the user interfa
3939
|options:
4040
log-level:
4141
|Logging level for Query.
42-
|Possible values: `debug`, `info`, `warning`, `error`, `fatal`, `panic`.
42+
|Possible values: `debug`, `info`, `warn`, `error`, `fatal`, `panic`.
4343
|
4444

4545
|options:
4646
query:
4747
base-path:
4848
|The base path for all jaeger-query HTTP routes can be set to a non-root value, for example, `/jaeger` would cause all UI URLs to start with `/jaeger`. This can be useful when running jaeger-query behind a reverse proxy.
49-
|/{path}
49+
|/<path>
5050
|
5151
|===
5252

modules/jaeger-architecture.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ This CONCEPT module included in the following assemblies:
66
////
77

88
[id="jaeger-architecture_{context}"]
9-
= Jaeger architecture
9+
= Distributed tracing architecture
1010

11-
Jaeger is made up of several components that work together to collect, store, and display tracing data.
11+
The {JaegerShortName} is based on the open source link:https://www.jaegertracing.io/[Jaeger project]. The {JaegerShortName} is made up of several components that work together to collect, store, and display tracing data.
1212

1313
* *Jaeger Client* (Tracer, Reporter, instrumented application, client libraries)- Jaeger clients are language specific implementations of the OpenTracing API. They can be used to instrument applications for distributed tracing either manually or with a variety of existing open source frameworks, such as Camel (Fuse), Spring Boot (RHOAR), MicroProfile (RHOAR/Thorntail), Wildfly (EAP), and many more, that are already integrated with OpenTracing.
1414

modules/jaeger-config-collector.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,5 @@ The collectors are stateless and thus many instances of Jaeger Collector can be
6262
|options:
6363
log-level:
6464
|Logging level for the collector.
65-
|`trace`, `debug`, `info`, `warning`, `error`, `fatal`, `panic`
65+
|Possible values: `debug`, `info`, `warning`, `error`, `fatal`, `panic`
6666
|===

modules/jaeger-config-query.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Query is a service that retrieves traces from storage and hosts the user interfa
4040
|options:
4141
log-level:
4242
|Logging level for Query.
43-
|Possible values: `trace`, `debug`, `info`, `warning`, `error`, `fatal`, `panic`.
43+
|Possible values: `debug`, `info`, `warning`, `error`, `fatal`, `panic`.
4444
|
4545

4646
|options:

0 commit comments

Comments
 (0)