Project: Gloo (Orchestration & Management / API Gateway)
File: tracing.proto.sk.md

title: "tracing.proto" weight: 5 <!-- Code generated by solo-kit. DO NOT EDIT. --> Contains settings for configuring Envoy's tracing capabilities at the listener level. See for additional information on Envoy's tracing capabilities. See for additional information about configuring tracing with Gloo Edge. ```yaml "requestHeadersForTags": []google.protobuf.StringValue "verbose": .google.protobuf.BoolValue "tracePercentages": .tracing.options.gloo.solo.io.TracePercentages "zipkinConfig": .solo.io.envoy.config.trace.v3.ZipkinConfig "datadogConfig": .solo.io.envoy.config.trace.v3.DatadogConfig "openTelemetryConfig": .solo.io.envoy.config.trace.v3.OpenTelemetryConfig "openCensusConfig": .solo.io.envoy.config.trace.v3.OpenCensusConfig "environmentVariablesForTags": []tracing.options.gloo.solo.io.TracingTagEnvironmentVariable "literalsForTags": []tracing.options.gloo.solo.io.TracingTagLiteral ``` | Field | Type | Description | | -- | - | -- | | `requestHeadersForTags` | | Optional. If specified, Envoy will include the headers and header values for any matching request headers. | | `verbose` | | Optional. If true, Envoy will include logs for streaming events. Default: false. | | `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` | | Only one of `zipkinConfig`, `datadogConfig`, `openTelemetryConfig`, or `openCensusConfig` can be set. | | `datadogConfig` | | Only one of `datadogConfig`, `zipkinConfig`, `openTelemetryConfig`, or `openCensusConfig` can be set. | | `openTelemetryConfig` | | Only one of `openTelemetryConfig`, `zipkinConfig`, `datadogConfig`, or `openCensusConfig` can be set. | | `openCensusConfig` | | Only one of `openCensusConfig`, `zipkinConfig`, `datadogConfig`, or `openTelemetryConfig` can be set. | | `environmentVariablesForTags` | | Optional. If specified, Envoy will include the environment variables with the given tag as tracing tags. | | `literalsForTags` | | Optional. If specified, Envoy will include the literals with the given tag as tracing tags. | Contains settings for configuring Envoy's tracing capabilities at the route level. Note: must also specify ListenerTracingSettings for the associated listener. See for additional information on Envoy's tracing capabilities. See for additional information about configuring tracing with Gloo Edge. ```yaml "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` | | Requests can produce traces by random sampling or when the `x-client-trace-id` header is

TracePercentages defines the limits for random, forced, and overall tracing percentages. | | `propagate` | | Optional. Default is true, If set to false, the tracing headers will not propagate to the upstream. | 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. ```yaml "clientSamplePercentage": .google.protobuf.FloatValue "randomSamplePercentage": .google.protobuf.FloatValue "overallSamplePercentage": .google.protobuf.FloatValue ``` | Field | Type | Description | | -- | - | -- | | `clientSamplePercentage` | | 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` | | 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` | | 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. | Requests can produce traces with custom tags. TracingTagEnvironmentVariable defines an environment variable which gets added as custom tag. ```yaml "tag": .google.protobuf.StringValue "name": .google.protobuf.StringValue "defaultValue": .google.protobuf.StringValue ``` | Field | Type | Description | | -- | - | -- | | `tag` | | Used to populate the tag name. | | `name` | | Environment variable name to obtain the value to populate the tag value. | | `defaultValue` | | 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. | Requests can produce traces with custom tags. TracingTagLiteral defines a literal which gets added as custom tag. ```yaml "tag": .google.protobuf.StringValue "value": .google.protobuf.StringValue ``` | Field | Type | Description | | -- | - | -- | | `tag` | | Used to populate the tag name. | | `value` | | Static literal value to populate the tag value. | <!-- Start of HubSpot Embed Code --> <script type="text/javascript" id="hs-script-loader" async defer src="//js.hs-scripts.com/5130874.js"></script> <!-- End of HubSpot Embed Code -->