Skip to content

Commit 28220ea

Browse files
Update Distributed Tracing docs (kiali#727)
* Update Distributed Tracing docs --------- Co-authored-by: John Mazzitelli <[email protected]>
1 parent 00828c2 commit 28220ea

File tree

11 files changed

+53
-4
lines changed

11 files changed

+53
-4
lines changed

content/en/docs/Architecture/architecture.md

+1
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ integration]({{< ref "/docs/features/tracing" >}}).
9595
Tracing data will be available only if
9696
[Istio's distributed tracing](https://istio.io/docs/tasks/telemetry/distributed-tracing/) is enabled.
9797

98+
As an alternative, [Grafana Tempo](/docs/configuration/p8s-jaeger-grafana/tracing/tempo) can be used.
9899

99100
## Grafana
100101

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: "Debugging Kiali"
3+
description: "How to debug Kiali using traces."
4+
---
5+
6+
Kiali provides the ability to emit debugging traces to the [distributed tracing](/docs/configuration/p8s-jaeger-grafana/tracing) platform, Jaeger or Grafana Tempo.
7+
8+
{{% alert color="warning" %}}
9+
In the next release, the feature of Kiali emitting tracing data into Jaeger **will be deprecated**.
10+
{{% /alert %}}
11+
12+
The traces can be sent in HTTP, HTTPS or gRPC protocol. This is specific for the collector type _otel_ - Jaeger traces are sent by http. It is also possible to use TLS. When _tls_enabled_ is set to true, one of the options _skip_verify_ or _ca_name_ should be specified.
13+
14+
The traces can be sent in OTel or in Jaeger format. This is changed in the _collector_type_ setting.
15+
16+
```yaml
17+
server:
18+
observability:
19+
tracing:
20+
collector_type: "otel"
21+
collector_url: "localhost:4317"
22+
enabled: false
23+
otel:
24+
protocol: "grpc"
25+
tls_enabled: true
26+
skip_verify: false
27+
ca_name: "/tls.crt"
28+
```
29+
30+
The traces emitted by Kiali can be searched in the _Kiali_ workload:
31+
32+
![Kiali traces](/images/documentation/configuration/kiali_own_traces.png)
33+
34+

content/en/docs/Configuration/p8s-jaeger-grafana/tracing/tempo.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,25 @@ We also need to set up a default [Tempo datasource](https://grafana.com/docs/gra
4747
4848
![Kiali grafana_tempo](/images/documentation/configuration/grafana_tempo_ds.png)
4949
50-
To improve performance, the data of each Trace is not complete until we hover in that specific trace. Because all the trace information is not
51-
complete in advance, the total number of spans is unknown, and all the traces are represented in the graph with the same size.
50+
The _Traces_ tab will show your traces in a bubble chart:
5251
5352
![Kiali grafana_tempo](/images/documentation/configuration/grafana_tempo.png)
5453
54+
Increasing performance is achievable by enabling gRPC access, specifically for query searches. However, accessing the HTTP API will still be necessary to gather information about individual traces. This is an example to configure the gRPC access:
55+
56+
```yaml
57+
spec:
58+
external_services:
59+
tracing:
60+
enabled: true
61+
# grpc port defaults to 9095
62+
grpc_port: 9095
63+
in_cluster_url: "http://query-frontend.tempo:3200"
64+
provider: "tempo"
65+
use_grpc: true
66+
url: "http://my-tempo-host:3200"
67+
```
68+
5569
### Using the Jaeger frontend with Grafana Tempo tracing backend
5670
5771
It is possible to use the Grafana Tempo tracing backend exposing the Jaeger API.

content/en/docs/Features/tracing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ title: Tracing
33
description: How Kiali integrates Distributed Tracing with Jaeger.
44
---
55

6-
Kiali offers a native integration with Jaeger for Distributed Tracing. As such, users can access Jaeger's trace visualizations. But more
6+
Kiali offers a native integration with two different Distributed Tracing platforms, Jaeger and Grafana Tempo. As such, users can access trace visualizations. But more
77
than that, Kiali incorporates tracing into several correlated views, making your investment in trace data even more valuable.
88

99
For a quick glimpse at Kiali tracing features, see below. For a detailed explanation of tracing in Kiali, see this 3-part
10-
[Trace my mesh](https://medium.com/kialiproject/trace-my-mesh-part-1-3-35e252f9c6a9) blog series,
10+
[Trace my mesh](https://medium.com/kialiproject/trace-my-mesh-part-1-3-35e252f9c6a9) blog series. There is a detailed guide to configure access to the different distributed tracing platform, [Jaeger](/docs/configuration/p8s-jaeger-grafana/tracing/jaeger) and [Grafana Tempo](/docs/configuration/p8s-jaeger-grafana/tracing/tempo).
1111

1212
<br />
1313

Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)