Transport tap data¶

Trace format for the tap transport socket extension. This dumps plain text read/write sequences on a socket.

data.tap.v3.Connection¶

Connection properties.

{
  "local_address": "{...}",
  "remote_address": "{...}"
}

Event in a socket trace.

{
  "timestamp": "{...}",
  "read": "{...}",
  "write": "{...}",
  "closed": "{...}"
}

read

(data.tap.v3.SocketEvent.Read) Read or write with content as bytes string.

Only one of read, write, closed may be set.

write

(data.tap.v3.SocketEvent.Write) Read or write with content as bytes string.

Only one of read, write, closed may be set.

closed

(data.tap.v3.SocketEvent.Closed) Read or write with content as bytes string.

Only one of read, write, closed may be set.

Data read by Envoy from the transport socket.

{
  "data": "{...}"
}

Data written by Envoy to the transport socket.

{
  "data": "{...}",
  "end_stream": "..."
}

The connection was closed.

{}

Sequence of read/write events that constitute a buffered trace on a socket.

{
  "trace_id": "...",
  "connection": "{...}",
  "events": [],
  "read_truncated": "...",
  "write_truncated": "..."
}

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.

read_truncated: (bool) Set to true if read events were truncated due to the max_buffered_rx_bytes setting.

write_truncated: (bool) Set to true if write events were truncated due to the max_buffered_tx_bytes setting.

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

{
  "trace_id": "...",
  "connection": "{...}",
  "event": "{...}"
}

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.

connection

(data.tap.v3.Connection) Connection properties.

Only one of connection, event may be set.

event

(data.tap.v3.SocketEvent) Socket event.

Only one of connection, event may be set.