2
apiVersion: apiextensions.k8s.io/v1
3
kind: CustomResourceDefinition
6
controller-gen.kubebuilder.io/version: v0.14.0
7
name: meshtraces.kuma.io
14
listKind: MeshTraceList
19
- additionalPrinterColumns:
20
- jsonPath: .spec.targetRef.kind
23
- jsonPath: .spec.targetRef.name
32
APIVersion defines the versioned schema of this representation of an object.
33
Servers should convert recognized schemas to the latest internal value, and
34
may reject unrecognized values.
35
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
39
Kind is a string value representing the REST resource this object represents.
40
Servers may infer this from the endpoint the client submits requests to.
43
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
48
description: Spec is the specification of the Kuma MeshTrace resource.
51
description: MeshTrace configuration.
55
A one element array of backend definition.
56
Envoy allows configuring only 1 backend, so the natural way of
57
representing that would be just one object. Unfortunately due to the
58
reasons explained in MADR 009-tracing-policy this has to be a one element
61
description: Only one of zipkin, datadog or openTelemetry can
65
description: Datadog backend configuration.
70
Determines if datadog service name should be split based on traffic
71
direction and destination. For example, with `splitService: true` and a
72
`backend` service that communicates with a couple of databases, you would
73
get service names like `backend_INBOUND`, `backend_OUTBOUND_db1`, and
74
`backend_OUTBOUND_db2` in Datadog.
78
Address of Datadog collector, only host and port are allowed (no paths,
85
description: OpenTelemetry backend configuration.
88
description: Address of OpenTelemetry collector.
89
example: otel-collector:4317
102
description: Zipkin backend configuration.
108
https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/trace/v3/zipkin.proto
116
Determines whether client and server spans will share the same span
118
https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/trace/v3/zipkin.proto
122
description: Generate 128bit traces.
125
description: Address of Zipkin collector.
137
Sampling configuration.
138
Sampling is the process by which a decision is made on whether to
139
process/export a span or not.
147
Target percentage of requests that will be force traced if the
148
'x-client-trace-id' header is set. Mirror of client_sampling in Envoy
149
https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto
150
Either int or decimal represented as string.
151
x-kubernetes-int-or-string: true
158
Target percentage of requests will be traced
159
after all other sampling checks have been applied (client, force tracing,
160
random sampling). This field functions as an upper limit on the total
161
configured sampling rate. For instance, setting client_sampling to 100%
162
but overall_sampling to 1% will result in only 1% of client requests with
163
the appropriate headers to be force traced. Mirror of
164
overall_sampling in Envoy
165
https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto
166
Either int or decimal represented as string.
167
x-kubernetes-int-or-string: true
174
Target percentage of requests that will be randomly selected for trace
175
generation, if not requested by the client or not forced.
176
Mirror of random_sampling in Envoy
177
https://github.com/envoyproxy/envoy/blob/v1.22.0/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto
178
Either int or decimal represented as string.
179
x-kubernetes-int-or-string: true
183
Custom tags configuration. You can add custom tags to traces based on
184
headers or literal values.
187
Custom tags configuration.
188
Only one of literal or header can be used.
191
description: Tag taken from a header.
195
Default value to use if header is missing.
196
If the default is missing and there is no value the tag will not be
200
description: Name of the header.
206
description: Tag taken from literal value.
209
description: Name of the tag.
218
TargetRef is a reference to the resource the policy takes an effect on.
219
The resource could be either a real store object or virtual resource
223
description: Kind of the referenced resource
233
description: Mesh is reserved for future use to identify cross
238
Name of the referenced resource. Can only be used with kinds: `MeshService`,
239
`MeshServiceSubset` and `MeshGatewayRoute`
243
ProxyTypes specifies the data plane types that are subject to the policy. When not specified,
244
all data plane types are targeted by the policy.
253
additionalProperties:
256
Tags used to select a subset of proxies by tags. Can only be used with kinds
257
`MeshSubset` and `MeshServiceSubset`