.. _envoy_api_file_envoy/data/tap/v2alpha/capture.proto: Common TAP ========== Trace capture format for the capture transport socket extension. This dumps plain text read/write sequences on a socket. .. _envoy_api_msg_data.tap.v2alpha.Connection: data.tap.v2alpha.Connection --------------------------- `[data.tap.v2alpha.Connection proto] `_ Connection properties. .. code-block:: json { "id": "...", "local_address": "{...}", "remote_address": "{...}" } .. _envoy_api_field_data.tap.v2alpha.Connection.id: id (`uint64 `_) Global unique connection ID for Envoy session. Matches connection IDs used in Envoy logs. .. _envoy_api_field_data.tap.v2alpha.Connection.local_address: local_address (:ref:`core.Address `) Local address. .. _envoy_api_field_data.tap.v2alpha.Connection.remote_address: remote_address (:ref:`core.Address `) Remote address. .. _envoy_api_msg_data.tap.v2alpha.Event: data.tap.v2alpha.Event ---------------------- `[data.tap.v2alpha.Event proto] `_ Event in a capture trace. .. code-block:: json { "timestamp": "{...}", "read": "{...}", "write": "{...}" } .. _envoy_api_field_data.tap.v2alpha.Event.timestamp: timestamp (`Timestamp `_) Timestamp for event. .. _envoy_api_field_data.tap.v2alpha.Event.read: read (:ref:`data.tap.v2alpha.Event.Read `) Only one of :ref:`read `, :ref:`write ` may be set. .. _envoy_api_field_data.tap.v2alpha.Event.write: write (:ref:`data.tap.v2alpha.Event.Write `) Only one of :ref:`read `, :ref:`write ` may be set. .. _envoy_api_msg_data.tap.v2alpha.Event.Read: data.tap.v2alpha.Event.Read --------------------------- `[data.tap.v2alpha.Event.Read proto] `_ Data read by Envoy from the transport socket. .. code-block:: json { "data": "..." } .. _envoy_api_field_data.tap.v2alpha.Event.Read.data: data (`bytes `_) Binary data read. .. _envoy_api_msg_data.tap.v2alpha.Event.Write: data.tap.v2alpha.Event.Write ---------------------------- `[data.tap.v2alpha.Event.Write proto] `_ Data written by Envoy to the transport socket. .. code-block:: json { "data": "...", "end_stream": "..." } .. _envoy_api_field_data.tap.v2alpha.Event.Write.data: data (`bytes `_) Binary data written. .. _envoy_api_field_data.tap.v2alpha.Event.Write.end_stream: end_stream (`bool `_) Stream was half closed after this write. .. _envoy_api_msg_data.tap.v2alpha.Trace: data.tap.v2alpha.Trace ---------------------- `[data.tap.v2alpha.Trace proto] `_ Sequence of read/write events that constitute a captured trace on a socket. Multiple Trace messages might be emitted for a given connection ID, with the sink (e.g. file set, network) responsible for later reassembly. .. code-block:: json { "connection": "{...}", "events": [] } .. _envoy_api_field_data.tap.v2alpha.Trace.connection: connection (:ref:`data.tap.v2alpha.Connection `) Connection properties. .. _envoy_api_field_data.tap.v2alpha.Trace.events: events (:ref:`data.tap.v2alpha.Event `) Sequence of observed events.