Skip to content

Commit

Permalink
Update Distrbuted Tracing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
josunect committed Dec 4, 2023
1 parent 00828c2 commit 45d755d
Show file tree
Hide file tree
Showing 11 changed files with 48 additions and 4 deletions.
1 change: 1 addition & 0 deletions content/en/docs/Architecture/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ integration]({{< ref "/docs/features/tracing" >}}).
Tracing data will be available only if
[Istio's distributed tracing](https://istio.io/docs/tasks/telemetry/distributed-tracing/) is enabled.

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

## Grafana

Expand Down
29 changes: 29 additions & 0 deletions content/en/docs/Configuration/debbuging-kiali.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Debugging Kiali"
description: "How to debug Kiali using traces."
---

Kiali provides the ability to emit debugging traces to the [distributed tracing](/docs/configuration/p8s-jaeger-grafana/tracing) platform, Jaeger or Grafana Tempo.

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.

The traces can be sent in OTel or in Jaeger format. This is changed in the _collector_type_ setting.

```yaml
server:
observability:
tracing:
collector_type: "otel"
collector_url: "localhost:4317"
enabled: false
otel:
protocol: "grpc"
tls_enabled: true
skip_verify: false
ca_name: "/tls.crt"
```
The traces emitted by Kiali can be searched using the service name _Kiali_.
![Kiali traces](/images/documentation/configuration/kiali_traces.png)
18 changes: 16 additions & 2 deletions content/en/docs/Configuration/p8s-jaeger-grafana/tracing/tempo.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,25 @@ We also need to set up a default [Tempo datasource](https://grafana.com/docs/gra
![Kiali grafana_tempo](/images/documentation/configuration/grafana_tempo_ds.png)
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
complete in advance, the total number of spans is unknown, and all the traces are represented in the graph with the same size.
The _Traces_ tab will show your traces in a bubble chart:
![Kiali grafana_tempo](/images/documentation/configuration/grafana_tempo.png)
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:
```yaml
spec:
external_services:
tracing:
enabled: true
# grpc port defaults to 9095
grpc_port: 9095
in_cluster_url: "http://query-frontend.tempo:3200"
provider: "tempo"
use_grpc: true
url: "http://my-tempo-host:3200"
```
### Using the Jaeger frontend with Grafana Tempo tracing backend
It is possible to use the Grafana Tempo tracing backend exposing the Jaeger API.
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/Features/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ title: Tracing
description: How Kiali integrates Distributed Tracing with Jaeger.
---

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

For a quick glimpse at Kiali tracing features, see below. For a detailed explanation of tracing in Kiali, see this 3-part
[Trace my mesh](https://medium.com/kialiproject/trace-my-mesh-part-1-3-35e252f9c6a9) blog series,
[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).

<br />

Expand Down
Binary file modified static/images/documentation/configuration/grafana_tempo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/documentation/features/trace-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/documentation/features/trace-graph-overlay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/documentation/features/trace-logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/documentation/features/trace-metric-overlay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/documentation/features/trace-span-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 45d755d

Please sign in to comment.