package envoy.admin.v2alpha

Get desktop application:
View/edit binary Protocol Buffers messages

This message describes the bootstrap configuration that Envoy was started with. This includes any CLI overrides that were merged. Bootstrap configuration information can be used to recreate the static portions of an Envoy configuration by reusing the output as the bootstrap configuration for another Envoy.

• optional config.bootstrap.v2.Bootstrap bootstrap = 1

• optional google.protobuf.Timestamp last_updated = 2

  The timestamp when the BootstrapConfig was last updated.

Used in: Certificates

• repeated CertificateDetails ca_cert = 1

  Details of CA certificate.

• repeated CertificateDetails cert_chain = 2

  Details of Certificate Chain

[#next-free-field: 7]

Used in: Certificate

• string path = 1

  Path of the certificate.

• string serial_number = 2

  Certificate Serial Number.

• repeated SubjectAlternateName subject_alt_names = 3

  List of Subject Alternate names.

• uint64 days_until_expiration = 4

  Minimum of days until expiration of certificate and it's chain.

• optional google.protobuf.Timestamp valid_from = 5

  Indicates the time from which the certificate is valid.

• optional google.protobuf.Timestamp expiration_time = 6

  Indicates the time at which the certificate expires.

Proto representation of certificate details. Admin endpoint uses this wrapper for `/certs` to display certificate information. See :ref:`/certs <operations_admin_interface_certs>` for more information.

• repeated Certificate certificates = 1

  List of certificates known to an Envoy.

Details an individual cluster's current status. [#next-free-field: 6]

Used in: Clusters

• string name = 1

  Name of the cluster.

• bool added_via_api = 2

  Denotes whether this cluster was added via API or configured statically.

• optional type.Percent success_rate_ejection_threshold = 3

  The success rate threshold used in the last interval. If :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>` is *false*, all errors: externally and locally generated were used to calculate the threshold. If :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>` is *true*, only externally generated errors were used to calculate the threshold. The threshold is used to eject hosts based on their success rate. See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for details. Note: this field may be omitted in any of the three following cases: 1. There were not enough hosts with enough request volume to proceed with success rate based outlier ejection. 2. The threshold is computed to be < 0 because a negative value implies that there was no threshold for that interval. 3. Outlier detection is not enabled for this cluster.

• repeated HostStatus host_statuses = 4

  Mapping from host address to the host's current status.

• optional type.Percent local_origin_success_rate_ejection_threshold = 5

  The success rate threshold used in the last interval when only locally originated failures were taken into account and externally originated errors were treated as success. This field should be interpreted only when :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>` is *true*. The threshold is used to eject hosts based on their success rate. See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for details. Note: this field may be omitted in any of the three following cases: 1. There were not enough hosts with enough request volume to proceed with success rate based outlier ejection. 2. The threshold is computed to be < 0 because a negative value implies that there was no threshold for that interval. 3. Outlier detection is not enabled for this cluster.

Admin endpoint uses this wrapper for `/clusters` to display cluster status information. See :ref:`/clusters <operations_admin_interface_clusters>` for more information.

• repeated ClusterStatus cluster_statuses = 1

  Mapping from cluster name to each cluster's status.

Envoy's cluster manager fills this message with all currently known clusters. Cluster configuration information can be used to recreate an Envoy configuration by populating all clusters as static clusters or by returning them in a CDS response.

Used in: service.status.v2.PerXdsConfig

• string version_info = 1

  This is the :ref:`version_info <envoy_api_field_DiscoveryResponse.version_info>` in the last processed CDS discovery response. If there are only static bootstrap clusters, this field will be "".

• repeated ClustersConfigDump.StaticCluster static_clusters = 2

  The statically loaded cluster configs.

• repeated ClustersConfigDump.DynamicCluster dynamic_active_clusters = 3

  The dynamically loaded active clusters. These are clusters that are available to service data plane traffic.

• repeated ClustersConfigDump.DynamicCluster dynamic_warming_clusters = 4

  The dynamically loaded warming clusters. These are clusters that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming clusters should generally be discarded.

Describes a dynamically loaded cluster via the CDS API.

Used in: ClustersConfigDump

• string version_info = 1

  This is the per-resource version information. This version is currently taken from the :ref:`version_info <envoy_api_field_DiscoveryResponse.version_info>` field at the time that the cluster was loaded. In the future, discrete per-cluster versions may be supported by the API.

• optional google.protobuf.Any cluster = 2

  The cluster config.

• optional google.protobuf.Timestamp last_updated = 3

  The timestamp when the Cluster was last updated.

Describes a statically loaded cluster.

Used in: ClustersConfigDump

• optional google.protobuf.Any cluster = 1

  The cluster config.

• optional google.protobuf.Timestamp last_updated = 2

  The timestamp when the Cluster was last updated.

[#next-free-field: 29]

Used in: ServerInfo

• uint64 base_id = 1

  See :option:`--base-id` for details.

• uint32 concurrency = 2

  See :option:`--concurrency` for details.

• string config_path = 3

  See :option:`--config-path` for details.

• string config_yaml = 4

  See :option:`--config-yaml` for details.

• bool allow_unknown_static_fields = 5

  See :option:`--allow-unknown-static-fields` for details.

• bool reject_unknown_dynamic_fields = 26

  See :option:`--reject-unknown-dynamic-fields` for details.

• string admin_address_path = 6

  See :option:`--admin-address-path` for details.

• CommandLineOptions.IpVersion local_address_ip_version = 7

  See :option:`--local-address-ip-version` for details.

• string log_level = 8

  See :option:`--log-level` for details.

• string component_log_level = 9

  See :option:`--component-log-level` for details.

• string log_format = 10

  See :option:`--log-format` for details.

• bool log_format_escaped = 27

  See :option:`--log-format-escaped` for details.

• string log_path = 11

  See :option:`--log-path` for details.

• string service_cluster = 13

  See :option:`--service-cluster` for details.

• string service_node = 14

  See :option:`--service-node` for details.

• string service_zone = 15

  See :option:`--service-zone` for details.

• optional google.protobuf.Duration file_flush_interval = 16

  See :option:`--file-flush-interval-msec` for details.

• optional google.protobuf.Duration drain_time = 17

  See :option:`--drain-time-s` for details.

• optional google.protobuf.Duration parent_shutdown_time = 18

  See :option:`--parent-shutdown-time-s` for details.

• CommandLineOptions.Mode mode = 19

  See :option:`--mode` for details.

• uint64 max_stats = 20

  max_stats and max_obj_name_len are now unused and have no effect.

• uint64 max_obj_name_len = 21

• bool disable_hot_restart = 22

  See :option:`--disable-hot-restart` for details.

• bool enable_mutex_tracing = 23

  See :option:`--enable-mutex-tracing` for details.

• uint32 restart_epoch = 24

  See :option:`--restart-epoch` for details.

• bool cpuset_threads = 25

  See :option:`--cpuset-threads` for details.

• repeated string disabled_extensions = 28

  See :option:`--disable-extensions` for details.

Used in: CommandLineOptions

• v4 = 0

• v6 = 1

Used in: CommandLineOptions

• Serve = 0

  Validate configs and then serve traffic normally.

• Validate = 1

  Validate configs and exit.

• InitOnly = 2

  Completely load and initialize the config, and then exit without running the listener loop.

The :ref:`/config_dump <operations_admin_interface_config_dump>` admin endpoint uses this wrapper message to maintain and serve arbitrary configuration information from any component in Envoy.

• repeated google.protobuf.Any configs = 1

  This list is serialized and dumped in its entirety at the :ref:`/config_dump <operations_admin_interface_config_dump>` endpoint. The following configurations are currently supported and will be dumped in the order given below: * *bootstrap*: :ref:`BootstrapConfigDump <envoy_api_msg_admin.v2alpha.BootstrapConfigDump>` * *clusters*: :ref:`ClustersConfigDump <envoy_api_msg_admin.v2alpha.ClustersConfigDump>` * *listeners*: :ref:`ListenersConfigDump <envoy_api_msg_admin.v2alpha.ListenersConfigDump>` * *routes*: :ref:`RoutesConfigDump <envoy_api_msg_admin.v2alpha.RoutesConfigDump>` You can filter output with the resource and mask query parameters. See :ref:`/config_dump?resource={} <operations_admin_interface_config_dump_by_resource>`, :ref:`/config_dump?mask={} <operations_admin_interface_config_dump_by_mask>`, or :ref:`/config_dump?resource={},mask={} <operations_admin_interface_config_dump_by_resource_and_mask>` for more information.

Health status for a host. [#next-free-field: 7]

Used in: HostStatus

• bool failed_active_health_check = 1

  The host is currently failing active health checks.

• bool failed_outlier_check = 2

  The host is currently considered an outlier and has been ejected.

• bool failed_active_degraded_check = 4

  The host is currently being marked as degraded through active health checking.

• bool pending_dynamic_removal = 5

  The host has been removed from service discovery, but is being stabilized due to active health checking.

• bool pending_active_hc = 6

  The host has not yet been health checked.

• api.v2.core.HealthStatus eds_health_status = 3

  Health status as reported by EDS. Note: only HEALTHY and UNHEALTHY are currently supported here. [#comment:TODO(mrice32): pipe through remaining EDS health status possibilities.]

Current state of a particular host. [#next-free-field: 10]

Used in: ClusterStatus

• optional api.v2.core.Address address = 1

  Address of this host.

• repeated SimpleMetric stats = 2

  List of stats specific to this host.

• optional HostHealthStatus health_status = 3

  The host's current health status.

• optional type.Percent success_rate = 4

  Request success rate for this host over the last calculated interval. If :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>` is *false*, all errors: externally and locally generated were used in success rate calculation. If :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>` is *true*, only externally generated errors were used in success rate calculation. See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for details. Note: the message will not be present if host did not have enough request volume to calculate success rate or the cluster did not have enough hosts to run through success rate outlier ejection.

• uint32 weight = 5

  The host's weight. If not configured, the value defaults to 1.

• string hostname = 6

  The hostname of the host, if applicable.

• uint32 priority = 7

  The host's priority. If not configured, the value defaults to 0 (highest priority).

• optional type.Percent local_origin_success_rate = 8

  Request success rate for this host over the last calculated interval when only locally originated errors are taken into account and externally originated errors were treated as success. This field should be interpreted only when :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.OutlierDetection.split_external_local_origin_errors>` is *true*. See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for details. Note: the message will not be present if host did not have enough request volume to calculate success rate or the cluster did not have enough hosts to run through success rate outlier ejection.

• optional api.v2.core.Locality locality = 9

  locality of the host.

Details an individual listener's current status.

Used in: Listeners

• string name = 1

  Name of the listener

• optional api.v2.core.Address local_address = 2

  The actual local address that the listener is listening on. If a listener was configured to listen on port 0, then this address has the port that was allocated by the OS.

Admin endpoint uses this wrapper for `/listeners` to display listener status information. See :ref:`/listeners <operations_admin_interface_listeners>` for more information.

• repeated ListenerStatus listener_statuses = 1

  List of listener statuses.

Envoy's listener manager fills this message with all currently known listeners. Listener configuration information can be used to recreate an Envoy configuration by populating all listeners as static listeners or by returning them in a LDS response.

Used in: service.status.v2.PerXdsConfig

• string version_info = 1

  This is the :ref:`version_info <envoy_api_field_DiscoveryResponse.version_info>` in the last processed LDS discovery response. If there are only static bootstrap listeners, this field will be "".

• repeated ListenersConfigDump.StaticListener static_listeners = 2

  The statically loaded listener configs.

• repeated ListenersConfigDump.DynamicListener dynamic_listeners = 3

  State for any warming, active, or draining listeners.

Describes a dynamically loaded listener via the LDS API. [#next-free-field: 6]

Used in: ListenersConfigDump

• string name = 1

  The name or unique id of this listener, pulled from the DynamicListenerState config.

• optional DynamicListenerState active_state = 2

  The listener state for any active listener by this name. These are listeners that are available to service data plane traffic.

• optional DynamicListenerState warming_state = 3

  The listener state for any warming listener by this name. These are listeners that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming listeners should generally be discarded.

• optional DynamicListenerState draining_state = 4

  The listener state for any draining listener by this name. These are listeners that are currently undergoing draining in preparation to stop servicing data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the draining listeners should generally be discarded.

• optional UpdateFailureState error_state = 5

  Set if the last update failed, cleared after the next successful update.

Used in: DynamicListener

• string version_info = 1

  This is the per-resource version information. This version is currently taken from the :ref:`version_info <envoy_api_field_DiscoveryResponse.version_info>` field at the time that the listener was loaded. In the future, discrete per-listener versions may be supported by the API.

• optional google.protobuf.Any listener = 2

  The listener config.

• optional google.protobuf.Timestamp last_updated = 3

  The timestamp when the Listener was last successfully updated.

Describes a statically loaded listener.

Used in: ListenersConfigDump

• optional google.protobuf.Any listener = 1

  The listener config.

• optional google.protobuf.Timestamp last_updated = 2

  The timestamp when the Listener was last successfully updated.

Proto representation of the internal memory consumption of an Envoy instance. These represent values extracted from an internal TCMalloc instance. For more information, see the section of the docs entitled ["Generic Tcmalloc Status"](https://gperftools.github.io/gperftools/tcmalloc.html). [#next-free-field: 7]

• uint64 allocated = 1

  The number of bytes allocated by the heap for Envoy. This is an alias for `generic.current_allocated_bytes`.

• uint64 heap_size = 2

  The number of bytes reserved by the heap but not necessarily allocated. This is an alias for `generic.heap_size`.

• uint64 pageheap_unmapped = 3

  The number of bytes in free, unmapped pages in the page heap. These bytes always count towards virtual memory usage, and depending on the OS, typically do not count towards physical memory usage. This is an alias for `tcmalloc.pageheap_unmapped_bytes`.

• uint64 pageheap_free = 4

  The number of bytes in free, mapped pages in the page heap. These bytes always count towards virtual memory usage, and unless the underlying memory is swapped out by the OS, they also count towards physical memory usage. This is an alias for `tcmalloc.pageheap_free_bytes`.

• uint64 total_thread_cache = 5

  The amount of memory used by the TCMalloc thread caches (for small objects). This is an alias for `tcmalloc.current_total_thread_cache_bytes`.

• uint64 total_physical_bytes = 6

  The number of bytes of the physical memory usage by the allocator. This is an alias for `generic.total_physical_bytes`.

Proto representation of the statistics collected upon absl::Mutex contention, if Envoy is run under :option:`--enable-mutex-tracing`. For more information, see the `absl::Mutex` [docs](https://abseil.io/about/design/mutex#extra-features). *NB*: The wait cycles below are measured by `absl::base_internal::CycleClock`, and may not correspond to core clock frequency. For more information, see the `CycleClock` [docs](https://github.com/abseil/abseil-cpp/blob/master/absl/base/internal/cycleclock.h).

• uint64 num_contentions = 1

  The number of individual mutex contentions which have occurred since startup.

• uint64 current_wait_cycles = 2

  The length of the current contention wait cycle.

• uint64 lifetime_wait_cycles = 3

  The lifetime total of all contention wait cycles.

Envoy's RDS implementation fills this message with all currently loaded routes, as described by their RouteConfiguration objects. Static routes that are either defined in the bootstrap configuration or defined inline while configuring listeners are separated from those configured dynamically via RDS. Route configuration information can be used to recreate an Envoy configuration by populating all routes as static routes or by returning them in RDS responses.

Used in: service.status.v2.PerXdsConfig

• repeated RoutesConfigDump.StaticRouteConfig static_route_configs = 2

  The statically loaded route configs.

• repeated RoutesConfigDump.DynamicRouteConfig dynamic_route_configs = 3

  The dynamically loaded route configs.

Used in: RoutesConfigDump

• string version_info = 1

  This is the per-resource version information. This version is currently taken from the :ref:`version_info <envoy_api_field_DiscoveryResponse.version_info>` field at the time that the route configuration was loaded.

• optional google.protobuf.Any route_config = 2

  The route config.

• optional google.protobuf.Timestamp last_updated = 3

  The timestamp when the Route was last updated.

Used in: RoutesConfigDump

• optional google.protobuf.Any route_config = 1

  The route config.

• optional google.protobuf.Timestamp last_updated = 2

  The timestamp when the Route was last updated.

Envoy's scoped RDS implementation fills this message with all currently loaded route configuration scopes (defined via ScopedRouteConfigurationsSet protos). This message lists both the scopes defined inline with the higher order object (i.e., the HttpConnectionManager) and the dynamically obtained scopes via the SRDS API.

Used in: service.status.v2.PerXdsConfig

• repeated ScopedRoutesConfigDump.InlineScopedRouteConfigs inline_scoped_route_configs = 1

  The statically loaded scoped route configs.

• repeated ScopedRoutesConfigDump.DynamicScopedRouteConfigs dynamic_scoped_route_configs = 2

  The dynamically loaded scoped route configs.

Used in: ScopedRoutesConfigDump

• string name = 1

  The name assigned to the scoped route configurations.

• string version_info = 2

  This is the per-resource version information. This version is currently taken from the :ref:`version_info <envoy_api_field_DiscoveryResponse.version_info>` field at the time that the scoped routes configuration was loaded.

• repeated google.protobuf.Any scoped_route_configs = 3

  The scoped route configurations.

• optional google.protobuf.Timestamp last_updated = 4

  The timestamp when the scoped route config set was last updated.

Used in: ScopedRoutesConfigDump

• string name = 1

  The name assigned to the scoped route configurations.

• repeated google.protobuf.Any scoped_route_configs = 2

  The scoped route configurations.

• optional google.protobuf.Timestamp last_updated = 3

  The timestamp when the scoped route config set was last updated.

Envoys SDS implementation fills this message with all secrets fetched dynamically via SDS.

• repeated SecretsConfigDump.StaticSecret static_secrets = 1

  The statically loaded secrets.

• repeated SecretsConfigDump.DynamicSecret dynamic_active_secrets = 2

  The dynamically loaded active secrets. These are secrets that are available to service clusters or listeners.

• repeated SecretsConfigDump.DynamicSecret dynamic_warming_secrets = 3

  The dynamically loaded warming secrets. These are secrets that are currently undergoing warming in preparation to service clusters or listeners.

DynamicSecret contains secret information fetched via SDS.

Used in: SecretsConfigDump

• string name = 1

  The name assigned to the secret.

• string version_info = 2

  This is the per-resource version information.

• optional google.protobuf.Timestamp last_updated = 3

  The timestamp when the secret was last updated.

• optional google.protobuf.Any secret = 4

  The actual secret information. Security sensitive information is redacted (replaced with "[redacted]") for private keys and passwords in TLS certificates.

StaticSecret specifies statically loaded secret in bootstrap.

Used in: SecretsConfigDump

• string name = 1

  The name assigned to the secret.

• optional google.protobuf.Timestamp last_updated = 2

  The timestamp when the secret was last updated.

• optional google.protobuf.Any secret = 3

  The actual secret information. Security sensitive information is redacted (replaced with "[redacted]") for private keys and passwords in TLS certificates.

Proto representation of the value returned by /server_info, containing server version/server status information. [#next-free-field: 7]

• string version = 1

  Server version.

• ServerInfo.State state = 2

  State of the server.

• optional google.protobuf.Duration uptime_current_epoch = 3

  Uptime since current epoch was started.

• optional google.protobuf.Duration uptime_all_epochs = 4

  Uptime since the start of the first epoch.

• string hot_restart_version = 5

  Hot restart version.

• optional CommandLineOptions command_line_options = 6

  Command line options the server is currently running with.

Used in: ServerInfo

• LIVE = 0

  Server is live and serving traffic.

• DRAINING = 1

  Server is draining listeners in response to external health checks failing.

• PRE_INITIALIZING = 2

  Server has not yet completed cluster manager initialization.

• INITIALIZING = 3

  Server is running the cluster manager initialization callbacks (e.g., RDS).

Proto representation of an Envoy Counter or Gauge value.

Used in: HostStatus

• SimpleMetric.Type type = 1

  Type of the metric represented.

• uint64 value = 2

  Current metric value.

• string name = 3

  Name of the metric.

Used in: SimpleMetric

• COUNTER = 0

• GAUGE = 1

Used in: CertificateDetails

• oneof name

  Subject Alternate Name.

  • string dns = 1

  • string uri = 2

  • string ip_address = 3

The /tap admin request body that is used to configure an active tap session.

• string config_id = 1

  The opaque configuration ID used to match the configuration to a loaded extension. A tap extension configures a similar opaque ID that is used to match.

• optional service.tap.v2alpha.TapConfig tap_config = 2

  The tap configuration to load.

Used in: ListenersConfigDump.DynamicListener

• optional google.protobuf.Any failed_configuration = 1

  What the component configuration would have been if the update had succeeded.

• optional google.protobuf.Timestamp last_update_attempt = 2

  Time of the latest failed update attempt.

• string details = 3

  Details about the last failed update attempt.