OSSMDOC-337: Document how to access logs from Kiali.

Author: JStickler

_topic_maps/_topic_map.yml

@@ -2735,7 +2735,7 @@ Topics:
     File: ossm-security
   - Name: Traffic management
     File: ossm-traffic-manage
-  - Name: Metrics and traces
+  - Name: Metrics, logs, and traces
     File: ossm-observability
   - Name: Performance and scalability
     File: ossm-performance-scalability

modules/ossm-access-grafana.adoc

@@ -3,7 +3,7 @@
 // * service_mesh/v2x/ossm-observability.adoc
 
 [id="ossm-access-grafana_{context}"]
-= Accessing Grafana
+= Accessing the Grafana console
 
 Grafana is an analytics tool that you can use to view, query, and analyze your service mesh metrics. In this example, `istio-system` is the control plane namespace. To access Grafana, do the following:
 

modules/ossm-access-prometheus.adoc

@@ -3,7 +3,7 @@
 // * service_mesh/v2x/ossm-observability.adoc
 
 [id="ossm-access-prometheus_{context}"]
-= Accessing Prometheus
+= Accessing the Prometheus console
 
 Prometheus is a monitoring and alerting tool that you can use to collect multi-dimensional data about your microservices. In this example, `istio-system` is the control plane namespace.
 

modules/ossm-config-dist-trac.adoc

@@ -1,15 +1,16 @@
-// Module included in the following assemblies:
-//
-// * service_mesh/v2x/ossm-config.adoc
+////
+This module is included in the following assemblies:
+* service_mesh/v2x/ossm-observability.adoc
+////
 
 [id="ossm-config-external-jaeger_{context}"]
-= Connecting standalone Jaeger
+= Connecting an existing distributed tracing instance
 
-If you already use standalone Jaeger for distributed tracing in {product-title}, configure your `ServiceMeshControlPlane` resource to use that standalone Jaeger instance rather than the one installed with {ProductName}.
+If you already have an existing {JaegerName} instance in {product-title}, you can configure your `ServiceMeshControlPlane` resource to use that instance for {DTShortName}.
 
 .Prerequisites
 
-* Configure and deploy a standalone Jaeger instance. For more information, see the Jaeger documentation.
+* {DTProductName} instance installed and configured.
 
 .Procedure
 
@@ -19,19 +20,19 @@ If you already use standalone Jaeger for distributed tracing in {product-title},
 
 . Click the {ProductName} Operator. In the *Istio Service Mesh Control Plane* column, click the name of your `ServiceMeshControlPlane` resource, for example `basic`.
 
-. Add the name of your standalone Jaeger instance to the `ServiceMeshControlPlane`.
+. Add the name of your {JaegerShortName} instance to the `ServiceMeshControlPlane`.
 +
 .. Click the *YAML* tab.
 +
-.. Add the name of your standalone Jaeger instance to `spec.addons.jaeger.name` in your `ServiceMeshControlPlane` resource. In the following example, `simple-prod` is the name of your standalone Jaeger instance.
+.. Add the name of your {JaegerShortName} instance to `spec.addons.jaeger.name` in your `ServiceMeshControlPlane` resource. In the following example, `distr-tracing-production` is the name of the {JaegerShortName} instance.
 +
-.Standalone Jaeger example
+.Example distributed tracing configuration
 [source,yaml]
 ----
 spec:
   addons:
     jaeger:
-      name: simple-prod
+      name: distr-tracing-production
 ----
 +
 .. Click *Save*.

modules/ossm-config-external-jaeger.adoc

@@ -1,6 +1,7 @@
-// Module included in the following assemblies:
-//
-// * service_mesh/v2x/ossm-config.adoc
+////
+This module is included in the following assemblies:
+* service_mesh/v2x/ossm-observability.adoc
+////
 
 [id="ossm-config-sampling_{context}"]
 = Adjusting the sampling rate

modules/ossm-config-sampling.adoc

@@ -1,6 +1,7 @@
-// Module included in the following assemblies:
-//
-// * service_mesh/v2x/installing-ossm.adoc
+////
+This module is included in the following assemblies:
+* service_mesh/v2x/ossm-observability.adoc
+////
 
 [id="ossm-control-plane-deploy-cli_{context}"]
 = Deploying the control plane from the CLI

modules/ossm-control-plane-cli.adoc

@@ -0,0 +1,12 @@
+////
+This module is included in the following assemblies:
+* service_mesh/v1x/ossm-config.adoc
+* service_mesh/v2x/ossm-observability.adoc
+////
+
+[id="ossm-overview-distr-tracing_{context}"]
+= Distributed tracing
+
+Distributed tracing is the process of tracking the performance of individual services in an application by tracing the path of the service calls in the application. Each time a user takes action in an application, a request is executed that might require many services to interact to produce a response. The path of this request is called a distributed transaction.
+
+{ProductName} uses {DTProductName} to allow developers to view call flows in a microservice application.

modules/ossm-distr-tracing.adoc

@@ -1,4 +1,4 @@
-// Standard document attributes to be used in the Service Mesh documentation
+// Standard document attributes to be used in the Service Mesh documentation v1.x
 //
 // The following are shared by all RHOSSM documents:
 :toc:

modules/ossm-document-attributes-1x.adoc

@@ -0,0 +1,61 @@
+////
+Module included in the following assemblies:
+* service_mesh/v2x/ossm-observability.adoc
+* service_mesh/v2x/ossm-troubleshooting-istio.adoc
+////
+
+[id="ossm-accessing-jaeger-console_{context}"]
+= Accessing the Jaeger console
+
+To access the Jaeger console you must have {ProductName} installed, {JaegerName} installed and configured.
+
+The installation process creates a route to access the Jaeger console.
+
+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.
+
+.Procedure from OpenShift console
+. 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.
+
+. Navigate to *Networking* -> *Routes*.
+
+. On the *Routes* page, select the control plane project, for example `istio-system`, from the *Namespace* menu.
++
+The *Location* column displays the linked address for each route.
++
+. If necessary, use the filter to find the `jaeger` route.  Click the route *Location* to launch the console.
+
+. Click *Log In With OpenShift*.
+
+
+.Procedure from Kiali console
+
+. Launch the Kiali console.
+
+. Click *Distributed Tracing* in the left navigation pane.
+
+. Click *Log In With OpenShift*.
+
+
+.Procedure from the CLI
+
+. 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.
++
+[source,terminal]
+----
+$ oc login https://{HOSTNAME}:6443
+----
++
+. To query for details of the route using the command line, enter the following command. In this example, `istio-system` is the control plane namespace.
++
+[source,terminal]
+----
+$ export JAEGER_URL=$(oc get route -n istio-system jaeger -o jsonpath='{.spec.host}')
+----
++
+. Launch a browser and navigate to ``\https://<JAEGER_URL>``, where `<JAEGER_URL>` is the route that you discovered in the previous step.
+
+. Log in using the same user name and password that you use to access the {Product-title} console.
+
+. 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.
++
+If you are validating the console installation, there is no trace data to display.