Transport tap data¶

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

data/tap/v2alpha/transport.proto

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": "{...}"
}

local_address: (config.core.v3.Address) Local address.

remote_address: (config.core.v3.Address) Remote address.

data.tap.v3.SocketEvent¶

[data.tap.v3.SocketEvent proto]

Event in a socket trace.

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

timestamp: (Timestamp) Timestamp for event.

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.tap.v3.SocketEvent.Read¶

[data.tap.v3.SocketEvent.Read proto]

Data read by Envoy from the transport socket.

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

data: (data.tap.v3.Body) Binary data read.

data.tap.v3.SocketEvent.Write¶

[data.tap.v3.SocketEvent.Write proto]

Data written by Envoy to the transport socket.

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

data: (data.tap.v3.Body) Binary data written.

end_stream: (bool) Stream was half closed after this write.

data.tap.v3.SocketEvent.Closed¶

[data.tap.v3.SocketEvent.Closed proto]

The connection was closed.

data.tap.v3.SocketBufferedTrace¶

[data.tap.v3.SocketBufferedTrace proto]

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.

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

events: (repeated data.tap.v3.SocketEvent) Sequence of observed events.

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.

data.tap.v3.SocketStreamedTraceSegment¶

[data.tap.v3.SocketStreamedTraceSegment proto]

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.