package envoy.service.status.v3

Get desktop application:
View/edit binary Protocol Buffers messages

CSDS is Client Status Discovery Service. It can be used to get the status of an xDS-compliant client from the management server's point of view. It can also be used to get the current xDS states directly from the client.

• rpc StreamClientStatus (stream ClientStatusRequest, stream ClientStatusResponse)

  csds.proto:29

• rpc FetchClientStatus (ClientStatusRequest, ClientStatusResponse)

  csds.proto:32

All xds configs for a particular client.

Used in: ClientStatusResponse

• optional config.core.v3.Node node = 1

  Node for a particular client.

• repeated PerXdsConfig xds_config = 2

  This field is deprecated in favor of generic_xds_configs which is much simpler and uniform in structure.

• repeated ClientConfig.GenericXdsConfig generic_xds_configs = 3

  Represents generic xDS config and the exact config structure depends on the type URL (like Cluster if it is CDS)

• string client_scope = 4

  For xDS clients, the scope in which the data is used. For example, gRPC indicates the data plane target or that the data is associated with gRPC server(s).

GenericXdsConfig is used to specify the config status and the dump of any xDS resource identified by their type URL. It is the generalized version of the now deprecated ListenersConfigDump, ClustersConfigDump etc [#next-free-field: 10]

Used in: ClientConfig

• string type_url = 1

  Type_url represents the fully qualified name of xDS resource type like envoy.v3.Cluster, envoy.v3.ClusterLoadAssignment etc.

• string name = 2

  Name of the xDS resource

• string version_info = 3

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

• optional google.protobuf.Any xds_config = 4

  The xDS resource config. Actual content depends on the type

• optional google.protobuf.Timestamp last_updated = 5

  Timestamp when the xDS resource was last updated

• ConfigStatus config_status = 6

  Per xDS resource config status. It is generated by management servers. It will not be present if the CSDS server is an xDS client.

• admin.v3.ClientResourceStatus client_status = 7

  Per xDS resource status from the view of a xDS client

• optional admin.v3.UpdateFailureState error_state = 8

  Set if the last update failed, cleared after the next successful update. The *error_state* field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty. [#not-implemented-hide:]

• bool is_static_resource = 9

  Is static resource is true if it is specified in the config supplied through the file at the startup.

Config status from a client-side view.

Used in: PerXdsConfig

• CLIENT_UNKNOWN = 0

  Config status is not available/unknown.

• CLIENT_REQUESTED = 1

  Client requested the config but hasn't received any config from management server yet.

• CLIENT_ACKED = 2

  Client received the config and replied with ACK.

• CLIENT_NACKED = 3

  Client received the config and replied with NACK. Notably, the attached config dump is not the NACKed version, but the most recent accepted one. If no config is accepted yet, the attached config dump will be empty.

• CLIENT_RECEIVED_ERROR = 4

  Client received an error from the control plane. The attached config dump is the most recent accepted one. If no config is accepted yet, the attached config dump will be empty.

Request for client status of clients identified by a list of NodeMatchers.

Used as request type in: ClientStatusDiscoveryService.FetchClientStatus, ClientStatusDiscoveryService.StreamClientStatus

• repeated type.matcher.v3.NodeMatcher node_matchers = 1

  Management server can use these match criteria to identify clients. The match follows OR semantics.

• optional config.core.v3.Node node = 2

  The node making the csds request.

• bool exclude_resource_contents = 3

  If true, the server will not include the resource contents in the response (i.e., the generic_xds_configs.xds_config field will not be populated). [#not-implemented-hide:]

Used as response type in: ClientStatusDiscoveryService.FetchClientStatus, ClientStatusDiscoveryService.StreamClientStatus

• repeated ClientConfig config = 1

  Client configs for the clients specified in the ClientStatusRequest.

Status of a config from a management server view.

Used in: ClientConfig.GenericXdsConfig, PerXdsConfig

• UNKNOWN = 0

  Status info is not available/unknown.

• SYNCED = 1

  Management server has sent the config to client and received ACK.

• NOT_SENT = 2

  Config is not sent.

• STALE = 3

  Management server has sent the config to client but hasn’t received ACK/NACK.

• ERROR = 4

  Management server has sent the config to client but received NACK. The attached config dump will be the latest config (the rejected one), since it is the persisted version in the management server.

Detailed config (per xDS) with status. [#next-free-field: 8]

Used in: ClientConfig

• ConfigStatus status = 1

  Config status generated by management servers. Will not be present if the CSDS server is an xDS client.

• ClientConfigStatus client_status = 7

  Client config status is populated by xDS clients. Will not be present if the CSDS server is an xDS server. No matter what the client config status is, xDS clients should always dump the most recent accepted xDS config. .. attention:: This field is deprecated. Use :ref:`ClientResourceStatus <envoy_v3_api_enum_admin.v3.ClientResourceStatus>` for per-resource config status instead.

• oneof per_xds_config

  • admin.v3.ListenersConfigDump listener_config = 2

  • admin.v3.ClustersConfigDump cluster_config = 3

  • admin.v3.RoutesConfigDump route_config = 4

  • admin.v3.ScopedRoutesConfigDump scoped_route_config = 5

  • admin.v3.EndpointsConfigDump endpoint_config = 6