traefik/docs/content/observability/tracing/overview.md

86 lines
1.5 KiB
Markdown
Raw Normal View History

---
title: "Traefik Tracing Overview"
description: "The Traefik Proxy tracing system allows developers to visualize call flows in their infrastructure. Read the full documentation."
---
2019-06-27 22:16:04 +00:00
# Tracing
Visualize the Requests Flow
{: .subtitle }
The tracing system allows developers to visualize call flows in their infrastructure.
Traefik uses OpenTracing, an open standard designed for distributed tracing.
2020-04-14 15:50:05 +00:00
Traefik supports six tracing backends:
2019-06-27 22:16:04 +00:00
- [Jaeger](./jaeger.md)
- [Zipkin](./zipkin.md)
2019-09-02 10:18:04 +00:00
- [Datadog](./datadog.md)
2019-06-27 22:16:04 +00:00
- [Instana](./instana.md)
- [Haystack](./haystack.md)
2020-04-14 15:50:05 +00:00
- [Elastic](./elastic.md)
2019-06-27 22:16:04 +00:00
## Configuration
By default, Traefik uses Jaeger as tracing backend.
To enable the tracing:
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing: {}
```
```toml tab="File (TOML)"
[tracing]
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
2019-07-22 07:58:04 +00:00
--tracing=true
2019-06-27 22:16:04 +00:00
```
### Common Options
#### `serviceName`
_Required, Default="traefik"_
Service name used in selected backend.
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
serviceName: traefik
```
```toml tab="File (TOML)"
[tracing]
serviceName = "traefik"
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.serviceName=traefik
2019-06-27 22:16:04 +00:00
```
#### `spanNameLimit`
_Required, Default=0_
Span name limit allows for name truncation in case of very long names.
This can prevent certain tracing providers to drop traces that exceed their length limits.
`0` means no truncation will occur.
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
spanNameLimit: 150
```
```toml tab="File (TOML)"
[tracing]
spanNameLimit = 150
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.spanNameLimit=150
```