1
0
Fork 0

Improve tracing documentation

This commit is contained in:
Michael 2019-07-16 09:54:04 +02:00 committed by Traefiker Bot
parent a17ac23457
commit 889b38f75a
6 changed files with 255 additions and 38 deletions

View file

@ -2,11 +2,16 @@
To enable the Zipkin:
```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.zipkin]
```
```yaml tab="File (YAML)"
tracing:
zipkin: {}
```
```bash tab="CLI"
--tracing
--tracing.zipkin
@ -18,12 +23,18 @@ _Required, Default="http://localhost:9411/api/v1/spans"_
Zipkin HTTP endpoint used to send data.
```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.zipkin]
httpEndpoint = "http://localhost:9411/api/v1/spans"
```
```yaml tab="File (YAML)"
tracing:
zipkin:
httpEndpoint: http://localhost:9411/api/v1/spans
```
```bash tab="CLI"
--tracing
--tracing.zipkin.httpEndpoint="http://localhost:9411/api/v1/spans"
@ -35,12 +46,18 @@ _Optional, Default=false_
Enable Zipkin debug.
```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.zipkin]
debug = true
```
```yaml tab="File (YAML)"
tracing:
zipkin:
debug: true
```
```bash tab="CLI"
--tracing
--tracing.zipkin.debug=true
@ -52,12 +69,18 @@ _Optional, Default=false_
Use Zipkin SameSpan RPC style traces.
```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.zipkin]
sameSpan = true
```
```yaml tab="File (YAML)"
tracing:
zipkin:
sameSpan: true
```
```bash tab="CLI"
--tracing
--tracing.zipkin.sameSpan=true
@ -69,12 +92,18 @@ _Optional, Default=true_
Use Zipkin 128 bit root span IDs.
```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.zipkin]
id128Bit = false
```
```yaml tab="File (YAML)"
tracing:
zipkin:
id128Bit: false
```
```bash tab="CLI"
--tracing
--tracing.zipkin.id128Bit=false
@ -86,12 +115,18 @@ _Required, Default=1.0_
The rate between 0.0 and 1.0 of requests to trace.
```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.zipkin]
sampleRate = 0.2
```
```yaml tab="File (YAML)"
tracing:
zipkin:
sampleRate: 0.2
```
```bash tab="CLI"
--tracing
--tracing.zipkin.sampleRate="0.2"