traefik/docs/content/observability/tracing/haystack.md
2022-04-15 15:44:08 +02:00

2.9 KiB

title description
Traefik Haystack Documentation Traefik supports several tracing backends, including Haystack. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation.

Haystack

To enable the Haystack tracer:

tracing:
  haystack: {}
[tracing]
  [tracing.haystack]
--tracing.haystack=true

localAgentHost

Required, Default="127.0.0.1"

Local Agent Host instructs reporter to send spans to the Haystack Agent at this address.

tracing:
  haystack:
    localAgentHost: 127.0.0.1
[tracing]
  [tracing.haystack]
    localAgentHost = "127.0.0.1"
--tracing.haystack.localAgentHost=127.0.0.1

localAgentPort

Required, Default=35000

Local Agent Port instructs reporter to send spans to the Haystack Agent at this port.

tracing:
  haystack:
    localAgentPort: 35000
[tracing]
  [tracing.haystack]
    localAgentPort = 35000
--tracing.haystack.localAgentPort=35000

globalTag

Optional, Default=empty

Applies shared key:value tag on all spans.

tracing:
  haystack:
    globalTag: sample:test
[tracing]
  [tracing.haystack]
    globalTag = "sample:test"
--tracing.haystack.globalTag=sample:test

traceIDHeaderName

Optional, Default=empty

Sets the header name used to store the trace ID.

tracing:
  haystack:
    traceIDHeaderName: Trace-ID
[tracing]
  [tracing.haystack]
    traceIDHeaderName = "Trace-ID"
--tracing.haystack.traceIDHeaderName=Trace-ID

parentIDHeaderName

Optional, Default=empty

Sets the header name used to store the parent ID.

tracing:
  haystack:
    parentIDHeaderName: Parent-Message-ID
[tracing]
  [tracing.haystack]
    parentIDHeaderName = "Parent-Message-ID"
--tracing.haystack.parentIDHeaderName=Parent-Message-ID

spanIDHeaderName

Optional, Default=empty

Sets the header name used to store the span ID.

tracing:
  haystack:
    spanIDHeaderName: Message-ID
[tracing]
  [tracing.haystack]
    spanIDHeaderName = "Message-ID"
--tracing.haystack.spanIDHeaderName=Message-ID

baggagePrefixHeaderName

Optional, Default=empty

Sets the header name prefix used to store baggage items in a map.

tracing:
  haystack:
    baggagePrefixHeaderName: "sample"
[tracing]
  [tracing.haystack]
    baggagePrefixHeaderName = "sample"
--tracing.haystack.baggagePrefixHeaderName=sample