grafana/docs/sources/datasources/zipkin.md

53 lines
3.3 KiB
Markdown
Raw Normal View History

Docs: Trace view, jaeger and zipkin (#24297) * Add docs for trace view, jaeger and zipkin * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update data source docs * Update docs/sources/features/explore/index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Split trace UI description across multiple sections * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Add screenshots * Fix image params * Fix params Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-05-19 05:26:09 -05:00
+++
title = "Zipkin"
Docs: Trace view, jaeger and zipkin (#24297) * Add docs for trace view, jaeger and zipkin * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update data source docs * Update docs/sources/features/explore/index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Split trace UI description across multiple sections * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Add screenshots * Fix image params * Fix params Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-05-19 05:26:09 -05:00
description = "Guide for using Zipkin in Grafana"
keywords = ["grafana", "zipkin", "guide", "tracing"]
type = "docs"
aliases = ["/docs/grafana/latest/datasources/zipkin"]
[menu.docs]
name = "Zipkin"
parent = "datasources"
weight = 1500
Docs: Trace view, jaeger and zipkin (#24297) * Add docs for trace view, jaeger and zipkin * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update data source docs * Update docs/sources/features/explore/index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Split trace UI description across multiple sections * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Add screenshots * Fix image params * Fix params Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-05-19 05:26:09 -05:00
+++
# Zipkin data source
Grafana ships with built-in support for Zipkin, an open source, distributed tracing system.
Just add it as a data source and you are ready to query your traces in [Explore]({{< relref "../explore" >}}).
Docs: Trace view, jaeger and zipkin (#24297) * Add docs for trace view, jaeger and zipkin * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update data source docs * Update docs/sources/features/explore/index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Split trace UI description across multiple sections * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Add screenshots * Fix image params * Fix params Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-05-19 05:26:09 -05:00
## Adding the data source
To access Zipkin settings, click the **Configuration** (gear) icon, then click **Data Sources**, and then click **Zipkin**.
| Name | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `Name` | The data source name. This is how you refer to the data source in panels, queries, and Explore. |
| `Default` | Default data source means that it will be pre-selected for new panels. |
| `URL` | The URL of the Zipkin instance, e.g., `http://localhost:9411` |
| `Access` | Server (default) = URL needs to be accessible from the Grafana backend/server, Browser = URL needs to be accessible from the browser. |
| `Basic Auth` | Enable basic authentication to the Zipkin data source. |
| `User` | User name for basic authentication. |
| `Password` | Password for basic authentication. |
Docs: Trace view, jaeger and zipkin (#24297) * Add docs for trace view, jaeger and zipkin * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update data source docs * Update docs/sources/features/explore/index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Split trace UI description across multiple sections * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Add screenshots * Fix image params * Fix params Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-05-19 05:26:09 -05:00
## Query traces
Querying and displaying traces from Zipkin is available via [Explore]({{< relref "../explore" >}}).
Docs: Trace view, jaeger and zipkin (#24297) * Add docs for trace view, jaeger and zipkin * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/zipkin.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update data source docs * Update docs/sources/features/explore/index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Split trace UI description across multiple sections * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/features/datasources/jaeger.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Add screenshots * Fix image params * Fix params Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-05-19 05:26:09 -05:00
{{< docs-imagebox img="/img/docs/v70/zipkin-query-editor.png" class="docs-image--no-shadow" caption="Screenshot of the Zipkin query editor" >}}
The Zipkin query editor allows you to query by trace ID directly or selecting a trace from trace selector. To query by trace ID, insert the ID into the text input.
{{< docs-imagebox img="/img/docs/v70/zipkin-query-editor-open.png" class="docs-image--no-shadow" caption="Screenshot of the Zipkin query editor with trace selector expanded" >}}
Use the trace selector to pick particular trace from all traces logged in the time range you have selected in Explore. The trace selector has three levels of nesting:
1. The service you are interested in.
1. Particular operation is part of the selected service
1. Specific trace in which the selected operation occurred, represented by the root operation name and trace duration.
## Data mapping in the trace UI
Zipkin annotations are shown in the trace view as logs with annotation value shown under annotation key.
## Linking Trace ID from logs
You can link to Zipkin trace from logs in Loki by configuring a derived field with internal link. See [Loki documentation]({{< relref "loki#derived-fields" >}}) for details.