Skip to content

Commit

Permalink
Improve tracing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mmatur authored and traefiker committed Jul 16, 2019
1 parent a17ac23 commit 889b38f
Show file tree
Hide file tree
Showing 6 changed files with 255 additions and 38 deletions.
39 changes: 34 additions & 5 deletions docs/content/observability/tracing/datadog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,16 @@

To enable the DataDog:

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.dataDog]
```

```yaml tab="File (YAML)"
tracing:
dataDog: {}
```

```bash tab="CLI"
--tracing
--tracing.datadog
Expand All @@ -18,12 +23,18 @@ _Required, Default="127.0.0.1:8126"_

Local Agent Host Port instructs reporter to send spans to datadog-tracing-agent at this address.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.dataDog]
localAgentHostPort = "127.0.0.1:8126"
```

```yaml tab="File (YAML)"
tracing:
dataDog:
localAgentHostPort: 127.0.0.1:8126
```

```bash tab="CLI"
--tracing
--tracing.datadog.localAgentHostPort="127.0.0.1:8126"
Expand All @@ -35,12 +46,18 @@ _Optional, Default=false_

Enable DataDog debug.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.dataDog]
debug = true
```

```yaml tab="File (YAML)"
tracing:
dataDog:
debug: true
```

```bash tab="CLI"
--tracing
--tracing.datadog.debug=true
Expand All @@ -52,12 +69,18 @@ _Optional, Default=empty_

Apply shared tag in a form of Key:Value to all the traces.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.dataDog]
globalTag = "sample"
```

```yaml tab="File (YAML)"
tracing:
dataDog:
globalTag: sample
```

```bash tab="CLI"
--tracing
--tracing.datadog.globalTag="sample"
Expand All @@ -70,12 +93,18 @@ _Optional, Default=false_
Enable priority sampling. When using distributed tracing,
this option must be enabled in order to get all the parts of a distributed trace sampled.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.dataDog]
prioritySampling = true
```

```yaml tab="File (YAML)"
tracing:
dataDog:
prioritySampling: true
```

```bash tab="CLI"
--tracing
--tracing.datadog.prioritySampling=true
Expand Down
66 changes: 57 additions & 9 deletions docs/content/observability/tracing/haystack.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,16 @@

To enable the Haystack:

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
```

```yaml tab="File (YAML)"
tracing:
haystack: {}
```

```bash tab="CLI"
--tracing
--tracing.haystack
Expand All @@ -18,12 +23,18 @@ _Require, Default="127.0.0.1"_

Local Agent Host instructs reporter to send spans to haystack-agent at this address.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
localAgentHost = "127.0.0.1"
```

```yaml tab="File (YAML)"
tracing:
haystack:
localAgentHost: 127.0.0.1
```

```bash tab="CLI"
--tracing
--tracing.haystack.localAgentHost="127.0.0.1"
Expand All @@ -35,12 +46,18 @@ _Require, Default=42699_

Local Agent port instructs reporter to send spans to the haystack-agent at this port.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
localAgentPort = 42699
```

```yaml tab="File (YAML)"
tracing:
haystack:
localAgentPort: 42699
```

```bash tab="CLI"
--tracing
--tracing.haystack.localAgentPort=42699
Expand All @@ -52,12 +69,18 @@ _Optional, Default=empty_

Apply shared tag in a form of Key:Value to all the traces.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
globalTag = "sample:test"
```

```yaml tab="File (YAML)"
tracing:
haystack:
globalTag: sample:test
```

```bash tab="CLI"
--tracing
--tracing.haystack.globalTag="sample:test"
Expand All @@ -69,12 +92,18 @@ _Optional, Default=empty_

Specifies the header name that will be used to store the trace ID.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
traceIDHeaderName = "sample"
```

```yaml tab="File (YAML)"
tracing:
haystack:
traceIDHeaderName: sample
```

```bash tab="CLI"
--tracing
--tracing.haystack.traceIDHeaderName="sample"
Expand All @@ -86,12 +115,18 @@ _Optional, Default=empty_

Specifies the header name that will be used to store the span ID.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
parentIDHeaderName = "sample"
```

```yaml tab="File (YAML)"
tracing:
haystack:
parentIDHeaderName: "sample"
```

```bash tab="CLI"
--tracing
--tracing.haystack.parentIDHeaderName="sample"
Expand All @@ -103,15 +138,21 @@ _Optional, Default=empty_

Apply shared tag in a form of Key:Value to all the traces.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
spanIDHeaderName = "sample:test"
```

```yaml tab="File (YAML)"
tracing:
haystack:
spanIDHeaderName: "sample:test"
```

```bash tab="CLI"
--tracing
--tracing.haystack.spanIDHeaderName="sample:test"
--tracing.haystack.spanIDHeaderName=sample:test
```

#### `baggagePrefixHeaderName`
Expand All @@ -120,12 +161,19 @@ _Optional, Default=empty_

Specifies the header name prefix that will be used to store baggage items in a map.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
baggagePrefixHeaderName = "sample"
```

```yaml tab="File (YAML)"
tracing:
haystack:
baggagePrefixHeaderName: "sample"
```


```bash tab="CLI"
--tracing
--tracing.haystack.baggagePrefixHeaderName="sample"
Expand Down
31 changes: 27 additions & 4 deletions docs/content/observability/tracing/instana.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,16 @@

To enable the Instana:

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.instana]
```

```yaml tab="File (YAML)"
tracing:
instana: {}
```

```bash tab="CLI"
--tracing
--tracing.instana
Expand All @@ -18,12 +23,18 @@ _Require, Default="127.0.0.1"_

Local Agent Host instructs reporter to send spans to instana-agent at this address.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.instana]
localAgentHost = "127.0.0.1"
```

```yaml tab="File (YAML)"
tracing:
instana:
localAgentHost: 127.0.0.1
```

```bash tab="CLI"
--tracing
--tracing.instana.localAgentHost="127.0.0.1"
Expand All @@ -35,12 +46,18 @@ _Require, Default=42699_

Local Agent port instructs reporter to send spans to the instana-agent at this port.

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.instana]
localAgentPort = 42699
```

```yaml tab="File (YAML)"
tracing:
instana:
localAgentPort: 42699
```

```bash tab="CLI"
--tracing
--tracing.instana.localAgentPort=42699
Expand All @@ -59,12 +76,18 @@ Valid values for logLevel field are:
- `debug`
- `info`

```toml tab="File"
```toml tab="File (TOML)"
[tracing]
[tracing.instana]
logLevel = "info"
```

```yaml tab="File (YAML)"
tracing:
instana:
logLevel: info
```

```bash tab="CLI"
--tracing
--tracing.instana.logLevel="info"
Expand Down

0 comments on commit 889b38f

Please sign in to comment.