MeshTrace

Overview Examples Configuration reference

Configuration

defaultobject

MeshTrace configuration.

Hide Child Parameters

backendsarray[object]

Only one of zipkin, datadog or openTelemetry can be used.

<= 1 items

Hide Child Parameters

datadogobject

Datadog backend configuration.

Hide Child Parameters

splitServiceboolean

Determines if datadog service name should be split based on traffic
direction and destination. For example, with splitService: true and a
backend service that communicates with a couple of databases, you would
get service names like backend_INBOUND, backend_OUTBOUND_db1, and
backend_OUTBOUND_db2 in Datadog.

Default:false

urlstringrequired

Address of Datadog collector, only host and port are allowed (no paths,
fragments etc.)

openTelemetryobject

OpenTelemetry backend configuration.

Hide Child Parameters

endpointstringrequired

Address of OpenTelemetry collector.

>= 1 characters

Example:otel-collector:4317

typestringrequired

Allowed values:ZipkinDatadogOpenTelemetry

zipkinobject

Zipkin backend configuration.

Hide Child Parameters

apiVersionstring

Version of the API.
https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/trace/v3/zipkin.proto#L66

Allowed values:httpJsonhttpProto

Default:httpJson

sharedSpanContextboolean

Determines whether client and server spans will share the same span
context.
https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/trace/v3/zipkin.proto#L63

Default:true

traceId128bitboolean

Generate 128bit traces.

Default:false

urlstringrequired

Address of Zipkin collector.

samplingobject

Sampling configuration.
Sampling is the process by which a decision is made on whether to
process/export a span or not.

Hide Child Parameters

clientAny Of

Target percentage of requests that will be force traced if the
‘x-client-trace-id’ header is set. Mirror of client_sampling in Envoy
https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L127-L133
Either int or decimal represented as string.
If not specified then the default value is 100.

Variant 1integer

overallAny Of

Target percentage of requests will be traced
after all other sampling checks have been applied (client, force tracing,
random sampling). This field functions as an upper limit on the total
configured sampling rate. For instance, setting client to 100
but overall to 1 will result in only 1% of client requests with
the appropriate headers to be force traced. Mirror of
overall_sampling in Envoy
https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L142-L150
Either int or decimal represented as string.
If not specified then the default value is 100.

Variant 1integer

randomAny Of

Target percentage of requests that will be randomly selected for trace
generation, if not requested by the client or not forced.
Mirror of random_sampling in Envoy
https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#L135-L140
Either int or decimal represented as string.
If not specified then the default value is 100.

Variant 1integer

tagsarray[object]

Custom tags configuration.
Only one of literal or header can be used.

Hide Child Parameters

headerobject

Tag taken from a header.

Hide Child Parameters

defaultstring

Default value to use if header is missing.
If the default is missing and there is no value the tag will not be
included.

namestringrequired

Name of the header.

literalstring

Tag taken from literal value.

namestringrequired

Name of the tag.

targetRefobject

TargetRef is a reference to the resource the policy takes an effect on.
The resource could be either a real store object or virtual resource
defined inplace.

Hide Child Parameters

kindstringrequired

Kind of the referenced resource

Allowed values:MeshMeshSubsetMeshGatewayMeshServiceMeshExternalServiceMeshMultiZoneServiceMeshServiceSubsetMeshHTTPRouteDataplane

labelsobject

Labels are used to select group of MeshServices that match labels. Either Labels or
Name and Namespace can be used.

meshstring

Mesh is reserved for future use to identify cross mesh resources.

namestring

Name of the referenced resource. Can only be used with kinds: MeshService,
MeshServiceSubset and MeshGatewayRoute

namespacestring

Namespace specifies the namespace of target resource. If empty only resources in policy namespace
will be targeted.

proxyTypesarray[string]

ProxyTypes specifies the data plane types that are subject to the policy. When not specified,
all data plane types are targeted by the policy.

Allowed values:SidecarGateway

sectionNamestring

SectionName is used to target specific section of resource.
For example, you can target port from MeshService.ports[] by its name. Only traffic to this port will be affected.

tagsobject

Tags used to select a subset of proxies by tags. Can only be used with kinds
MeshSubset and MeshServiceSubset

MeshTrace

Configuration

Did this doc help?

Help us make these docs great!

Still need help