Chapter 9. Integrating Red Hat OpenShift distributed tracing platform with Kiali Operator provided by Red Hat
You can integrate Red Hat OpenShift distributed tracing platform with Kiali Operator provided by Red Hat, which enables the following features:
- Display trace overlays and details on the graph.
- Display scatterplot charts and in-depth trace/span information on detail pages.
- Integrated span information in logs and metric charts.
- Offer links to the external tracing UI.
9.1. Configuring Red Hat OpenShift distributed tracing platform with Kiali Operator provided by Red Hat
After Kiali Operator provided by Red Hat is integrated with Red Hat OpenShift distributed tracing platform, you can view distributed traces in the Kiali console. Viewing these traces can provide insight into the communication between services within the service mesh, helping you understand how requests are flowing through your system and where potential issues might be.
Prerequisites
- You installed Red Hat OpenShift Service Mesh.
- You configured distributed tracing platform with Red Hat OpenShift Service Mesh.
Procedure
Update the
Kiali
resourcespec
configuration for tracing:Example
Kiali
resourcespec
configuration for tracingspec: external_services: grafana: enabled: true 1 in_cluster_url: http://grafana-istio-system.apps-crc.testing/ 2 url: http://grafana-istio-system.apps-crc.testing/ tracing: enabled: true provider: tempo use_grpc: false in_cluster_url: http://tempo-sample-query-frontend.tempo:3200 url: https://tempo-sample-query-frontend-tempo.apps-crc.testing tempo_config: 3 org_id: "1" datasource_uid: a8d2ef1c-d31c-4de5-a90b-e7bc5252cd00
- 1
- Required so that you can see the View in Tracing link from the Traces tab.
- 2
- If the Tempo resource is deployed with multiple tenants, then the
in_cluster_url
config should point to the gateway with the tenant name as part of the URL. For example: http://tempo-resource-gateway.tempo:8080/api/traces/v1/{tenantName}/tempo - 3
- Required so that you can see the View in Tracing link from the Traces tab and redirect to the proper Tempo
datasource
.
-
Save the updated
spec
in 'kiali_cr.yaml`. Run the following command to apply the configuration:
oc patch -n istio-system kiali kiali --type merge -p "$(cat kiali_cr.yaml)"
Output:
kiali.kiali.io/kiali patched
Verification
Run the following command to get the Kiali route:
oc get route kiali ns istio-system
- Navigate to the Kiali UI.
-
Navigate to Workload
Traces tab to see traces in the Kiali UI.