Capture¶

config.transport_socket.capture.v2alpha.FileSink¶

[config.transport_socket.capture.v2alpha.FileSink proto]

File sink.

Warning

The current file sink implementation buffers the entire trace in memory prior to writing. This will OOM for long lived sockets and/or where there is a large amount of traffic on the socket.

{
  "path_prefix": "...",
  "format": "..."
}

path_prefix: (string) Path prefix. The output file will be of the form <path_prefix>_<id>.pb, where <id> is an identifier distinguishing the recorded trace for individual socket instances (the Envoy connection ID).

format: (config.transport_socket.capture.v2alpha.FileSink.Format)

Enum config.transport_socket.capture.v2alpha.FileSink.Format¶

[config.transport_socket.capture.v2alpha.FileSink.Format proto]

File format.

PROTO_BINARY: (DEFAULT) ⁣Binary proto format as per Trace.

PROTO_TEXT: ⁣Text proto format as per Trace.

config.transport_socket.capture.v2alpha.Capture¶

[config.transport_socket.capture.v2alpha.Capture proto]

Configuration for capture transport socket. This wraps another transport socket, providing the ability to interpose and record in plain text any traffic that is surfaced to Envoy.

{
  "file_sink": "{...}",
  "transport_socket": "{...}"
}

file_sink: (config.transport_socket.capture.v2alpha.FileSink) Trace is to be written to a file sink.

transport_socket: (core.TransportSocket) The underlying transport socket being wrapped.