.. _envoy_v3_api_file_envoy/data/tap/v3/transport.proto: Transport tap data ================== Trace format for the tap transport socket extension. This dumps plain text read/write sequences on a socket. .. _envoy_v3_api_msg_data.tap.v3.Connection: data.tap.v3.Connection ---------------------- `[data.tap.v3.Connection proto] `_ Connection properties. .. code-block:: json { "local_address": "{...}", "remote_address": "{...}" } .. _envoy_v3_api_field_data.tap.v3.Connection.local_address: local_address (:ref:`config.core.v3.Address `) Local address. .. _envoy_v3_api_field_data.tap.v3.Connection.remote_address: remote_address (:ref:`config.core.v3.Address `) Remote address. .. _envoy_v3_api_msg_data.tap.v3.SocketEvent: data.tap.v3.SocketEvent ----------------------- `[data.tap.v3.SocketEvent proto] `_ Event in a socket trace. .. code-block:: json { "timestamp": "{...}", "read": "{...}", "write": "{...}", "closed": "{...}" } .. _envoy_v3_api_field_data.tap.v3.SocketEvent.timestamp: timestamp (`Timestamp `_) Timestamp for event. .. _envoy_v3_api_field_data.tap.v3.SocketEvent.read: read (:ref:`data.tap.v3.SocketEvent.Read `) Read or write with content as bytes string. Only one of :ref:`read `, :ref:`write `, :ref:`closed ` may be set. .. _envoy_v3_api_field_data.tap.v3.SocketEvent.write: write (:ref:`data.tap.v3.SocketEvent.Write `) Read or write with content as bytes string. Only one of :ref:`read `, :ref:`write `, :ref:`closed ` may be set. .. _envoy_v3_api_field_data.tap.v3.SocketEvent.closed: closed (:ref:`data.tap.v3.SocketEvent.Closed `) Read or write with content as bytes string. Only one of :ref:`read `, :ref:`write `, :ref:`closed ` may be set. .. _envoy_v3_api_msg_data.tap.v3.SocketEvent.Read: data.tap.v3.SocketEvent.Read ---------------------------- `[data.tap.v3.SocketEvent.Read proto] `_ Data read by Envoy from the transport socket. .. code-block:: json { "data": "{...}" } .. _envoy_v3_api_field_data.tap.v3.SocketEvent.Read.data: data (:ref:`data.tap.v3.Body `) Binary data read. .. _envoy_v3_api_msg_data.tap.v3.SocketEvent.Write: data.tap.v3.SocketEvent.Write ----------------------------- `[data.tap.v3.SocketEvent.Write proto] `_ Data written by Envoy to the transport socket. .. code-block:: json { "data": "{...}", "end_stream": "..." } .. _envoy_v3_api_field_data.tap.v3.SocketEvent.Write.data: data (:ref:`data.tap.v3.Body `) Binary data written. .. _envoy_v3_api_field_data.tap.v3.SocketEvent.Write.end_stream: end_stream (`bool `_) Stream was half closed after this write. .. _envoy_v3_api_msg_data.tap.v3.SocketEvent.Closed: data.tap.v3.SocketEvent.Closed ------------------------------ `[data.tap.v3.SocketEvent.Closed proto] `_ The connection was closed. .. code-block:: json {} .. _envoy_v3_api_msg_data.tap.v3.SocketBufferedTrace: data.tap.v3.SocketBufferedTrace ------------------------------- `[data.tap.v3.SocketBufferedTrace proto] `_ Sequence of read/write events that constitute a buffered trace on a socket. .. code-block:: json { "trace_id": "...", "connection": "{...}", "events": [], "read_truncated": "...", "write_truncated": "..." } .. _envoy_v3_api_field_data.tap.v3.SocketBufferedTrace.trace_id: trace_id (`uint64 `_) 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. .. _envoy_v3_api_field_data.tap.v3.SocketBufferedTrace.connection: connection (:ref:`data.tap.v3.Connection `) Connection properties. .. _envoy_v3_api_field_data.tap.v3.SocketBufferedTrace.events: events (:ref:`data.tap.v3.SocketEvent `) Sequence of observed events. .. _envoy_v3_api_field_data.tap.v3.SocketBufferedTrace.read_truncated: read_truncated (`bool `_) Set to true if read events were truncated due to the :ref:`max_buffered_rx_bytes ` setting. .. _envoy_v3_api_field_data.tap.v3.SocketBufferedTrace.write_truncated: write_truncated (`bool `_) Set to true if write events were truncated due to the :ref:`max_buffered_tx_bytes ` setting. .. _envoy_v3_api_msg_data.tap.v3.SocketStreamedTraceSegment: data.tap.v3.SocketStreamedTraceSegment -------------------------------------- `[data.tap.v3.SocketStreamedTraceSegment proto] `_ A streamed socket trace segment. Multiple segments make up a full trace. .. code-block:: json { "trace_id": "...", "connection": "{...}", "event": "{...}" } .. _envoy_v3_api_field_data.tap.v3.SocketStreamedTraceSegment.trace_id: trace_id (`uint64 `_) 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. .. _envoy_v3_api_field_data.tap.v3.SocketStreamedTraceSegment.connection: connection (:ref:`data.tap.v3.Connection `) Connection properties. Only one of :ref:`connection `, :ref:`event ` may be set. .. _envoy_v3_api_field_data.tap.v3.SocketStreamedTraceSegment.event: event (:ref:`data.tap.v3.SocketEvent `) Socket event. Only one of :ref:`connection `, :ref:`event ` may be set.