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

173 lines
2.8 KiB
Markdown
Raw Normal View History

2019-06-27 22:16:04 +00:00
# Haystack
To enable the Haystack:
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
haystack: {}
```
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
2019-07-22 07:58:04 +00:00
--tracing.haystack=true
2019-06-27 22:16:04 +00:00
```
#### `localAgentHost`
_Require, Default="127.0.0.1"_
Local Agent Host instructs reporter to send spans to haystack-agent at this address.
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
haystack:
localAgentHost: 127.0.0.1
```
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
localAgentHost = "127.0.0.1"
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.haystack.localAgentHost=127.0.0.1
2019-06-27 22:16:04 +00:00
```
#### `localAgentPort`
_Require, Default=35000_
2019-06-27 22:16:04 +00:00
Local Agent port instructs reporter to send spans to the haystack-agent at this port.
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
haystack:
localAgentPort: 35000
2019-07-16 07:54:04 +00:00
```
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
localAgentPort = 35000
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.haystack.localAgentPort=35000
2019-06-27 22:16:04 +00:00
```
#### `globalTag`
_Optional, Default=empty_
Apply shared tag in a form of Key:Value to all the traces.
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
haystack:
globalTag: sample:test
```
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
globalTag = "sample:test"
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.haystack.globalTag=sample:test
2019-06-27 22:16:04 +00:00
```
#### `traceIDHeaderName`
_Optional, Default=empty_
Specifies the header name that will be used to store the trace ID.
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
haystack:
traceIDHeaderName: Trace-ID
2019-07-16 07:54:04 +00:00
```
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
traceIDHeaderName = "Trace-ID"
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.haystack.traceIDHeaderName=Trace-ID
2019-06-27 22:16:04 +00:00
```
#### `parentIDHeaderName`
_Optional, Default=empty_
Specifies the header name that will be used to store the parent ID.
2019-06-27 22:16:04 +00:00
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
haystack:
parentIDHeaderName: Parent-Message-ID
2019-07-16 07:54:04 +00:00
```
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
parentIDHeaderName = "Parent-Message-ID"
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.haystack.parentIDHeaderName=Parent-Message-ID
2019-06-27 22:16:04 +00:00
```
#### `spanIDHeaderName`
_Optional, Default=empty_
Specifies the header name that will be used to store the span ID.
2019-06-27 22:16:04 +00:00
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
haystack:
spanIDHeaderName: Message-ID
2019-07-16 07:54:04 +00:00
```
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
spanIDHeaderName = "Message-ID"
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.haystack.spanIDHeaderName=Message-ID
2019-06-27 22:16:04 +00:00
```
#### `baggagePrefixHeaderName`
_Optional, Default=empty_
Specifies the header name prefix that will be used to store baggage items in a map.
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
haystack:
baggagePrefixHeaderName: "sample"
```
```toml tab="File (TOML)"
[tracing]
[tracing.haystack]
baggagePrefixHeaderName = "sample"
```
2019-07-16 07:54:04 +00:00
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.haystack.baggagePrefixHeaderName=sample
2019-06-27 22:16:04 +00:00
```