-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New tracing section in configuration (#692)
* New tracing section in configuration
- Loading branch information
Showing
4 changed files
with
81 additions
and
38 deletions.
There are no files selected for viewing
6 changes: 6 additions & 0 deletions
6
content/en/docs/Configuration/p8s-jaeger-grafana/tracing/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: Tracing | ||
description: Configuration to setup Kiali with Jaeger or Grafana Tempo. | ||
--- | ||
|
||
Jaeger is the default tracing provider for Kiali. From Kiali version 1.74, Tempo support is also included. This page describes how to configure Jaeger and Grafana Tempo in Kiali. |
54 changes: 54 additions & 0 deletions
54
content/en/docs/Configuration/p8s-jaeger-grafana/tracing/jaeger.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
title: "Jaeger" | ||
description: > | ||
This page describes how to configure Jaeger for Kiali. | ||
weight: 1 | ||
--- | ||
|
||
## Jaeger configuration | ||
|
||
Jaeger is a _highly recommended_ service because [Kiali uses distributed | ||
tracing data for several features]({{< relref "../../../Features/tracing" >}}), | ||
providing an enhanced experience. | ||
|
||
By default, Kiali will try to reach Jaeger at the GRPC-enabled URL of the form | ||
`http://tracing.<istio_namespace_name>:16685/jaeger`, which is the usual case | ||
if you are using [the Jaeger Istio | ||
add-on](https://istio.io/latest/docs/ops/integrations/jaeger/#option-1-quick-start). | ||
If this endpoint is unreachable, Kiali will disable features that use | ||
distributed tracing data. | ||
|
||
If your Jaeger instance has a different service name or is installed to a | ||
different namespace, you must manually provide the endpoint where it is | ||
available, like in the following example: | ||
|
||
```yaml | ||
spec: | ||
external_services: | ||
tracing: | ||
# Enabled by default. Kiali will anyway fallback to disabled if | ||
# Jaeger is unreachable. | ||
enabled: true | ||
# Jaeger service name is "tracing" and is in the "telemetry" namespace. | ||
# Make sure the URL you provide corresponds to the non-GRPC enabled endpoint | ||
# if you set "use_grpc" to false. | ||
in_cluster_url: "http://tracing.telemetry:16685/jaeger" | ||
use_grpc: true | ||
# Public facing URL of Jaeger | ||
url: "http://my-jaeger-host/jaeger" | ||
``` | ||
Minimally, you must provide `spec.external_services.tracing.in_cluster_url` to | ||
enable Kiali features that use distributed tracing data. However, Kiali can | ||
provide contextual links that users can use to jump to the Jaeger console to | ||
inspect tracing data more in depth. For these links to be available you need to | ||
set the `spec.external_services.tracing.url` to the URL where you | ||
expose Jaeger outside the cluster. | ||
|
||
{{% alert color="success" %}} | ||
Default values for connecting to Jaeger are based on the [Istio's provided | ||
sample add-on manifests](https://github.com/istio/istio/tree/master/samples/addons). | ||
If your Jaeger setup differs significantly from the sample add-ons, make sure | ||
that Istio is also properly configured to push traces to the right URL. | ||
{{% /alert %}} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters