package envoy.data.tap.v3

Get desktop application:
View/edit binary Protocol Buffers messages

Wrapper for tapped body data. This includes HTTP request/response body, transport socket received and transmitted data, etc.

Used in: HttpBufferedTrace.Message, HttpStreamedTraceSegment, SocketEvent.Read, SocketEvent.Write

• oneof body_type

  • bytes as_bytes = 1

    Body data as bytes. By default, tap body data will be present in this field, as the proto ``bytes`` type can contain any valid byte.

  • string as_string = 2

    Body data as string. This field is only used when the :ref:`JSON_BODY_AS_STRING <envoy_v3_api_enum_value_config.tap.v3.OutputSink.Format.JSON_BODY_AS_STRING>` sink format type is selected. See the documentation for that option for why this is useful.

• bool truncated = 3

  Specifies whether body data has been truncated to fit within the specified :ref:`max_buffered_rx_bytes <envoy_v3_api_field_config.tap.v3.OutputConfig.max_buffered_rx_bytes>` and :ref:`max_buffered_tx_bytes <envoy_v3_api_field_config.tap.v3.OutputConfig.max_buffered_tx_bytes>` settings.

Connection properties.

Used in: HttpBufferedTrace, SocketBufferedTrace, SocketEvent, SocketStreamedTraceSegment

• optional config.core.v3.Address local_address = 1

  Local address.

• optional config.core.v3.Address remote_address = 2

  Remote address.

A fully buffered HTTP trace message.

Used in: TraceWrapper

• optional HttpBufferedTrace.Message request = 1

  Request message.

• optional HttpBufferedTrace.Message response = 2

  Response message.

• optional Connection downstream_connection = 3

  downstream connection

HTTP message wrapper.

Used in: HttpBufferedTrace

• repeated config.core.v3.HeaderValue headers = 1

  Message headers.

• optional Body body = 2

  Message body.

• repeated config.core.v3.HeaderValue trailers = 3

  Message trailers.

• optional google.protobuf.Timestamp headers_received_time = 4

  The timestamp after receiving the message headers.

A streamed HTTP trace segment. Multiple segments make up a full trace. [#next-free-field: 8]

Used in: TraceWrapper

• uint64 trace_id = 1

  Trace ID unique to the originating Envoy only. Trace IDs can repeat and should not be used for long term stable uniqueness.

• oneof message_piece

  • config.core.v3.HeaderMap request_headers = 2

    Request headers.

  • Body request_body_chunk = 3

    Request body chunk.

  • config.core.v3.HeaderMap request_trailers = 4

    Request trailers.

  • config.core.v3.HeaderMap response_headers = 5

    Response headers.

  • Body response_body_chunk = 6

    Response body chunk.

  • config.core.v3.HeaderMap response_trailers = 7

    Response trailers.

Sequence of read/write events that constitute a buffered trace on a socket. [#next-free-field: 6]

Used in: TraceWrapper

• uint64 trace_id = 1

  Trace ID unique to the originating Envoy only. Trace IDs can repeat and should not be used for long term stable uniqueness. Matches connection IDs used in Envoy logs.

• optional Connection connection = 2

  Connection properties.

• repeated SocketEvent events = 3

  Sequence of observed events.

• bool read_truncated = 4

  Set to true if read events were truncated due to the :ref:`max_buffered_rx_bytes <envoy_v3_api_field_config.tap.v3.OutputConfig.max_buffered_rx_bytes>` setting.

• bool write_truncated = 5

  Set to true if write events were truncated due to the :ref:`max_buffered_tx_bytes <envoy_v3_api_field_config.tap.v3.OutputConfig.max_buffered_tx_bytes>` setting.

Event in a socket trace. [#next-free-field: 6]

Used in: SocketBufferedTrace, SocketStreamedTraceSegment

• optional google.protobuf.Timestamp timestamp = 1

  Timestamp for event.

• oneof event_selector

  Read or write with content as bytes string.

  • SocketEvent.Read read = 2

  • SocketEvent.Write write = 3

  • SocketEvent.Closed closed = 4

• optional Connection connection = 5

  Connection information per event

The connection was closed.

TODO(mattklein123): Close event type.

Used in: SocketEvent

(message has no fields)

Data read by Envoy from the transport socket.

TODO(htuch): Half-close for reads.

Used in: SocketEvent

• optional Body data = 1

  Binary data read.

Data written by Envoy to the transport socket.

Used in: SocketEvent

• optional Body data = 1

  Binary data written.

• bool end_stream = 2

  Stream was half closed after this write.

A streamed socket trace segment. Multiple segments make up a full trace.

Used in: TraceWrapper

• uint64 trace_id = 1

  Trace ID unique to the originating Envoy only. Trace IDs can repeat and should not be used for long term stable uniqueness. Matches connection IDs used in Envoy logs.

• oneof message_piece

  • Connection connection = 2

    Connection properties.

  • SocketEvent event = 3

    Socket event.

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.

Used in: service.tap.v3.StreamTapsRequest

• oneof trace

  • HttpBufferedTrace http_buffered_trace = 1

    An HTTP buffered tap trace.

  • HttpStreamedTraceSegment http_streamed_trace_segment = 2

    An HTTP streamed tap trace segment.

  • SocketBufferedTrace socket_buffered_trace = 3

    A socket buffered tap trace.

  • SocketStreamedTraceSegment socket_streamed_trace_segment = 4

    A socket streamed tap trace segment.