tracing.proto

Package: tracing.options.gloo.solo.io

Types:

Source File: github.com/solo-io/gloo/projects/gloo/api/v1/options/tracing/tracing.proto

ListenerTracingSettings

Contains settings for configuring Envoy’s tracing capabilities at the listener level. See here for additional information on Envoy’s tracing capabilities. See here for additional information about configuring tracing with Gloo Edge.

"requestHeadersForTags": []string
"verbose": bool
"tracePercentages": .tracing.options.gloo.solo.io.TracePercentages
"zipkinConfig": .solo.io.envoy.config.trace.v3.ZipkinConfig
"datadogConfig": .solo.io.envoy.config.trace.v3.DatadogConfig
"environmentVariablesForTags": []tracing.options.gloo.solo.io.TracingTagEnvironmentVariable
"literalsForTags": []tracing.options.gloo.solo.io.TracingTagLiteral

Field Type Description
requestHeadersForTags []string Optional. If specified, Envoy will include the headers and header values for any matching request headers.
verbose bool Optional. If true, Envoy will include logs for streaming events. Default: false.
tracePercentages .tracing.options.gloo.solo.io.TracePercentages Requests can produce traces by random sampling or when the x-client-trace-id header is provided. TracePercentages defines the limits for random, forced, and overall tracing percentages.
zipkinConfig .solo.io.envoy.config.trace.v3.ZipkinConfig Only one of zipkinConfig or datadogConfig can be set.
datadogConfig .solo.io.envoy.config.trace.v3.DatadogConfig Only one of datadogConfig or zipkinConfig can be set.
environmentVariablesForTags []tracing.options.gloo.solo.io.TracingTagEnvironmentVariable Optional. If specified, Envoy will include the environment variables with the given tag as tracing tags.
literalsForTags []tracing.options.gloo.solo.io.TracingTagLiteral Optional. If specified, Envoy will include the literals with the given tag as tracing tags.

RouteTracingSettings

Contains settings for configuring Envoy’s tracing capabilities at the route level. Note: must also specify ListenerTracingSettings for the associated listener. See here for additional information on Envoy’s tracing capabilities. See here for additional information about configuring tracing with Gloo Edge.

"routeDescriptor": string
"tracePercentages": .tracing.options.gloo.solo.io.TracePercentages
"propagate": .google.protobuf.BoolValue

Field Type Description
routeDescriptor string Optional. If set, will be used to identify the route that produced the trace. Note that this value will be overridden if the “x-envoy-decorator-operation” header is passed.
tracePercentages .tracing.options.gloo.solo.io.TracePercentages Requests can produce traces by random sampling or when the x-client-trace-id header is provided. TracePercentages defines the limits for random, forced, and overall tracing percentages.
propagate .google.protobuf.BoolValue Optional. Default is true, If set to false, the tracing headers will not propagate to the upstream.

TracePercentages

Requests can produce traces by random sampling or when the x-client-trace-id header is provided. TracePercentages defines the limits for random, forced, and overall tracing percentages.

"clientSamplePercentage": .google.protobuf.FloatValue
"randomSamplePercentage": .google.protobuf.FloatValue
"overallSamplePercentage": .google.protobuf.FloatValue

Field Type Description
clientSamplePercentage .google.protobuf.FloatValue Percentage of requests that should produce traces when the x-client-trace-id header is provided. optional, defaults to 100.0 This should be a value between 0.0 and 100.0, with up to 6 significant digits.
randomSamplePercentage .google.protobuf.FloatValue Percentage of requests that should produce traces by random sampling. optional, defaults to 100.0 This should be a value between 0.0 and 100.0, with up to 6 significant digits.
overallSamplePercentage .google.protobuf.FloatValue Overall percentage of requests that should produce traces. optional, defaults to 100.0 This should be a value between 0.0 and 100.0, with up to 6 significant digits.

TracingTagEnvironmentVariable

Requests can produce traces with custom tags. TracingTagEnvironmentVariable defines an environment variable which gets added as custom tag.

"tag": string
"name": string
"defaultValue": string

Field Type Description
tag string Used to populate the tag name.
name string Environment variable name to obtain the value to populate the tag value.
defaultValue string When the environment variable is not found, the tag value will be populated with this default value if specified, otherwise no tag will be populated.

TracingTagLiteral

Requests can produce traces with custom tags. TracingTagLiteral defines a literal which gets added as custom tag.

"tag": string
"value": string

Field Type Description
tag string Used to populate the tag name.
value string Static literal value to populate the tag value.