Tap¶

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:

config/transport_socket/tap/v2alpha/tap.proto

This extension may be referenced by the qualified name envoy.transport_sockets.tap

Note

This extension is functional but has not had substantial production burn time, use only with this caveat.

This extension is not hardened and should only be used in deployments where both the downstream and upstream are trusted.

Tip

This extension extends and can be used with the following extension categories:

extensions.transport_sockets.tap.v3.Tap¶

[extensions.transport_sockets.tap.v3.Tap proto]

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

{
  "common_config": "{...}",
  "transport_socket": "{...}"
}

common_config: (extensions.common.tap.v3.CommonExtensionConfig, REQUIRED) Common configuration for the tap transport socket.

transport_socket: (config.core.v3.TransportSocket, REQUIRED) The underlying transport socket being wrapped.