From d28bcf24e5ed9f20bbd3b7ee2ad4c3d6eae90b28 Mon Sep 17 00:00:00 2001 From: Kevin Pollet Date: Wed, 29 Sep 2021 10:40:14 +0200 Subject: [PATCH] docs: reword tracing config descriptions to be consistent --- docs/content/observability/tracing/datadog.md | 11 ++-- docs/content/observability/tracing/elastic.md | 8 +-- .../content/observability/tracing/haystack.md | 21 +++--- docs/content/observability/tracing/instana.md | 16 ++--- docs/content/observability/tracing/jaeger.md | 35 ++++++---- docs/content/observability/tracing/zipkin.md | 10 +-- .../reference/static-configuration/cli-ref.md | 66 +++++++++---------- .../reference/static-configuration/env-ref.md | 66 +++++++++---------- pkg/tracing/datadog/datadog.go | 16 ++--- pkg/tracing/elastic/elastic.go | 6 +- pkg/tracing/haystack/haystack.go | 14 ++-- pkg/tracing/instana/instana.go | 6 +- pkg/tracing/jaeger/jaeger.go | 18 ++--- pkg/tracing/tracing.go | 4 +- pkg/tracing/zipkin/zipkin.go | 8 +-- 15 files changed, 156 insertions(+), 149 deletions(-) diff --git a/docs/content/observability/tracing/datadog.md b/docs/content/observability/tracing/datadog.md index 1b85ec32e..e325299d2 100644 --- a/docs/content/observability/tracing/datadog.md +++ b/docs/content/observability/tracing/datadog.md @@ -1,6 +1,6 @@ # Datadog -To enable the Datadog: +To enable the Datadog tracer: ```yaml tab="File (YAML)" tracing: @@ -20,7 +20,7 @@ tracing: _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)" tracing: @@ -42,7 +42,7 @@ tracing: _Optional, Default=false_ -Enable Datadog debug. +Enables Datadog debug. ```yaml tab="File (YAML)" tracing: @@ -64,7 +64,7 @@ tracing: _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)" tracing: @@ -86,7 +86,8 @@ tracing: _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. ```yaml tab="File (YAML)" diff --git a/docs/content/observability/tracing/elastic.md b/docs/content/observability/tracing/elastic.md index 16513c14a..ad73b230c 100644 --- a/docs/content/observability/tracing/elastic.md +++ b/docs/content/observability/tracing/elastic.md @@ -1,6 +1,6 @@ # Elastic -To enable the Elastic: +To enable the Elastic tracer: ```yaml tab="File (YAML)" tracing: @@ -20,7 +20,7 @@ tracing: _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)" tracing: @@ -42,7 +42,7 @@ tracing: _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)" tracing: @@ -64,7 +64,7 @@ tracing: _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)" tracing: diff --git a/docs/content/observability/tracing/haystack.md b/docs/content/observability/tracing/haystack.md index 2b78f43fb..ebbbfa478 100644 --- a/docs/content/observability/tracing/haystack.md +++ b/docs/content/observability/tracing/haystack.md @@ -1,6 +1,6 @@ # Haystack -To enable the Haystack: +To enable the Haystack tracer: ```yaml tab="File (YAML)" tracing: @@ -18,9 +18,9 @@ tracing: #### `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)" tracing: @@ -40,9 +40,9 @@ tracing: #### `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)" tracing: @@ -64,7 +64,7 @@ tracing: _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)" tracing: @@ -86,7 +86,7 @@ tracing: _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)" tracing: @@ -108,7 +108,7 @@ tracing: _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)" tracing: @@ -130,7 +130,7 @@ tracing: _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)" tracing: @@ -152,7 +152,7 @@ tracing: _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)" tracing: @@ -166,7 +166,6 @@ tracing: baggagePrefixHeaderName = "sample" ``` - ```bash tab="CLI" --tracing.haystack.baggagePrefixHeaderName=sample ``` diff --git a/docs/content/observability/tracing/instana.md b/docs/content/observability/tracing/instana.md index e9eac66cf..e74b88bec 100644 --- a/docs/content/observability/tracing/instana.md +++ b/docs/content/observability/tracing/instana.md @@ -1,6 +1,6 @@ # Instana -To enable the Instana: +To enable the Instana tracer: ```yaml tab="File (YAML)" tracing: @@ -18,9 +18,9 @@ tracing: #### `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)" tracing: @@ -40,9 +40,9 @@ tracing: #### `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)" tracing: @@ -62,11 +62,11 @@ tracing: #### `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` - `warn` diff --git a/docs/content/observability/tracing/jaeger.md b/docs/content/observability/tracing/jaeger.md index 05ef53dab..cf98f0312 100644 --- a/docs/content/observability/tracing/jaeger.md +++ b/docs/content/observability/tracing/jaeger.md @@ -1,6 +1,6 @@ # Jaeger -To enable the Jaeger: +To enable the Jaeger tracer: ```yaml tab="File (YAML)" tracing: @@ -27,7 +27,7 @@ tracing: _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)" tracing: @@ -49,7 +49,13 @@ tracing: _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)" tracing: @@ -71,9 +77,9 @@ tracing: _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 `probabilistic` sampler, a probability between 0 and 1 @@ -99,7 +105,7 @@ tracing: _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)" tracing: @@ -121,7 +127,7 @@ tracing: _Optional, Default=false_ -Generate 128-bit trace IDs, compatible with OpenCensus. +Generates 128 bits trace IDs, compatible with OpenCensus. ```yaml tab="File (YAML)" tracing: @@ -143,8 +149,9 @@ tracing: _Required, Default="jaeger"_ -Set the propagation header type. -This can be either: +Sets the propagation header type. + +Valid values are: - `jaeger`, jaeger's default trace header. - `b3`, compatible with OpenZipkin @@ -169,7 +176,7 @@ tracing: _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. ```yaml tab="File (YAML)" @@ -192,7 +199,7 @@ tracing: _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. ```yaml tab="File (YAML)" @@ -216,7 +223,7 @@ tracing: _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)" tracing: @@ -239,7 +246,7 @@ tracing: _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)" tracing: @@ -262,7 +269,7 @@ tracing: _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)" tracing: diff --git a/docs/content/observability/tracing/zipkin.md b/docs/content/observability/tracing/zipkin.md index 9b8eff9e1..82d8cdfcd 100644 --- a/docs/content/observability/tracing/zipkin.md +++ b/docs/content/observability/tracing/zipkin.md @@ -1,6 +1,6 @@ # Zipkin -To enable the Zipkin: +To enable the Zipkin tracer: ```yaml tab="File (YAML)" tracing: @@ -20,7 +20,7 @@ tracing: _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)" tracing: @@ -42,7 +42,7 @@ tracing: _Optional, Default=false_ -Use Zipkin SameSpan RPC style traces. +Uses SameSpan RPC style traces. ```yaml tab="File (YAML)" tracing: @@ -64,7 +64,7 @@ tracing: _Optional, Default=true_ -Use Zipkin 128 bit trace IDs. +Uses 128 bits trace IDs. ```yaml tab="File (YAML)" tracing: @@ -86,7 +86,7 @@ tracing: _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)" tracing: diff --git a/docs/content/reference/static-configuration/cli-ref.md b/docs/content/reference/static-configuration/cli-ref.md index e5068eb57..51fe21ef5 100644 --- a/docs/content/reference/static-configuration/cli-ref.md +++ b/docs/content/reference/static-configuration/cli-ref.md @@ -859,76 +859,76 @@ OpenTracing configuration. (Default: ```false```) Settings for Datadog. (Default: ```false```) `--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`: -Enable Datadog debug. (Default: ```false```) +Enables Datadog debug. (Default: ```false```) `--tracing.datadog.globaltag`: -Key:Value tag to be set on all the spans. +Sets a key:value tag on all spans. `--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`: -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`: -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`: -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`: -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`: Settings for Elastic. (Default: ```false```) `--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`: -Set the URL of the Elastic APM server. +Sets the URL of the Elastic APM server. `--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`: Settings for Haystack. (Default: ```false```) `--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`: -Key:Value tag to be set on all the spans. +Sets a key:value tag on all spans. `--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`: -Set haystack-agent's port that the reporter will used. (Default: ```35000```) +Sets the Haystack Agent port. (Default: ```35000```) `--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`: -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`: -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`: Settings for Instana. (Default: ```false```) `--tracing.instana.localagenthost`: -Set instana-agent's host that the reporter will used. +Sets the Instana Agent host. `--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`: -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`: 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. `--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`: -Generate 128 bit span IDs. (Default: ```false```) +Generates 128 bits span IDs. (Default: ```false```) `--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`: -Which propagation format to use (jaeger/b3). (Default: ```jaeger```) +Sets the propagation format (jaeger/b3). (Default: ```jaeger```) `--tracing.jaeger.samplingparam`: -Set the sampling parameter. (Default: ```1.000000```) +Sets the sampling parameter. (Default: ```1.000000```) `--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`: -Set the sampling type. (Default: ```const```) +Sets the sampling type. (Default: ```const```) `--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`: 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```) `--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`: -Use Zipkin 128 bit root span IDs. (Default: ```true```) +Uses 128 bits root span IDs. (Default: ```true```) `--tracing.zipkin.samespan`: -Use Zipkin SameSpan RPC style traces. (Default: ```false```) +Uses SameSpan RPC style traces. (Default: ```false```) `--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```) diff --git a/docs/content/reference/static-configuration/env-ref.md b/docs/content/reference/static-configuration/env-ref.md index 525f65f66..9d5d0b77c 100644 --- a/docs/content/reference/static-configuration/env-ref.md +++ b/docs/content/reference/static-configuration/env-ref.md @@ -859,76 +859,76 @@ OpenTracing configuration. (Default: ```false```) Settings for Datadog. (Default: ```false```) `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`: -Enable Datadog debug. (Default: ```false```) +Enables Datadog debug. (Default: ```false```) `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`: -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`: -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`: -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`: -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`: -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`: Settings for Elastic. (Default: ```false```) `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`: -Set the URL of the Elastic APM server. +Sets the URL of the Elastic APM server. `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`: Settings for Haystack. (Default: ```false```) `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`: -Key:Value tag to be set on all the spans. +Sets a key:value tag on all spans. `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`: -Set haystack-agent's port that the reporter will used. (Default: ```35000```) +Sets the Haystack Agent port. (Default: ```35000```) `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`: -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`: -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`: Settings for Instana. (Default: ```false```) `TRAEFIK_TRACING_INSTANA_LOCALAGENTHOST`: -Set instana-agent's host that the reporter will used. +Sets the Instana Agent host. `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`: -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`: 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. `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`: -Generate 128 bit span IDs. (Default: ```false```) +Generates 128 bits span IDs. (Default: ```false```) `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`: -Which propagation format to use (jaeger/b3). (Default: ```jaeger```) +Sets the propagation format (jaeger/b3). (Default: ```jaeger```) `TRAEFIK_TRACING_JAEGER_SAMPLINGPARAM`: -Set the sampling parameter. (Default: ```1.000000```) +Sets the sampling parameter. (Default: ```1.000000```) `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`: -Set the sampling type. (Default: ```const```) +Sets the sampling type. (Default: ```const```) `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`: 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```) `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`: -Use Zipkin 128 bit root span IDs. (Default: ```true```) +Uses 128 bits root span IDs. (Default: ```true```) `TRAEFIK_TRACING_ZIPKIN_SAMESPAN`: -Use Zipkin SameSpan RPC style traces. (Default: ```false```) +Uses SameSpan RPC style traces. (Default: ```false```) `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```) diff --git a/pkg/tracing/datadog/datadog.go b/pkg/tracing/datadog/datadog.go index 12c86c018..d3f44cb3b 100644 --- a/pkg/tracing/datadog/datadog.go +++ b/pkg/tracing/datadog/datadog.go @@ -17,14 +17,14 @@ const Name = "datadog" // Config provides configuration settings for a datadog tracer. 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"` - GlobalTag string `description:"Key:Value tag to be set on all the 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"` - 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"` - 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"` - 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"` - 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"` - 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"` + LocalAgentHostPort string `description:"Sets the Datadog Agent host:port." json:"localAgentHostPort,omitempty" toml:"localAgentHostPort,omitempty" yaml:"localAgentHostPort,omitempty"` + 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:"Enables Datadog debug." json:"debug,omitempty" toml:"debug,omitempty" yaml:"debug,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:"Sets the header name used to store the trace ID." json:"traceIDHeaderName,omitempty" toml:"traceIDHeaderName,omitempty" yaml:"traceIDHeaderName,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:"Sets the header name used to store the sampling priority." json:"samplingPriorityHeaderName,omitempty" toml:"samplingPriorityHeaderName,omitempty" yaml:"samplingPriorityHeaderName,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. diff --git a/pkg/tracing/elastic/elastic.go b/pkg/tracing/elastic/elastic.go index b80d2d14a..5fc018628 100644 --- a/pkg/tracing/elastic/elastic.go +++ b/pkg/tracing/elastic/elastic.go @@ -24,9 +24,9 @@ func init() { // Config provides configuration settings for a elastic.co tracer. type Config struct { - ServerURL string `description:"Set 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"` - 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"` + ServerURL string `description:"Sets the URL of the Elastic APM server." json:"serverURL,omitempty" toml:"serverURL,omitempty" yaml:"serverURL,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:"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. diff --git a/pkg/tracing/haystack/haystack.go b/pkg/tracing/haystack/haystack.go index b3b14988d..3990e58d2 100644 --- a/pkg/tracing/haystack/haystack.go +++ b/pkg/tracing/haystack/haystack.go @@ -15,13 +15,13 @@ const Name = "haystack" // Config provides configuration settings for a haystack tracer. 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"` - LocalAgentPort int `description:"Set haystack-agent's port that the reporter will used." 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"` - 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"` - 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"` - 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"` - 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"` + LocalAgentHost string `description:"Sets the Haystack Agent host." json:"localAgentHost,omitempty" toml:"localAgentHost,omitempty" yaml:"localAgentHost,omitempty"` + LocalAgentPort int `description:"Sets the Haystack Agent port." json:"localAgentPort,omitempty" toml:"localAgentPort,omitempty" yaml:"localAgentPort,omitempty"` + 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:"Sets the header name used to store the trace ID." json:"traceIDHeaderName,omitempty" toml:"traceIDHeaderName,omitempty" yaml:"traceIDHeaderName,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:"Sets the header name used to store the span ID." json:"spanIDHeaderName,omitempty" toml:"spanIDHeaderName,omitempty" yaml:"spanIDHeaderName,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. diff --git a/pkg/tracing/instana/instana.go b/pkg/tracing/instana/instana.go index 104ce6b11..ffa6ba2a0 100644 --- a/pkg/tracing/instana/instana.go +++ b/pkg/tracing/instana/instana.go @@ -13,9 +13,9 @@ const Name = "instana" // Config provides configuration settings for a instana tracer. 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"` - LocalAgentPort int `description:"Set instana-agent's port that the reporter will 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"` + LocalAgentHost string `description:"Sets the Instana Agent host." json:"localAgentHost,omitempty" toml:"localAgentHost,omitempty" yaml:"localAgentHost,omitempty"` + LocalAgentPort int `description:"Sets the Instana Agent port used." json:"localAgentPort,omitempty" toml:"localAgentPort,omitempty" yaml:"localAgentPort,omitempty"` + 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. diff --git a/pkg/tracing/jaeger/jaeger.go b/pkg/tracing/jaeger/jaeger.go index f28e08243..7e2858cc7 100644 --- a/pkg/tracing/jaeger/jaeger.go +++ b/pkg/tracing/jaeger/jaeger.go @@ -17,15 +17,15 @@ const Name = "jaeger" // Config provides configuration settings for a jaeger tracer. type Config struct { - SamplingServerURL string `description:"Set 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"` - SamplingParam float64 `description:"Set 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"` - Gen128Bit bool `description:"Generate 128 bit 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"` - TraceContextHeaderName string `description:"Set the header to use for 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"` - 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"` + SamplingServerURL string `description:"Sets the sampling server URL." json:"samplingServerURL,omitempty" toml:"samplingServerURL,omitempty" yaml:"samplingServerURL,omitempty"` + SamplingType string `description:"Sets the sampling type." json:"samplingType,omitempty" toml:"samplingType,omitempty" yaml:"samplingType,omitempty" export:"true"` + SamplingParam float64 `description:"Sets the sampling parameter." json:"samplingParam,omitempty" toml:"samplingParam,omitempty" yaml:"samplingParam,omitempty" export:"true"` + LocalAgentHostPort string `description:"Sets the Jaeger Agent host:port." json:"localAgentHostPort,omitempty" toml:"localAgentHostPort,omitempty" yaml:"localAgentHostPort,omitempty"` + Gen128Bit bool `description:"Generates 128 bits span IDs." json:"gen128Bit,omitempty" toml:"gen128Bit,omitempty" yaml:"gen128Bit,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:"Sets the header name used to store the trace ID." json:"traceContextHeaderName,omitempty" toml:"traceContextHeaderName,omitempty" yaml:"traceContextHeaderName,omitempty" export:"true"` + Collector *Collector `description:"Defines the collector information." json:"collector,omitempty" toml:"collector,omitempty" yaml:"collector,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. diff --git a/pkg/tracing/tracing.go b/pkg/tracing/tracing.go index 498a26348..f951fc1a3 100644 --- a/pkg/tracing/tracing.go +++ b/pkg/tracing/tracing.go @@ -45,8 +45,8 @@ type Backend interface { // Tracing middleware. type Tracing struct { - ServiceName string `description:"Set the name for this service" export:"true"` - SpanNameLimit int `description:"Set the maximum character limit for Span names (default 0 = no limit)" export:"true"` + ServiceName string `description:"Sets the name for this service" export:"true"` + SpanNameLimit int `description:"Sets the maximum character limit for span names (default 0 = no limit)" export:"true"` tracer opentracing.Tracer closer io.Closer diff --git a/pkg/tracing/zipkin/zipkin.go b/pkg/tracing/zipkin/zipkin.go index 6a140aa76..96974a305 100644 --- a/pkg/tracing/zipkin/zipkin.go +++ b/pkg/tracing/zipkin/zipkin.go @@ -16,10 +16,10 @@ const Name = "zipkin" // Config provides configuration settings for a zipkin tracer. type Config struct { - HTTPEndpoint string `description:"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"` - ID128Bit bool `description:"Use Zipkin 128 bit 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"` + HTTPEndpoint string `description:"Sets the HTTP Endpoint to report traces to." json:"httpEndpoint,omitempty" toml:"httpEndpoint,omitempty" yaml:"httpEndpoint,omitempty"` + SameSpan bool `description:"Uses SameSpan RPC style traces." json:"sameSpan,omitempty" toml:"sameSpan,omitempty" yaml:"sameSpan,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:"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.