Common tap extension configuration¶

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/common/tap/v2alpha/common.proto

extensions.common.tap.v3.CommonExtensionConfig¶

Common configuration for all tap extensions.

{
  "admin_config": "{...}",
  "static_config": "{...}"
}

admin_config

(extensions.common.tap.v3.AdminConfig) If specified, the tap filter will be configured via an admin handler.

Precisely one of admin_config, static_config must be set.

static_config

(config.tap.v3.TapConfig) If specified, the tap filter will be configured via a static configuration that cannot be changed.

Precisely one of admin_config, static_config must be set.

Configuration for the admin handler. See here for more information.

{
  "config_id": "..."
}

config_id: (string, REQUIRED) Opaque configuration ID. When requests are made to the admin handler, the passed opaque ID is matched to the configured filter opaque ID to determine which filter to configure.