Tap data wrappers (proto)

data.tap.v3.TraceWrapper

Wrapper for all fully buffered and streamed tap traces that Envoy emits. This is required for sending traces over gRPC APIs or more easily persisting binary messages to files.

{
  "http_buffered_trace": {...},
  "http_streamed_trace_segment": {...},
  "socket_buffered_trace": {...},
  "socket_streamed_trace_segment": {...},
  "configured_sample_rate": {...}
}

http_buffered_trace

(data.tap.v3.HttpBufferedTrace) An HTTP buffered tap trace.

Precisely one of http_buffered_trace, http_streamed_trace_segment, socket_buffered_trace, socket_streamed_trace_segment must be set.

http_streamed_trace_segment

(data.tap.v3.HttpStreamedTraceSegment) An HTTP streamed tap trace segment.

Precisely one of http_buffered_trace, http_streamed_trace_segment, socket_buffered_trace, socket_streamed_trace_segment must be set.

socket_buffered_trace

(data.tap.v3.SocketBufferedTrace) A socket buffered tap trace.

Precisely one of http_buffered_trace, http_streamed_trace_segment, socket_buffered_trace, socket_streamed_trace_segment must be set.

socket_streamed_trace_segment

(data.tap.v3.SocketStreamedTraceSegment) A socket streamed tap trace segment.

Precisely one of http_buffered_trace, http_streamed_trace_segment, socket_buffered_trace, socket_streamed_trace_segment must be set.

configured_sample_rate: (type.v3.FractionalPercent) The configured sample rate at the time this trace was admitted, sourced from the default_value of tap_enabled. For buffered output (where each TraceWrapper carries a complete trace) the rate is always present when sampling is configured. For streamed output (where a trace is split across multiple TraceWrapper segments) the rate is set on the first emitted segment only; subsequent segments belonging to the same trace can be joined to it via the trace_id carried on each inner segment message. Absent when sampling is unconfigured.

Note

When runtime_key is configured and an active runtime override is in effect, the effective sampling rate that admitted the trace may differ from the recorded configured value.