Common TAP¶

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

data.tap.v2alpha.Connection¶

[data.tap.v2alpha.Connection proto]

Connection properties.

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

id: (uint64) Global unique connection ID for Envoy session. Matches connection IDs used in Envoy logs.

local_address: (core.Address) Local address.

remote_address: (core.Address) Remote address.

data.tap.v2alpha.Event¶

[data.tap.v2alpha.Event proto]

Event in a capture trace.

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

timestamp: (Timestamp) Timestamp for event.

read

(data.tap.v2alpha.Event.Read)

Only one of read, write may be set.

write

(data.tap.v2alpha.Event.Write)

Only one of read, write may be set.

data.tap.v2alpha.Event.Read¶

[data.tap.v2alpha.Event.Read proto]

Data read by Envoy from the transport socket.

{
  "data": "..."
}

data: (bytes) Binary data read.

data.tap.v2alpha.Event.Write¶

[data.tap.v2alpha.Event.Write proto]

Data written by Envoy to the transport socket.

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

data: (bytes) Binary data written.

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

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.

{
  "connection": "{...}",
  "events": []
}

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

events: (data.tap.v2alpha.Event) Sequence of observed events.