Skip to main content

Envoy Admin Interface

These settings can be used to enable the Envoy admin interface. The Envoy admin interface can be useful when debugging issues with Pomerium itself.

danger

Access to the admin interface must be carefully controlled.

Envoy Admin Address

Envoy Admin Address configures the listener address for the Envoy admin interface. If this setting is unset or empty, the Envoy admin interface will not be enabled.

How to configure

Config file keysEnvironment variablesType
envoy_admin_addressENVOY_ADMIN_ADDRESSstring

Example

envoy_admin_address: '127.0.0.1:29091'

Envoy Admin Access Log Path

Envoy Admin Access Log Path enables access logging for requests to the Envoy admin interface.

How to configure

Config file keysEnvironment variablesType
envoy_admin_access_log_pathENVOY_ADMIN_ACCESS_LOG_PATHstring

Example

envoy_admin_access_log_path: /var/log/pomerium/envoy-admin-access.log

Envoy Admin Profile Path

Envoy Admin Profile Path is the output path for CPU profiles taken via the Envoy admin interface.

How to configure

Config file keysEnvironment variablesType
envoy_admin_profile_pathENVOY_ADMIN_PROFILE_PATHstring
envoy_admin_access_log_path: /var/log/pomerium/envoy.prof
Feedback