docs: reword tracing config descriptions to be consistent
This commit is contained in:
parent
8d739c411b
commit
d28bcf24e5
15 changed files with 156 additions and 149 deletions
|
@ -1,6 +1,6 @@
|
||||||
# Datadog
|
# Datadog
|
||||||
|
|
||||||
To enable the Datadog:
|
To enable the Datadog tracer:
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -20,7 +20,7 @@ tracing:
|
||||||
|
|
||||||
_Required, Default="127.0.0.1:8126"_
|
_Required, Default="127.0.0.1:8126"_
|
||||||
|
|
||||||
Local Agent Host Port instructs reporter to send spans to datadog-tracing-agent at this address.
|
Local Agent Host Port instructs the reporter to send spans to the Datadog Agent at this address (host:port).
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -42,7 +42,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=false_
|
_Optional, Default=false_
|
||||||
|
|
||||||
Enable Datadog debug.
|
Enables Datadog debug.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -64,7 +64,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=empty_
|
_Optional, Default=empty_
|
||||||
|
|
||||||
Apply shared tag in a form of Key:Value to all the traces.
|
Applies a shared key:value tag on all spans.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -86,7 +86,8 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=false_
|
_Optional, Default=false_
|
||||||
|
|
||||||
Enable priority sampling. When using distributed tracing,
|
Enables priority sampling.
|
||||||
|
When using distributed tracing,
|
||||||
this option must be enabled in order to get all the parts of a distributed trace sampled.
|
this option must be enabled in order to get all the parts of a distributed trace sampled.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Elastic
|
# Elastic
|
||||||
|
|
||||||
To enable the Elastic:
|
To enable the Elastic tracer:
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -20,7 +20,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default="http://localhost:8200"_
|
_Optional, Default="http://localhost:8200"_
|
||||||
|
|
||||||
APM ServerURL is the URL of the Elastic APM server.
|
URL of the Elastic APM server.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -42,7 +42,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=""_
|
_Optional, Default=""_
|
||||||
|
|
||||||
APM Secret Token is the token used to connect to Elastic APM Server.
|
Token used to connect to Elastic APM Server.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -64,7 +64,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=""_
|
_Optional, Default=""_
|
||||||
|
|
||||||
APM Service Environment is the name of the environment Traefik is deployed in, e.g. `production` or `staging`.
|
Environment's name where Traefik is deployed in, e.g. `production` or `staging`.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Haystack
|
# Haystack
|
||||||
|
|
||||||
To enable the Haystack:
|
To enable the Haystack tracer:
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -18,9 +18,9 @@ tracing:
|
||||||
|
|
||||||
#### `localAgentHost`
|
#### `localAgentHost`
|
||||||
|
|
||||||
_Require, Default="127.0.0.1"_
|
_Required, Default="127.0.0.1"_
|
||||||
|
|
||||||
Local Agent Host instructs reporter to send spans to haystack-agent at this address.
|
Local Agent Host instructs reporter to send spans to the Haystack Agent at this address.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -40,9 +40,9 @@ tracing:
|
||||||
|
|
||||||
#### `localAgentPort`
|
#### `localAgentPort`
|
||||||
|
|
||||||
_Require, Default=35000_
|
_Required, Default=35000_
|
||||||
|
|
||||||
Local Agent port instructs reporter to send spans to the haystack-agent at this port.
|
Local Agent Port instructs reporter to send spans to the Haystack Agent at this port.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -64,7 +64,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=empty_
|
_Optional, Default=empty_
|
||||||
|
|
||||||
Apply shared tag in a form of Key:Value to all the traces.
|
Applies shared key:value tag on all spans.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -86,7 +86,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=empty_
|
_Optional, Default=empty_
|
||||||
|
|
||||||
Specifies the header name that will be used to store the trace ID.
|
Sets the header name used to store the trace ID.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -108,7 +108,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=empty_
|
_Optional, Default=empty_
|
||||||
|
|
||||||
Specifies the header name that will be used to store the parent ID.
|
Sets the header name used to store the parent ID.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -130,7 +130,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=empty_
|
_Optional, Default=empty_
|
||||||
|
|
||||||
Specifies the header name that will be used to store the span ID.
|
Sets the header name used to store the span ID.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -152,7 +152,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=empty_
|
_Optional, Default=empty_
|
||||||
|
|
||||||
Specifies the header name prefix that will be used to store baggage items in a map.
|
Sets the header name prefix used to store baggage items in a map.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -166,7 +166,6 @@ tracing:
|
||||||
baggagePrefixHeaderName = "sample"
|
baggagePrefixHeaderName = "sample"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
```bash tab="CLI"
|
```bash tab="CLI"
|
||||||
--tracing.haystack.baggagePrefixHeaderName=sample
|
--tracing.haystack.baggagePrefixHeaderName=sample
|
||||||
```
|
```
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Instana
|
# Instana
|
||||||
|
|
||||||
To enable the Instana:
|
To enable the Instana tracer:
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -18,9 +18,9 @@ tracing:
|
||||||
|
|
||||||
#### `localAgentHost`
|
#### `localAgentHost`
|
||||||
|
|
||||||
_Require, Default="127.0.0.1"_
|
_Required, Default="127.0.0.1"_
|
||||||
|
|
||||||
Local Agent Host instructs reporter to send spans to instana-agent at this address.
|
Local Agent Host instructs reporter to send spans to the Instana Agent at this address.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -40,9 +40,9 @@ tracing:
|
||||||
|
|
||||||
#### `localAgentPort`
|
#### `localAgentPort`
|
||||||
|
|
||||||
_Require, Default=42699_
|
_Required, Default=42699_
|
||||||
|
|
||||||
Local Agent port instructs reporter to send spans to the instana-agent at this port.
|
Local Agent port instructs reporter to send spans to the Instana Agent listening on this port.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -62,11 +62,11 @@ tracing:
|
||||||
|
|
||||||
#### `logLevel`
|
#### `logLevel`
|
||||||
|
|
||||||
_Require, Default="info"_
|
_Required, Default="info"_
|
||||||
|
|
||||||
Set Instana tracer log level.
|
Sets Instana tracer log level.
|
||||||
|
|
||||||
Valid values for logLevel field are:
|
Valid values are:
|
||||||
|
|
||||||
- `error`
|
- `error`
|
||||||
- `warn`
|
- `warn`
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Jaeger
|
# Jaeger
|
||||||
|
|
||||||
To enable the Jaeger:
|
To enable the Jaeger tracer:
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -27,7 +27,7 @@ tracing:
|
||||||
|
|
||||||
_Required, Default="http://localhost:5778/sampling"_
|
_Required, Default="http://localhost:5778/sampling"_
|
||||||
|
|
||||||
Sampling Server URL is the address of jaeger-agent's HTTP sampling server.
|
Address of the Jaeger Agent HTTP sampling server.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -49,7 +49,13 @@ tracing:
|
||||||
|
|
||||||
_Required, Default="const"_
|
_Required, Default="const"_
|
||||||
|
|
||||||
Sampling Type specifies the type of the sampler: `const`, `probabilistic`, `rateLimiting`.
|
Type of the sampler.
|
||||||
|
|
||||||
|
Valid values are:
|
||||||
|
|
||||||
|
- `const`
|
||||||
|
- `probabilistic`
|
||||||
|
- `rateLimiting`
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -71,9 +77,9 @@ tracing:
|
||||||
|
|
||||||
_Required, Default=1.0_
|
_Required, Default=1.0_
|
||||||
|
|
||||||
Sampling Param is a value passed to the sampler.
|
Value passed to the sampler.
|
||||||
|
|
||||||
Valid values for Param field are:
|
Valid values are:
|
||||||
|
|
||||||
- for `const` sampler, 0 or 1 for always false/true respectively
|
- for `const` sampler, 0 or 1 for always false/true respectively
|
||||||
- for `probabilistic` sampler, a probability between 0 and 1
|
- for `probabilistic` sampler, a probability between 0 and 1
|
||||||
|
@ -99,7 +105,7 @@ tracing:
|
||||||
|
|
||||||
_Required, Default="127.0.0.1:6831"_
|
_Required, Default="127.0.0.1:6831"_
|
||||||
|
|
||||||
Local Agent Host Port instructs reporter to send spans to jaeger-agent at this address.
|
Local Agent Host Port instructs the reporter to send spans to the Jaeger Agent at this address (host:port).
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -121,7 +127,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=false_
|
_Optional, Default=false_
|
||||||
|
|
||||||
Generate 128-bit trace IDs, compatible with OpenCensus.
|
Generates 128 bits trace IDs, compatible with OpenCensus.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -143,8 +149,9 @@ tracing:
|
||||||
|
|
||||||
_Required, Default="jaeger"_
|
_Required, Default="jaeger"_
|
||||||
|
|
||||||
Set the propagation header type.
|
Sets the propagation header type.
|
||||||
This can be either:
|
|
||||||
|
Valid values are:
|
||||||
|
|
||||||
- `jaeger`, jaeger's default trace header.
|
- `jaeger`, jaeger's default trace header.
|
||||||
- `b3`, compatible with OpenZipkin
|
- `b3`, compatible with OpenZipkin
|
||||||
|
@ -169,7 +176,7 @@ tracing:
|
||||||
|
|
||||||
_Required, Default="uber-trace-id"_
|
_Required, Default="uber-trace-id"_
|
||||||
|
|
||||||
Trace Context Header Name is the http header name used to propagate tracing context.
|
HTTP header name used to propagate tracing context.
|
||||||
This must be in lower-case to avoid mismatches when decoding incoming headers.
|
This must be in lower-case to avoid mismatches when decoding incoming headers.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
|
@ -192,7 +199,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=true_
|
_Optional, Default=true_
|
||||||
|
|
||||||
Disable the UDP connection helper that periodically re-resolves the agent's hostname and reconnects if there was a change.
|
Disables the UDP connection helper that periodically re-resolves the agent's hostname and reconnects if there was a change.
|
||||||
Enabling the re-resolving of UDP address make the client more robust in Kubernetes deployments.
|
Enabling the re-resolving of UDP address make the client more robust in Kubernetes deployments.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
|
@ -216,7 +223,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=""_
|
_Optional, Default=""_
|
||||||
|
|
||||||
Collector Endpoint instructs reporter to send spans to jaeger-collector at this URL.
|
Collector Endpoint instructs the reporter to send spans to the Jaeger Collector at this URL.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -239,7 +246,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=""_
|
_Optional, Default=""_
|
||||||
|
|
||||||
User instructs reporter to include a user for basic http authentication when sending spans to jaeger-collector.
|
User instructs the reporter to include a user for basic HTTP authentication when sending spans to the Jaeger Collector.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -262,7 +269,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=""_
|
_Optional, Default=""_
|
||||||
|
|
||||||
Password instructs reporter to include a password for basic http authentication when sending spans to jaeger-collector.
|
Password instructs the reporter to include a password for basic HTTP authentication when sending spans to the Jaeger Collector.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Zipkin
|
# Zipkin
|
||||||
|
|
||||||
To enable the Zipkin:
|
To enable the Zipkin tracer:
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -20,7 +20,7 @@ tracing:
|
||||||
|
|
||||||
_Required, Default="http://localhost:9411/api/v2/spans"_
|
_Required, Default="http://localhost:9411/api/v2/spans"_
|
||||||
|
|
||||||
Zipkin HTTP endpoint used to send data.
|
HTTP endpoint used to send data.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -42,7 +42,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=false_
|
_Optional, Default=false_
|
||||||
|
|
||||||
Use Zipkin SameSpan RPC style traces.
|
Uses SameSpan RPC style traces.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -64,7 +64,7 @@ tracing:
|
||||||
|
|
||||||
_Optional, Default=true_
|
_Optional, Default=true_
|
||||||
|
|
||||||
Use Zipkin 128 bit trace IDs.
|
Uses 128 bits trace IDs.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
@ -86,7 +86,7 @@ tracing:
|
||||||
|
|
||||||
_Required, Default=1.0_
|
_Required, Default=1.0_
|
||||||
|
|
||||||
The rate between 0.0 and 1.0 of requests to trace.
|
The proportion of requests to trace, specified between 0.0 and 1.0.
|
||||||
|
|
||||||
```yaml tab="File (YAML)"
|
```yaml tab="File (YAML)"
|
||||||
tracing:
|
tracing:
|
||||||
|
|
|
@ -859,76 +859,76 @@ OpenTracing configuration. (Default: ```false```)
|
||||||
Settings for Datadog. (Default: ```false```)
|
Settings for Datadog. (Default: ```false```)
|
||||||
|
|
||||||
`--tracing.datadog.bagageprefixheadername`:
|
`--tracing.datadog.bagageprefixheadername`:
|
||||||
Specifies the header name prefix that will be used to store baggage items in a map.
|
Sets the header name prefix used to store baggage items in a map.
|
||||||
|
|
||||||
`--tracing.datadog.debug`:
|
`--tracing.datadog.debug`:
|
||||||
Enable Datadog debug. (Default: ```false```)
|
Enables Datadog debug. (Default: ```false```)
|
||||||
|
|
||||||
`--tracing.datadog.globaltag`:
|
`--tracing.datadog.globaltag`:
|
||||||
Key:Value tag to be set on all the spans.
|
Sets a key:value tag on all spans.
|
||||||
|
|
||||||
`--tracing.datadog.localagenthostport`:
|
`--tracing.datadog.localagenthostport`:
|
||||||
Set datadog-agent's host:port that the reporter will used. (Default: ```localhost:8126```)
|
Sets the Datadog Agent host:port. (Default: ```localhost:8126```)
|
||||||
|
|
||||||
`--tracing.datadog.parentidheadername`:
|
`--tracing.datadog.parentidheadername`:
|
||||||
Specifies the header name that will be used to store the parent ID.
|
Sets the header name used to store the parent ID.
|
||||||
|
|
||||||
`--tracing.datadog.prioritysampling`:
|
`--tracing.datadog.prioritysampling`:
|
||||||
Enable priority sampling. When using distributed tracing, this option must be enabled in order to get all the parts of a distributed trace sampled. (Default: ```false```)
|
Enables priority sampling. When using distributed tracing, this option must be enabled in order to get all the parts of a distributed trace sampled. (Default: ```false```)
|
||||||
|
|
||||||
`--tracing.datadog.samplingpriorityheadername`:
|
`--tracing.datadog.samplingpriorityheadername`:
|
||||||
Specifies the header name that will be used to store the sampling priority.
|
Sets the header name used to store the sampling priority.
|
||||||
|
|
||||||
`--tracing.datadog.traceidheadername`:
|
`--tracing.datadog.traceidheadername`:
|
||||||
Specifies the header name that will be used to store the trace ID.
|
Sets the header name used to store the trace ID.
|
||||||
|
|
||||||
`--tracing.elastic`:
|
`--tracing.elastic`:
|
||||||
Settings for Elastic. (Default: ```false```)
|
Settings for Elastic. (Default: ```false```)
|
||||||
|
|
||||||
`--tracing.elastic.secrettoken`:
|
`--tracing.elastic.secrettoken`:
|
||||||
Set the token used to connect to Elastic APM Server.
|
Sets the token used to connect to Elastic APM Server.
|
||||||
|
|
||||||
`--tracing.elastic.serverurl`:
|
`--tracing.elastic.serverurl`:
|
||||||
Set the URL of the Elastic APM server.
|
Sets the URL of the Elastic APM server.
|
||||||
|
|
||||||
`--tracing.elastic.serviceenvironment`:
|
`--tracing.elastic.serviceenvironment`:
|
||||||
Set the name of the environment Traefik is deployed in, e.g. 'production' or 'staging'.
|
Sets the name of the environment Traefik is deployed in, e.g. 'production' or 'staging'.
|
||||||
|
|
||||||
`--tracing.haystack`:
|
`--tracing.haystack`:
|
||||||
Settings for Haystack. (Default: ```false```)
|
Settings for Haystack. (Default: ```false```)
|
||||||
|
|
||||||
`--tracing.haystack.baggageprefixheadername`:
|
`--tracing.haystack.baggageprefixheadername`:
|
||||||
Specifies the header name prefix that will be used to store baggage items in a map.
|
Sets the header name prefix used to store baggage items in a map.
|
||||||
|
|
||||||
`--tracing.haystack.globaltag`:
|
`--tracing.haystack.globaltag`:
|
||||||
Key:Value tag to be set on all the spans.
|
Sets a key:value tag on all spans.
|
||||||
|
|
||||||
`--tracing.haystack.localagenthost`:
|
`--tracing.haystack.localagenthost`:
|
||||||
Set haystack-agent's host that the reporter will used. (Default: ```127.0.0.1```)
|
Sets the Haystack Agent host. (Default: ```127.0.0.1```)
|
||||||
|
|
||||||
`--tracing.haystack.localagentport`:
|
`--tracing.haystack.localagentport`:
|
||||||
Set haystack-agent's port that the reporter will used. (Default: ```35000```)
|
Sets the Haystack Agent port. (Default: ```35000```)
|
||||||
|
|
||||||
`--tracing.haystack.parentidheadername`:
|
`--tracing.haystack.parentidheadername`:
|
||||||
Specifies the header name that will be used to store the parent ID.
|
Sets the header name used to store the parent ID.
|
||||||
|
|
||||||
`--tracing.haystack.spanidheadername`:
|
`--tracing.haystack.spanidheadername`:
|
||||||
Specifies the header name that will be used to store the span ID.
|
Sets the header name used to store the span ID.
|
||||||
|
|
||||||
`--tracing.haystack.traceidheadername`:
|
`--tracing.haystack.traceidheadername`:
|
||||||
Specifies the header name that will be used to store the trace ID.
|
Sets the header name used to store the trace ID.
|
||||||
|
|
||||||
`--tracing.instana`:
|
`--tracing.instana`:
|
||||||
Settings for Instana. (Default: ```false```)
|
Settings for Instana. (Default: ```false```)
|
||||||
|
|
||||||
`--tracing.instana.localagenthost`:
|
`--tracing.instana.localagenthost`:
|
||||||
Set instana-agent's host that the reporter will used.
|
Sets the Instana Agent host.
|
||||||
|
|
||||||
`--tracing.instana.localagentport`:
|
`--tracing.instana.localagentport`:
|
||||||
Set instana-agent's port that the reporter will used. (Default: ```42699```)
|
Sets the Instana Agent port used. (Default: ```42699```)
|
||||||
|
|
||||||
`--tracing.instana.loglevel`:
|
`--tracing.instana.loglevel`:
|
||||||
Set instana-agent's log level. ('error','warn','info','debug') (Default: ```info```)
|
Sets the log level for the Instana tracer. ('error','warn','info','debug') (Default: ```info```)
|
||||||
|
|
||||||
`--tracing.jaeger`:
|
`--tracing.jaeger`:
|
||||||
Settings for Jaeger. (Default: ```false```)
|
Settings for Jaeger. (Default: ```false```)
|
||||||
|
@ -943,28 +943,28 @@ Password for basic http authentication when sending spans to jaeger-collector.
|
||||||
User for basic http authentication when sending spans to jaeger-collector.
|
User for basic http authentication when sending spans to jaeger-collector.
|
||||||
|
|
||||||
`--tracing.jaeger.disableattemptreconnecting`:
|
`--tracing.jaeger.disableattemptreconnecting`:
|
||||||
Disable the periodic re-resolution of the agent's hostname and reconnection if there was a change. (Default: ```true```)
|
Disables the periodic re-resolution of the agent's hostname and reconnection if there was a change. (Default: ```true```)
|
||||||
|
|
||||||
`--tracing.jaeger.gen128bit`:
|
`--tracing.jaeger.gen128bit`:
|
||||||
Generate 128 bit span IDs. (Default: ```false```)
|
Generates 128 bits span IDs. (Default: ```false```)
|
||||||
|
|
||||||
`--tracing.jaeger.localagenthostport`:
|
`--tracing.jaeger.localagenthostport`:
|
||||||
Set jaeger-agent's host:port that the reporter will used. (Default: ```127.0.0.1:6831```)
|
Sets the Jaeger Agent host:port. (Default: ```127.0.0.1:6831```)
|
||||||
|
|
||||||
`--tracing.jaeger.propagation`:
|
`--tracing.jaeger.propagation`:
|
||||||
Which propagation format to use (jaeger/b3). (Default: ```jaeger```)
|
Sets the propagation format (jaeger/b3). (Default: ```jaeger```)
|
||||||
|
|
||||||
`--tracing.jaeger.samplingparam`:
|
`--tracing.jaeger.samplingparam`:
|
||||||
Set the sampling parameter. (Default: ```1.000000```)
|
Sets the sampling parameter. (Default: ```1.000000```)
|
||||||
|
|
||||||
`--tracing.jaeger.samplingserverurl`:
|
`--tracing.jaeger.samplingserverurl`:
|
||||||
Set the sampling server url. (Default: ```http://localhost:5778/sampling```)
|
Sets the sampling server URL. (Default: ```http://localhost:5778/sampling```)
|
||||||
|
|
||||||
`--tracing.jaeger.samplingtype`:
|
`--tracing.jaeger.samplingtype`:
|
||||||
Set the sampling type. (Default: ```const```)
|
Sets the sampling type. (Default: ```const```)
|
||||||
|
|
||||||
`--tracing.jaeger.tracecontextheadername`:
|
`--tracing.jaeger.tracecontextheadername`:
|
||||||
Set the header to use for the trace-id. (Default: ```uber-trace-id```)
|
Sets the header name used to store the trace ID. (Default: ```uber-trace-id```)
|
||||||
|
|
||||||
`--tracing.servicename`:
|
`--tracing.servicename`:
|
||||||
Set the name for this service. (Default: ```traefik```)
|
Set the name for this service. (Default: ```traefik```)
|
||||||
|
@ -976,13 +976,13 @@ Set the maximum character limit for Span names (default 0 = no limit). (Default:
|
||||||
Settings for Zipkin. (Default: ```false```)
|
Settings for Zipkin. (Default: ```false```)
|
||||||
|
|
||||||
`--tracing.zipkin.httpendpoint`:
|
`--tracing.zipkin.httpendpoint`:
|
||||||
HTTP Endpoint to report traces to. (Default: ```http://localhost:9411/api/v2/spans```)
|
Sets the HTTP Endpoint to report traces to. (Default: ```http://localhost:9411/api/v2/spans```)
|
||||||
|
|
||||||
`--tracing.zipkin.id128bit`:
|
`--tracing.zipkin.id128bit`:
|
||||||
Use Zipkin 128 bit root span IDs. (Default: ```true```)
|
Uses 128 bits root span IDs. (Default: ```true```)
|
||||||
|
|
||||||
`--tracing.zipkin.samespan`:
|
`--tracing.zipkin.samespan`:
|
||||||
Use Zipkin SameSpan RPC style traces. (Default: ```false```)
|
Uses SameSpan RPC style traces. (Default: ```false```)
|
||||||
|
|
||||||
`--tracing.zipkin.samplerate`:
|
`--tracing.zipkin.samplerate`:
|
||||||
The rate between 0.0 and 1.0 of requests to trace. (Default: ```1.000000```)
|
Sets the rate between 0.0 and 1.0 of requests to trace. (Default: ```1.000000```)
|
||||||
|
|
|
@ -859,76 +859,76 @@ OpenTracing configuration. (Default: ```false```)
|
||||||
Settings for Datadog. (Default: ```false```)
|
Settings for Datadog. (Default: ```false```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_DATADOG_BAGAGEPREFIXHEADERNAME`:
|
`TRAEFIK_TRACING_DATADOG_BAGAGEPREFIXHEADERNAME`:
|
||||||
Specifies the header name prefix that will be used to store baggage items in a map.
|
Sets the header name prefix used to store baggage items in a map.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_DATADOG_DEBUG`:
|
`TRAEFIK_TRACING_DATADOG_DEBUG`:
|
||||||
Enable Datadog debug. (Default: ```false```)
|
Enables Datadog debug. (Default: ```false```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_DATADOG_GLOBALTAG`:
|
`TRAEFIK_TRACING_DATADOG_GLOBALTAG`:
|
||||||
Key:Value tag to be set on all the spans.
|
Sets a key:value tag on all spans.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_DATADOG_LOCALAGENTHOSTPORT`:
|
`TRAEFIK_TRACING_DATADOG_LOCALAGENTHOSTPORT`:
|
||||||
Set datadog-agent's host:port that the reporter will used. (Default: ```localhost:8126```)
|
Sets the Datadog Agent host:port. (Default: ```localhost:8126```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_DATADOG_PARENTIDHEADERNAME`:
|
`TRAEFIK_TRACING_DATADOG_PARENTIDHEADERNAME`:
|
||||||
Specifies the header name that will be used to store the parent ID.
|
Sets the header name used to store the parent ID.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_DATADOG_PRIORITYSAMPLING`:
|
`TRAEFIK_TRACING_DATADOG_PRIORITYSAMPLING`:
|
||||||
Enable priority sampling. When using distributed tracing, this option must be enabled in order to get all the parts of a distributed trace sampled. (Default: ```false```)
|
Enables priority sampling. When using distributed tracing, this option must be enabled in order to get all the parts of a distributed trace sampled. (Default: ```false```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_DATADOG_SAMPLINGPRIORITYHEADERNAME`:
|
`TRAEFIK_TRACING_DATADOG_SAMPLINGPRIORITYHEADERNAME`:
|
||||||
Specifies the header name that will be used to store the sampling priority.
|
Sets the header name used to store the sampling priority.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_DATADOG_TRACEIDHEADERNAME`:
|
`TRAEFIK_TRACING_DATADOG_TRACEIDHEADERNAME`:
|
||||||
Specifies the header name that will be used to store the trace ID.
|
Sets the header name used to store the trace ID.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_ELASTIC`:
|
`TRAEFIK_TRACING_ELASTIC`:
|
||||||
Settings for Elastic. (Default: ```false```)
|
Settings for Elastic. (Default: ```false```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_ELASTIC_SECRETTOKEN`:
|
`TRAEFIK_TRACING_ELASTIC_SECRETTOKEN`:
|
||||||
Set the token used to connect to Elastic APM Server.
|
Sets the token used to connect to Elastic APM Server.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_ELASTIC_SERVERURL`:
|
`TRAEFIK_TRACING_ELASTIC_SERVERURL`:
|
||||||
Set the URL of the Elastic APM server.
|
Sets the URL of the Elastic APM server.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_ELASTIC_SERVICEENVIRONMENT`:
|
`TRAEFIK_TRACING_ELASTIC_SERVICEENVIRONMENT`:
|
||||||
Set the name of the environment Traefik is deployed in, e.g. 'production' or 'staging'.
|
Sets the name of the environment Traefik is deployed in, e.g. 'production' or 'staging'.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_HAYSTACK`:
|
`TRAEFIK_TRACING_HAYSTACK`:
|
||||||
Settings for Haystack. (Default: ```false```)
|
Settings for Haystack. (Default: ```false```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_HAYSTACK_BAGGAGEPREFIXHEADERNAME`:
|
`TRAEFIK_TRACING_HAYSTACK_BAGGAGEPREFIXHEADERNAME`:
|
||||||
Specifies the header name prefix that will be used to store baggage items in a map.
|
Sets the header name prefix used to store baggage items in a map.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_HAYSTACK_GLOBALTAG`:
|
`TRAEFIK_TRACING_HAYSTACK_GLOBALTAG`:
|
||||||
Key:Value tag to be set on all the spans.
|
Sets a key:value tag on all spans.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_HAYSTACK_LOCALAGENTHOST`:
|
`TRAEFIK_TRACING_HAYSTACK_LOCALAGENTHOST`:
|
||||||
Set haystack-agent's host that the reporter will used. (Default: ```127.0.0.1```)
|
Sets the Haystack Agent host. (Default: ```127.0.0.1```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_HAYSTACK_LOCALAGENTPORT`:
|
`TRAEFIK_TRACING_HAYSTACK_LOCALAGENTPORT`:
|
||||||
Set haystack-agent's port that the reporter will used. (Default: ```35000```)
|
Sets the Haystack Agent port. (Default: ```35000```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_HAYSTACK_PARENTIDHEADERNAME`:
|
`TRAEFIK_TRACING_HAYSTACK_PARENTIDHEADERNAME`:
|
||||||
Specifies the header name that will be used to store the parent ID.
|
Sets the header name used to store the parent ID.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_HAYSTACK_SPANIDHEADERNAME`:
|
`TRAEFIK_TRACING_HAYSTACK_SPANIDHEADERNAME`:
|
||||||
Specifies the header name that will be used to store the span ID.
|
Sets the header name used to store the span ID.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_HAYSTACK_TRACEIDHEADERNAME`:
|
`TRAEFIK_TRACING_HAYSTACK_TRACEIDHEADERNAME`:
|
||||||
Specifies the header name that will be used to store the trace ID.
|
Sets the header name used to store the trace ID.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_INSTANA`:
|
`TRAEFIK_TRACING_INSTANA`:
|
||||||
Settings for Instana. (Default: ```false```)
|
Settings for Instana. (Default: ```false```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_INSTANA_LOCALAGENTHOST`:
|
`TRAEFIK_TRACING_INSTANA_LOCALAGENTHOST`:
|
||||||
Set instana-agent's host that the reporter will used.
|
Sets the Instana Agent host.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_INSTANA_LOCALAGENTPORT`:
|
`TRAEFIK_TRACING_INSTANA_LOCALAGENTPORT`:
|
||||||
Set instana-agent's port that the reporter will used. (Default: ```42699```)
|
Sets the Instana Agent port used. (Default: ```42699```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_INSTANA_LOGLEVEL`:
|
`TRAEFIK_TRACING_INSTANA_LOGLEVEL`:
|
||||||
Set instana-agent's log level. ('error','warn','info','debug') (Default: ```info```)
|
Sets the log level for the Instana tracer. ('error','warn','info','debug') (Default: ```info```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_JAEGER`:
|
`TRAEFIK_TRACING_JAEGER`:
|
||||||
Settings for Jaeger. (Default: ```false```)
|
Settings for Jaeger. (Default: ```false```)
|
||||||
|
@ -943,28 +943,28 @@ Password for basic http authentication when sending spans to jaeger-collector.
|
||||||
User for basic http authentication when sending spans to jaeger-collector.
|
User for basic http authentication when sending spans to jaeger-collector.
|
||||||
|
|
||||||
`TRAEFIK_TRACING_JAEGER_DISABLEATTEMPTRECONNECTING`:
|
`TRAEFIK_TRACING_JAEGER_DISABLEATTEMPTRECONNECTING`:
|
||||||
Disable the periodic re-resolution of the agent's hostname and reconnection if there was a change. (Default: ```true```)
|
Disables the periodic re-resolution of the agent's hostname and reconnection if there was a change. (Default: ```true```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_JAEGER_GEN128BIT`:
|
`TRAEFIK_TRACING_JAEGER_GEN128BIT`:
|
||||||
Generate 128 bit span IDs. (Default: ```false```)
|
Generates 128 bits span IDs. (Default: ```false```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_JAEGER_LOCALAGENTHOSTPORT`:
|
`TRAEFIK_TRACING_JAEGER_LOCALAGENTHOSTPORT`:
|
||||||
Set jaeger-agent's host:port that the reporter will used. (Default: ```127.0.0.1:6831```)
|
Sets the Jaeger Agent host:port. (Default: ```127.0.0.1:6831```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_JAEGER_PROPAGATION`:
|
`TRAEFIK_TRACING_JAEGER_PROPAGATION`:
|
||||||
Which propagation format to use (jaeger/b3). (Default: ```jaeger```)
|
Sets the propagation format (jaeger/b3). (Default: ```jaeger```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_JAEGER_SAMPLINGPARAM`:
|
`TRAEFIK_TRACING_JAEGER_SAMPLINGPARAM`:
|
||||||
Set the sampling parameter. (Default: ```1.000000```)
|
Sets the sampling parameter. (Default: ```1.000000```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_JAEGER_SAMPLINGSERVERURL`:
|
`TRAEFIK_TRACING_JAEGER_SAMPLINGSERVERURL`:
|
||||||
Set the sampling server url. (Default: ```http://localhost:5778/sampling```)
|
Sets the sampling server URL. (Default: ```http://localhost:5778/sampling```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_JAEGER_SAMPLINGTYPE`:
|
`TRAEFIK_TRACING_JAEGER_SAMPLINGTYPE`:
|
||||||
Set the sampling type. (Default: ```const```)
|
Sets the sampling type. (Default: ```const```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_JAEGER_TRACECONTEXTHEADERNAME`:
|
`TRAEFIK_TRACING_JAEGER_TRACECONTEXTHEADERNAME`:
|
||||||
Set the header to use for the trace-id. (Default: ```uber-trace-id```)
|
Sets the header name used to store the trace ID. (Default: ```uber-trace-id```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_SERVICENAME`:
|
`TRAEFIK_TRACING_SERVICENAME`:
|
||||||
Set the name for this service. (Default: ```traefik```)
|
Set the name for this service. (Default: ```traefik```)
|
||||||
|
@ -976,13 +976,13 @@ Set the maximum character limit for Span names (default 0 = no limit). (Default:
|
||||||
Settings for Zipkin. (Default: ```false```)
|
Settings for Zipkin. (Default: ```false```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_ZIPKIN_HTTPENDPOINT`:
|
`TRAEFIK_TRACING_ZIPKIN_HTTPENDPOINT`:
|
||||||
HTTP Endpoint to report traces to. (Default: ```http://localhost:9411/api/v2/spans```)
|
Sets the HTTP Endpoint to report traces to. (Default: ```http://localhost:9411/api/v2/spans```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_ZIPKIN_ID128BIT`:
|
`TRAEFIK_TRACING_ZIPKIN_ID128BIT`:
|
||||||
Use Zipkin 128 bit root span IDs. (Default: ```true```)
|
Uses 128 bits root span IDs. (Default: ```true```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_ZIPKIN_SAMESPAN`:
|
`TRAEFIK_TRACING_ZIPKIN_SAMESPAN`:
|
||||||
Use Zipkin SameSpan RPC style traces. (Default: ```false```)
|
Uses SameSpan RPC style traces. (Default: ```false```)
|
||||||
|
|
||||||
`TRAEFIK_TRACING_ZIPKIN_SAMPLERATE`:
|
`TRAEFIK_TRACING_ZIPKIN_SAMPLERATE`:
|
||||||
The rate between 0.0 and 1.0 of requests to trace. (Default: ```1.000000```)
|
Sets the rate between 0.0 and 1.0 of requests to trace. (Default: ```1.000000```)
|
||||||
|
|
|
@ -17,14 +17,14 @@ const Name = "datadog"
|
||||||
|
|
||||||
// Config provides configuration settings for a datadog tracer.
|
// Config provides configuration settings for a datadog tracer.
|
||||||
type Config struct {
|
type Config struct {
|
||||||
LocalAgentHostPort string `description:"Set datadog-agent's host:port that the reporter will used." json:"localAgentHostPort,omitempty" toml:"localAgentHostPort,omitempty" yaml:"localAgentHostPort,omitempty"`
|
LocalAgentHostPort string `description:"Sets the Datadog Agent host:port." json:"localAgentHostPort,omitempty" toml:"localAgentHostPort,omitempty" yaml:"localAgentHostPort,omitempty"`
|
||||||
GlobalTag string `description:"Key:Value tag to be set on all the spans." json:"globalTag,omitempty" toml:"globalTag,omitempty" yaml:"globalTag,omitempty" export:"true"`
|
GlobalTag string `description:"Sets a key:value tag on all spans." json:"globalTag,omitempty" toml:"globalTag,omitempty" yaml:"globalTag,omitempty" export:"true"`
|
||||||
Debug bool `description:"Enable Datadog debug." json:"debug,omitempty" toml:"debug,omitempty" yaml:"debug,omitempty" export:"true"`
|
Debug bool `description:"Enables Datadog debug." json:"debug,omitempty" toml:"debug,omitempty" yaml:"debug,omitempty" export:"true"`
|
||||||
PrioritySampling bool `description:"Enable priority sampling. When using distributed tracing, this option must be enabled in order to get all the parts of a distributed trace sampled." json:"prioritySampling,omitempty" toml:"prioritySampling,omitempty" yaml:"prioritySampling,omitempty" export:"true"`
|
PrioritySampling bool `description:"Enables priority sampling. When using distributed tracing, this option must be enabled in order to get all the parts of a distributed trace sampled." json:"prioritySampling,omitempty" toml:"prioritySampling,omitempty" yaml:"prioritySampling,omitempty" export:"true"`
|
||||||
TraceIDHeaderName string `description:"Specifies the header name that will be used to store the trace ID." json:"traceIDHeaderName,omitempty" toml:"traceIDHeaderName,omitempty" yaml:"traceIDHeaderName,omitempty" export:"true"`
|
TraceIDHeaderName string `description:"Sets the header name used to store the trace ID." json:"traceIDHeaderName,omitempty" toml:"traceIDHeaderName,omitempty" yaml:"traceIDHeaderName,omitempty" export:"true"`
|
||||||
ParentIDHeaderName string `description:"Specifies the header name that will be used to store the parent ID." json:"parentIDHeaderName,omitempty" toml:"parentIDHeaderName,omitempty" yaml:"parentIDHeaderName,omitempty" export:"true"`
|
ParentIDHeaderName string `description:"Sets the header name used to store the parent ID." json:"parentIDHeaderName,omitempty" toml:"parentIDHeaderName,omitempty" yaml:"parentIDHeaderName,omitempty" export:"true"`
|
||||||
SamplingPriorityHeaderName string `description:"Specifies the header name that will be used to store the sampling priority." json:"samplingPriorityHeaderName,omitempty" toml:"samplingPriorityHeaderName,omitempty" yaml:"samplingPriorityHeaderName,omitempty" export:"true"`
|
SamplingPriorityHeaderName string `description:"Sets the header name used to store the sampling priority." json:"samplingPriorityHeaderName,omitempty" toml:"samplingPriorityHeaderName,omitempty" yaml:"samplingPriorityHeaderName,omitempty" export:"true"`
|
||||||
BagagePrefixHeaderName string `description:"Specifies the header name prefix that will be used to store baggage items in a map." json:"bagagePrefixHeaderName,omitempty" toml:"bagagePrefixHeaderName,omitempty" yaml:"bagagePrefixHeaderName,omitempty" export:"true"`
|
BagagePrefixHeaderName string `description:"Sets the header name prefix used to store baggage items in a map." json:"bagagePrefixHeaderName,omitempty" toml:"bagagePrefixHeaderName,omitempty" yaml:"bagagePrefixHeaderName,omitempty" export:"true"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetDefaults sets the default values.
|
// SetDefaults sets the default values.
|
||||||
|
|
|
@ -24,9 +24,9 @@ func init() {
|
||||||
|
|
||||||
// Config provides configuration settings for a elastic.co tracer.
|
// Config provides configuration settings for a elastic.co tracer.
|
||||||
type Config struct {
|
type Config struct {
|
||||||
ServerURL string `description:"Set the URL of the Elastic APM server." json:"serverURL,omitempty" toml:"serverURL,omitempty" yaml:"serverURL,omitempty"`
|
ServerURL string `description:"Sets the URL of the Elastic APM server." json:"serverURL,omitempty" toml:"serverURL,omitempty" yaml:"serverURL,omitempty"`
|
||||||
SecretToken string `description:"Set the token used to connect to Elastic APM Server." json:"secretToken,omitempty" toml:"secretToken,omitempty" yaml:"secretToken,omitempty"`
|
SecretToken string `description:"Sets the token used to connect to Elastic APM Server." json:"secretToken,omitempty" toml:"secretToken,omitempty" yaml:"secretToken,omitempty"`
|
||||||
ServiceEnvironment string `description:"Set the name of the environment Traefik is deployed in, e.g. 'production' or 'staging'." json:"serviceEnvironment,omitempty" toml:"serviceEnvironment,omitempty" yaml:"serviceEnvironment,omitempty" export:"true"`
|
ServiceEnvironment string `description:"Sets the name of the environment Traefik is deployed in, e.g. 'production' or 'staging'." json:"serviceEnvironment,omitempty" toml:"serviceEnvironment,omitempty" yaml:"serviceEnvironment,omitempty" export:"true"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Setup sets up the tracer.
|
// Setup sets up the tracer.
|
||||||
|
|
|
@ -15,13 +15,13 @@ const Name = "haystack"
|
||||||
|
|
||||||
// Config provides configuration settings for a haystack tracer.
|
// Config provides configuration settings for a haystack tracer.
|
||||||
type Config struct {
|
type Config struct {
|
||||||
LocalAgentHost string `description:"Set haystack-agent's host that the reporter will used." json:"localAgentHost,omitempty" toml:"localAgentHost,omitempty" yaml:"localAgentHost,omitempty"`
|
LocalAgentHost string `description:"Sets the Haystack Agent host." json:"localAgentHost,omitempty" toml:"localAgentHost,omitempty" yaml:"localAgentHost,omitempty"`
|
||||||
LocalAgentPort int `description:"Set haystack-agent's port that the reporter will used." json:"localAgentPort,omitempty" toml:"localAgentPort,omitempty" yaml:"localAgentPort,omitempty"`
|
LocalAgentPort int `description:"Sets the Haystack Agent port." json:"localAgentPort,omitempty" toml:"localAgentPort,omitempty" yaml:"localAgentPort,omitempty"`
|
||||||
GlobalTag string `description:"Key:Value tag to be set on all the spans." json:"globalTag,omitempty" toml:"globalTag,omitempty" yaml:"globalTag,omitempty" export:"true"`
|
GlobalTag string `description:"Sets a key:value tag on all spans." json:"globalTag,omitempty" toml:"globalTag,omitempty" yaml:"globalTag,omitempty" export:"true"`
|
||||||
TraceIDHeaderName string `description:"Specifies the header name that will be used to store the trace ID." json:"traceIDHeaderName,omitempty" toml:"traceIDHeaderName,omitempty" yaml:"traceIDHeaderName,omitempty" export:"true"`
|
TraceIDHeaderName string `description:"Sets the header name used to store the trace ID." json:"traceIDHeaderName,omitempty" toml:"traceIDHeaderName,omitempty" yaml:"traceIDHeaderName,omitempty" export:"true"`
|
||||||
ParentIDHeaderName string `description:"Specifies the header name that will be used to store the parent ID." json:"parentIDHeaderName,omitempty" toml:"parentIDHeaderName,omitempty" yaml:"parentIDHeaderName,omitempty" export:"true"`
|
ParentIDHeaderName string `description:"Sets the header name used to store the parent ID." json:"parentIDHeaderName,omitempty" toml:"parentIDHeaderName,omitempty" yaml:"parentIDHeaderName,omitempty" export:"true"`
|
||||||
SpanIDHeaderName string `description:"Specifies the header name that will be used to store the span ID." json:"spanIDHeaderName,omitempty" toml:"spanIDHeaderName,omitempty" yaml:"spanIDHeaderName,omitempty" export:"true"`
|
SpanIDHeaderName string `description:"Sets the header name used to store the span ID." json:"spanIDHeaderName,omitempty" toml:"spanIDHeaderName,omitempty" yaml:"spanIDHeaderName,omitempty" export:"true"`
|
||||||
BaggagePrefixHeaderName string `description:"Specifies the header name prefix that will be used to store baggage items in a map." json:"baggagePrefixHeaderName,omitempty" toml:"baggagePrefixHeaderName,omitempty" yaml:"baggagePrefixHeaderName,omitempty" export:"true"`
|
BaggagePrefixHeaderName string `description:"Sets the header name prefix used to store baggage items in a map." json:"baggagePrefixHeaderName,omitempty" toml:"baggagePrefixHeaderName,omitempty" yaml:"baggagePrefixHeaderName,omitempty" export:"true"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetDefaults sets the default values.
|
// SetDefaults sets the default values.
|
||||||
|
|
|
@ -13,9 +13,9 @@ const Name = "instana"
|
||||||
|
|
||||||
// Config provides configuration settings for a instana tracer.
|
// Config provides configuration settings for a instana tracer.
|
||||||
type Config struct {
|
type Config struct {
|
||||||
LocalAgentHost string `description:"Set instana-agent's host that the reporter will used." json:"localAgentHost,omitempty" toml:"localAgentHost,omitempty" yaml:"localAgentHost,omitempty"`
|
LocalAgentHost string `description:"Sets the Instana Agent host." json:"localAgentHost,omitempty" toml:"localAgentHost,omitempty" yaml:"localAgentHost,omitempty"`
|
||||||
LocalAgentPort int `description:"Set instana-agent's port that the reporter will used." json:"localAgentPort,omitempty" toml:"localAgentPort,omitempty" yaml:"localAgentPort,omitempty"`
|
LocalAgentPort int `description:"Sets the Instana Agent port used." json:"localAgentPort,omitempty" toml:"localAgentPort,omitempty" yaml:"localAgentPort,omitempty"`
|
||||||
LogLevel string `description:"Set instana-agent's log level. ('error','warn','info','debug')" json:"logLevel,omitempty" toml:"logLevel,omitempty" yaml:"logLevel,omitempty" export:"true"`
|
LogLevel string `description:"Sets the log level for the Instana tracer. ('error','warn','info','debug')" json:"logLevel,omitempty" toml:"logLevel,omitempty" yaml:"logLevel,omitempty" export:"true"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetDefaults sets the default values.
|
// SetDefaults sets the default values.
|
||||||
|
|
|
@ -17,15 +17,15 @@ const Name = "jaeger"
|
||||||
|
|
||||||
// Config provides configuration settings for a jaeger tracer.
|
// Config provides configuration settings for a jaeger tracer.
|
||||||
type Config struct {
|
type Config struct {
|
||||||
SamplingServerURL string `description:"Set the sampling server url." json:"samplingServerURL,omitempty" toml:"samplingServerURL,omitempty" yaml:"samplingServerURL,omitempty"`
|
SamplingServerURL string `description:"Sets the sampling server URL." json:"samplingServerURL,omitempty" toml:"samplingServerURL,omitempty" yaml:"samplingServerURL,omitempty"`
|
||||||
SamplingType string `description:"Set the sampling type." json:"samplingType,omitempty" toml:"samplingType,omitempty" yaml:"samplingType,omitempty" export:"true"`
|
SamplingType string `description:"Sets the sampling type." json:"samplingType,omitempty" toml:"samplingType,omitempty" yaml:"samplingType,omitempty" export:"true"`
|
||||||
SamplingParam float64 `description:"Set the sampling parameter." json:"samplingParam,omitempty" toml:"samplingParam,omitempty" yaml:"samplingParam,omitempty" export:"true"`
|
SamplingParam float64 `description:"Sets the sampling parameter." json:"samplingParam,omitempty" toml:"samplingParam,omitempty" yaml:"samplingParam,omitempty" export:"true"`
|
||||||
LocalAgentHostPort string `description:"Set jaeger-agent's host:port that the reporter will used." json:"localAgentHostPort,omitempty" toml:"localAgentHostPort,omitempty" yaml:"localAgentHostPort,omitempty"`
|
LocalAgentHostPort string `description:"Sets the Jaeger Agent host:port." json:"localAgentHostPort,omitempty" toml:"localAgentHostPort,omitempty" yaml:"localAgentHostPort,omitempty"`
|
||||||
Gen128Bit bool `description:"Generate 128 bit span IDs." json:"gen128Bit,omitempty" toml:"gen128Bit,omitempty" yaml:"gen128Bit,omitempty" export:"true"`
|
Gen128Bit bool `description:"Generates 128 bits span IDs." json:"gen128Bit,omitempty" toml:"gen128Bit,omitempty" yaml:"gen128Bit,omitempty" export:"true"`
|
||||||
Propagation string `description:"Which propagation format to use (jaeger/b3)." json:"propagation,omitempty" toml:"propagation,omitempty" yaml:"propagation,omitempty" export:"true"`
|
Propagation string `description:"Sets the propagation format (jaeger/b3)." json:"propagation,omitempty" toml:"propagation,omitempty" yaml:"propagation,omitempty" export:"true"`
|
||||||
TraceContextHeaderName string `description:"Set the header to use for the trace-id." json:"traceContextHeaderName,omitempty" toml:"traceContextHeaderName,omitempty" yaml:"traceContextHeaderName,omitempty" export:"true"`
|
TraceContextHeaderName string `description:"Sets the header name used to store the trace ID." json:"traceContextHeaderName,omitempty" toml:"traceContextHeaderName,omitempty" yaml:"traceContextHeaderName,omitempty" export:"true"`
|
||||||
Collector *Collector `description:"Define the collector information" json:"collector,omitempty" toml:"collector,omitempty" yaml:"collector,omitempty" export:"true"`
|
Collector *Collector `description:"Defines the collector information." json:"collector,omitempty" toml:"collector,omitempty" yaml:"collector,omitempty" export:"true"`
|
||||||
DisableAttemptReconnecting bool `description:"Disable the periodic re-resolution of the agent's hostname and reconnection if there was a change." json:"disableAttemptReconnecting,omitempty" toml:"disableAttemptReconnecting,omitempty" yaml:"disableAttemptReconnecting,omitempty" export:"true"`
|
DisableAttemptReconnecting bool `description:"Disables the periodic re-resolution of the agent's hostname and reconnection if there was a change." json:"disableAttemptReconnecting,omitempty" toml:"disableAttemptReconnecting,omitempty" yaml:"disableAttemptReconnecting,omitempty" export:"true"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetDefaults sets the default values.
|
// SetDefaults sets the default values.
|
||||||
|
|
|
@ -45,8 +45,8 @@ type Backend interface {
|
||||||
|
|
||||||
// Tracing middleware.
|
// Tracing middleware.
|
||||||
type Tracing struct {
|
type Tracing struct {
|
||||||
ServiceName string `description:"Set the name for this service" export:"true"`
|
ServiceName string `description:"Sets the name for this service" export:"true"`
|
||||||
SpanNameLimit int `description:"Set the maximum character limit for Span names (default 0 = no limit)" export:"true"`
|
SpanNameLimit int `description:"Sets the maximum character limit for span names (default 0 = no limit)" export:"true"`
|
||||||
|
|
||||||
tracer opentracing.Tracer
|
tracer opentracing.Tracer
|
||||||
closer io.Closer
|
closer io.Closer
|
||||||
|
|
|
@ -16,10 +16,10 @@ const Name = "zipkin"
|
||||||
|
|
||||||
// Config provides configuration settings for a zipkin tracer.
|
// Config provides configuration settings for a zipkin tracer.
|
||||||
type Config struct {
|
type Config struct {
|
||||||
HTTPEndpoint string `description:"HTTP Endpoint to report traces to." json:"httpEndpoint,omitempty" toml:"httpEndpoint,omitempty" yaml:"httpEndpoint,omitempty"`
|
HTTPEndpoint string `description:"Sets the HTTP Endpoint to report traces to." json:"httpEndpoint,omitempty" toml:"httpEndpoint,omitempty" yaml:"httpEndpoint,omitempty"`
|
||||||
SameSpan bool `description:"Use Zipkin SameSpan RPC style traces." json:"sameSpan,omitempty" toml:"sameSpan,omitempty" yaml:"sameSpan,omitempty" export:"true"`
|
SameSpan bool `description:"Uses SameSpan RPC style traces." json:"sameSpan,omitempty" toml:"sameSpan,omitempty" yaml:"sameSpan,omitempty" export:"true"`
|
||||||
ID128Bit bool `description:"Use Zipkin 128 bit root span IDs." json:"id128Bit,omitempty" toml:"id128Bit,omitempty" yaml:"id128Bit,omitempty" export:"true"`
|
ID128Bit bool `description:"Uses 128 bits root span IDs." json:"id128Bit,omitempty" toml:"id128Bit,omitempty" yaml:"id128Bit,omitempty" export:"true"`
|
||||||
SampleRate float64 `description:"The rate between 0.0 and 1.0 of requests to trace." json:"sampleRate,omitempty" toml:"sampleRate,omitempty" yaml:"sampleRate,omitempty" export:"true"`
|
SampleRate float64 `description:"Sets the rate between 0.0 and 1.0 of requests to trace." json:"sampleRate,omitempty" toml:"sampleRate,omitempty" yaml:"sampleRate,omitempty" export:"true"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetDefaults sets the default values.
|
// SetDefaults sets the default values.
|
||||||
|
|
Loading…
Reference in a new issue