go-control-plane: github.com/envoyproxy/go-control-plane/envoy/service/health/v4alpha Index | Files

package envoy_service_health_v4alpha

import "github.com/envoyproxy/go-control-plane/envoy/service/health/v4alpha"

Index

Package Files

hds.pb.go hds.pb.validate.go

Variables

var (
    Capability_Protocol_name = map[int32]string{
        0:  "HTTP",
        1:  "TCP",
        2:  "REDIS",
    }
    Capability_Protocol_value = map[string]int32{
        "HTTP":  0,
        "TCP":   1,
        "REDIS": 2,
    }
)

Enum value maps for Capability_Protocol.

var File_envoy_service_health_v4alpha_hds_proto protoreflect.FileDescriptor

func RegisterHealthDiscoveryServiceServer Uses

func RegisterHealthDiscoveryServiceServer(s *grpc.Server, srv HealthDiscoveryServiceServer)

type Capability Uses

type Capability struct {
    HealthCheckProtocols []Capability_Protocol `protobuf:"varint,1,rep,packed,name=health_check_protocols,json=healthCheckProtocols,proto3,enum=envoy.service.health.v4alpha.Capability_Protocol" json:"health_check_protocols,omitempty"`
    // contains filtered or unexported fields
}

Defines supported protocols etc, so the management server can assign proper endpoints to healthcheck.

func (*Capability) Descriptor Uses

func (*Capability) Descriptor() ([]byte, []int)

Deprecated: Use Capability.ProtoReflect.Descriptor instead.

func (*Capability) GetHealthCheckProtocols Uses

func (x *Capability) GetHealthCheckProtocols() []Capability_Protocol

func (*Capability) ProtoMessage Uses

func (*Capability) ProtoMessage()

func (*Capability) ProtoReflect Uses

func (x *Capability) ProtoReflect() protoreflect.Message

func (*Capability) Reset Uses

func (x *Capability) Reset()

func (*Capability) String Uses

func (x *Capability) String() string

func (*Capability) Validate Uses

func (m *Capability) Validate() error

Validate checks the field values on Capability with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type CapabilityValidationError Uses

type CapabilityValidationError struct {
    // contains filtered or unexported fields
}

CapabilityValidationError is the validation error returned by Capability.Validate if the designated constraints aren't met.

func (CapabilityValidationError) Cause Uses

func (e CapabilityValidationError) Cause() error

Cause function returns cause value.

func (CapabilityValidationError) Error Uses

func (e CapabilityValidationError) Error() string

Error satisfies the builtin error interface

func (CapabilityValidationError) ErrorName Uses

func (e CapabilityValidationError) ErrorName() string

ErrorName returns error name.

func (CapabilityValidationError) Field Uses

func (e CapabilityValidationError) Field() string

Field function returns field value.

func (CapabilityValidationError) Key Uses

func (e CapabilityValidationError) Key() bool

Key function returns key value.

func (CapabilityValidationError) Reason Uses

func (e CapabilityValidationError) Reason() string

Reason function returns reason value.

type Capability_Protocol Uses

type Capability_Protocol int32

Different Envoy instances may have different capabilities (e.g. Redis) and/or have ports enabled for different protocols.

const (
    Capability_HTTP  Capability_Protocol = 0
    Capability_TCP   Capability_Protocol = 1
    Capability_REDIS Capability_Protocol = 2
)

func (Capability_Protocol) Descriptor Uses

func (Capability_Protocol) Descriptor() protoreflect.EnumDescriptor

func (Capability_Protocol) Enum Uses

func (x Capability_Protocol) Enum() *Capability_Protocol

func (Capability_Protocol) EnumDescriptor Uses

func (Capability_Protocol) EnumDescriptor() ([]byte, []int)

Deprecated: Use Capability_Protocol.Descriptor instead.

func (Capability_Protocol) Number Uses

func (x Capability_Protocol) Number() protoreflect.EnumNumber

func (Capability_Protocol) String Uses

func (x Capability_Protocol) String() string

func (Capability_Protocol) Type Uses

func (Capability_Protocol) Type() protoreflect.EnumType

type ClusterEndpointsHealth Uses

type ClusterEndpointsHealth struct {
    ClusterName             string                     `protobuf:"bytes,1,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
    LocalityEndpointsHealth []*LocalityEndpointsHealth `protobuf:"bytes,2,rep,name=locality_endpoints_health,json=localityEndpointsHealth,proto3" json:"locality_endpoints_health,omitempty"`
    // contains filtered or unexported fields
}

The health status of endpoints in a cluster. The cluster name and locality should match the corresponding fields in ClusterHealthCheck message.

func (*ClusterEndpointsHealth) Descriptor Uses

func (*ClusterEndpointsHealth) Descriptor() ([]byte, []int)

Deprecated: Use ClusterEndpointsHealth.ProtoReflect.Descriptor instead.

func (*ClusterEndpointsHealth) GetClusterName Uses

func (x *ClusterEndpointsHealth) GetClusterName() string

func (*ClusterEndpointsHealth) GetLocalityEndpointsHealth Uses

func (x *ClusterEndpointsHealth) GetLocalityEndpointsHealth() []*LocalityEndpointsHealth

func (*ClusterEndpointsHealth) ProtoMessage Uses

func (*ClusterEndpointsHealth) ProtoMessage()

func (*ClusterEndpointsHealth) ProtoReflect Uses

func (x *ClusterEndpointsHealth) ProtoReflect() protoreflect.Message

func (*ClusterEndpointsHealth) Reset Uses

func (x *ClusterEndpointsHealth) Reset()

func (*ClusterEndpointsHealth) String Uses

func (x *ClusterEndpointsHealth) String() string

func (*ClusterEndpointsHealth) Validate Uses

func (m *ClusterEndpointsHealth) Validate() error

Validate checks the field values on ClusterEndpointsHealth with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ClusterEndpointsHealthValidationError Uses

type ClusterEndpointsHealthValidationError struct {
    // contains filtered or unexported fields
}

ClusterEndpointsHealthValidationError is the validation error returned by ClusterEndpointsHealth.Validate if the designated constraints aren't met.

func (ClusterEndpointsHealthValidationError) Cause Uses

func (e ClusterEndpointsHealthValidationError) Cause() error

Cause function returns cause value.

func (ClusterEndpointsHealthValidationError) Error Uses

func (e ClusterEndpointsHealthValidationError) Error() string

Error satisfies the builtin error interface

func (ClusterEndpointsHealthValidationError) ErrorName Uses

func (e ClusterEndpointsHealthValidationError) ErrorName() string

ErrorName returns error name.

func (ClusterEndpointsHealthValidationError) Field Uses

func (e ClusterEndpointsHealthValidationError) Field() string

Field function returns field value.

func (ClusterEndpointsHealthValidationError) Key Uses

func (e ClusterEndpointsHealthValidationError) Key() bool

Key function returns key value.

func (ClusterEndpointsHealthValidationError) Reason Uses

func (e ClusterEndpointsHealthValidationError) Reason() string

Reason function returns reason value.

type ClusterHealthCheck Uses

type ClusterHealthCheck struct {
    ClusterName       string                 `protobuf:"bytes,1,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
    HealthChecks      []*v4alpha.HealthCheck `protobuf:"bytes,2,rep,name=health_checks,json=healthChecks,proto3" json:"health_checks,omitempty"`
    LocalityEndpoints []*LocalityEndpoints   `protobuf:"bytes,3,rep,name=locality_endpoints,json=localityEndpoints,proto3" json:"locality_endpoints,omitempty"`
    // Optional map that gets filtered by :ref:`health_checks.transport_socket_match_criteria <envoy_api_field_config.core.v4alpha.HealthCheck.transport_socket_match_criteria>`
    // on connection when health checking. For more details, see
    // :ref:`config.cluster.v3.Cluster.transport_socket_matches <envoy_api_field_config.cluster.v4alpha.Cluster.transport_socket_matches>`.
    TransportSocketMatches []*v4alpha1.Cluster_TransportSocketMatch `protobuf:"bytes,4,rep,name=transport_socket_matches,json=transportSocketMatches,proto3" json:"transport_socket_matches,omitempty"`
    // contains filtered or unexported fields
}

The cluster name and locality is provided to Envoy for the endpoints that it health checks to support statistics reporting, logging and debugging by the Envoy instance (outside of HDS). For maximum usefulness, it should match the same cluster structure as that provided by EDS.

func (*ClusterHealthCheck) Descriptor Uses

func (*ClusterHealthCheck) Descriptor() ([]byte, []int)

Deprecated: Use ClusterHealthCheck.ProtoReflect.Descriptor instead.

func (*ClusterHealthCheck) GetClusterName Uses

func (x *ClusterHealthCheck) GetClusterName() string

func (*ClusterHealthCheck) GetHealthChecks Uses

func (x *ClusterHealthCheck) GetHealthChecks() []*v4alpha.HealthCheck

func (*ClusterHealthCheck) GetLocalityEndpoints Uses

func (x *ClusterHealthCheck) GetLocalityEndpoints() []*LocalityEndpoints

func (*ClusterHealthCheck) GetTransportSocketMatches Uses

func (x *ClusterHealthCheck) GetTransportSocketMatches() []*v4alpha1.Cluster_TransportSocketMatch

func (*ClusterHealthCheck) ProtoMessage Uses

func (*ClusterHealthCheck) ProtoMessage()

func (*ClusterHealthCheck) ProtoReflect Uses

func (x *ClusterHealthCheck) ProtoReflect() protoreflect.Message

func (*ClusterHealthCheck) Reset Uses

func (x *ClusterHealthCheck) Reset()

func (*ClusterHealthCheck) String Uses

func (x *ClusterHealthCheck) String() string

func (*ClusterHealthCheck) Validate Uses

func (m *ClusterHealthCheck) Validate() error

Validate checks the field values on ClusterHealthCheck with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ClusterHealthCheckValidationError Uses

type ClusterHealthCheckValidationError struct {
    // contains filtered or unexported fields
}

ClusterHealthCheckValidationError is the validation error returned by ClusterHealthCheck.Validate if the designated constraints aren't met.

func (ClusterHealthCheckValidationError) Cause Uses

func (e ClusterHealthCheckValidationError) Cause() error

Cause function returns cause value.

func (ClusterHealthCheckValidationError) Error Uses

func (e ClusterHealthCheckValidationError) Error() string

Error satisfies the builtin error interface

func (ClusterHealthCheckValidationError) ErrorName Uses

func (e ClusterHealthCheckValidationError) ErrorName() string

ErrorName returns error name.

func (ClusterHealthCheckValidationError) Field Uses

func (e ClusterHealthCheckValidationError) Field() string

Field function returns field value.

func (ClusterHealthCheckValidationError) Key Uses

func (e ClusterHealthCheckValidationError) Key() bool

Key function returns key value.

func (ClusterHealthCheckValidationError) Reason Uses

func (e ClusterHealthCheckValidationError) Reason() string

Reason function returns reason value.

type EndpointHealth Uses

type EndpointHealth struct {
    Endpoint     *v3.Endpoint         `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
    HealthStatus v4alpha.HealthStatus `protobuf:"varint,2,opt,name=health_status,json=healthStatus,proto3,enum=envoy.config.core.v4alpha.HealthStatus" json:"health_status,omitempty"`
    // contains filtered or unexported fields
}

func (*EndpointHealth) Descriptor Uses

func (*EndpointHealth) Descriptor() ([]byte, []int)

Deprecated: Use EndpointHealth.ProtoReflect.Descriptor instead.

func (*EndpointHealth) GetEndpoint Uses

func (x *EndpointHealth) GetEndpoint() *v3.Endpoint

func (*EndpointHealth) GetHealthStatus Uses

func (x *EndpointHealth) GetHealthStatus() v4alpha.HealthStatus

func (*EndpointHealth) ProtoMessage Uses

func (*EndpointHealth) ProtoMessage()

func (*EndpointHealth) ProtoReflect Uses

func (x *EndpointHealth) ProtoReflect() protoreflect.Message

func (*EndpointHealth) Reset Uses

func (x *EndpointHealth) Reset()

func (*EndpointHealth) String Uses

func (x *EndpointHealth) String() string

func (*EndpointHealth) Validate Uses

func (m *EndpointHealth) Validate() error

Validate checks the field values on EndpointHealth with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type EndpointHealthResponse Uses

type EndpointHealthResponse struct {

    // Deprecated - Flat list of endpoint health information.
    //
    // Deprecated: Do not use.
    HiddenEnvoyDeprecatedEndpointsHealth []*EndpointHealth `protobuf:"bytes,1,rep,name=hidden_envoy_deprecated_endpoints_health,json=hiddenEnvoyDeprecatedEndpointsHealth,proto3" json:"hidden_envoy_deprecated_endpoints_health,omitempty"`
    // Organize Endpoint health information by cluster.
    ClusterEndpointsHealth []*ClusterEndpointsHealth `protobuf:"bytes,2,rep,name=cluster_endpoints_health,json=clusterEndpointsHealth,proto3" json:"cluster_endpoints_health,omitempty"`
    // contains filtered or unexported fields
}

func (*EndpointHealthResponse) Descriptor Uses

func (*EndpointHealthResponse) Descriptor() ([]byte, []int)

Deprecated: Use EndpointHealthResponse.ProtoReflect.Descriptor instead.

func (*EndpointHealthResponse) GetClusterEndpointsHealth Uses

func (x *EndpointHealthResponse) GetClusterEndpointsHealth() []*ClusterEndpointsHealth

func (*EndpointHealthResponse) GetHiddenEnvoyDeprecatedEndpointsHealth Uses

func (x *EndpointHealthResponse) GetHiddenEnvoyDeprecatedEndpointsHealth() []*EndpointHealth

Deprecated: Do not use.

func (*EndpointHealthResponse) ProtoMessage Uses

func (*EndpointHealthResponse) ProtoMessage()

func (*EndpointHealthResponse) ProtoReflect Uses

func (x *EndpointHealthResponse) ProtoReflect() protoreflect.Message

func (*EndpointHealthResponse) Reset Uses

func (x *EndpointHealthResponse) Reset()

func (*EndpointHealthResponse) String Uses

func (x *EndpointHealthResponse) String() string

func (*EndpointHealthResponse) Validate Uses

func (m *EndpointHealthResponse) Validate() error

Validate checks the field values on EndpointHealthResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type EndpointHealthResponseValidationError Uses

type EndpointHealthResponseValidationError struct {
    // contains filtered or unexported fields
}

EndpointHealthResponseValidationError is the validation error returned by EndpointHealthResponse.Validate if the designated constraints aren't met.

func (EndpointHealthResponseValidationError) Cause Uses

func (e EndpointHealthResponseValidationError) Cause() error

Cause function returns cause value.

func (EndpointHealthResponseValidationError) Error Uses

func (e EndpointHealthResponseValidationError) Error() string

Error satisfies the builtin error interface

func (EndpointHealthResponseValidationError) ErrorName Uses

func (e EndpointHealthResponseValidationError) ErrorName() string

ErrorName returns error name.

func (EndpointHealthResponseValidationError) Field Uses

func (e EndpointHealthResponseValidationError) Field() string

Field function returns field value.

func (EndpointHealthResponseValidationError) Key Uses

func (e EndpointHealthResponseValidationError) Key() bool

Key function returns key value.

func (EndpointHealthResponseValidationError) Reason Uses

func (e EndpointHealthResponseValidationError) Reason() string

Reason function returns reason value.

type EndpointHealthValidationError Uses

type EndpointHealthValidationError struct {
    // contains filtered or unexported fields
}

EndpointHealthValidationError is the validation error returned by EndpointHealth.Validate if the designated constraints aren't met.

func (EndpointHealthValidationError) Cause Uses

func (e EndpointHealthValidationError) Cause() error

Cause function returns cause value.

func (EndpointHealthValidationError) Error Uses

func (e EndpointHealthValidationError) Error() string

Error satisfies the builtin error interface

func (EndpointHealthValidationError) ErrorName Uses

func (e EndpointHealthValidationError) ErrorName() string

ErrorName returns error name.

func (EndpointHealthValidationError) Field Uses

func (e EndpointHealthValidationError) Field() string

Field function returns field value.

func (EndpointHealthValidationError) Key Uses

func (e EndpointHealthValidationError) Key() bool

Key function returns key value.

func (EndpointHealthValidationError) Reason Uses

func (e EndpointHealthValidationError) Reason() string

Reason function returns reason value.

type HealthCheckRequest Uses

type HealthCheckRequest struct {
    Node       *v4alpha.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
    Capability *Capability   `protobuf:"bytes,2,opt,name=capability,proto3" json:"capability,omitempty"`
    // contains filtered or unexported fields
}

func (*HealthCheckRequest) Descriptor Uses

func (*HealthCheckRequest) Descriptor() ([]byte, []int)

Deprecated: Use HealthCheckRequest.ProtoReflect.Descriptor instead.

func (*HealthCheckRequest) GetCapability Uses

func (x *HealthCheckRequest) GetCapability() *Capability

func (*HealthCheckRequest) GetNode Uses

func (x *HealthCheckRequest) GetNode() *v4alpha.Node

func (*HealthCheckRequest) ProtoMessage Uses

func (*HealthCheckRequest) ProtoMessage()

func (*HealthCheckRequest) ProtoReflect Uses

func (x *HealthCheckRequest) ProtoReflect() protoreflect.Message

func (*HealthCheckRequest) Reset Uses

func (x *HealthCheckRequest) Reset()

func (*HealthCheckRequest) String Uses

func (x *HealthCheckRequest) String() string

func (*HealthCheckRequest) Validate Uses

func (m *HealthCheckRequest) Validate() error

Validate checks the field values on HealthCheckRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type HealthCheckRequestOrEndpointHealthResponse Uses

type HealthCheckRequestOrEndpointHealthResponse struct {

    // Types that are assignable to RequestType:
    //	*HealthCheckRequestOrEndpointHealthResponse_HealthCheckRequest
    //	*HealthCheckRequestOrEndpointHealthResponse_EndpointHealthResponse
    RequestType isHealthCheckRequestOrEndpointHealthResponse_RequestType `protobuf_oneof:"request_type"`
    // contains filtered or unexported fields
}

func (*HealthCheckRequestOrEndpointHealthResponse) Descriptor Uses

func (*HealthCheckRequestOrEndpointHealthResponse) Descriptor() ([]byte, []int)

Deprecated: Use HealthCheckRequestOrEndpointHealthResponse.ProtoReflect.Descriptor instead.

func (*HealthCheckRequestOrEndpointHealthResponse) GetEndpointHealthResponse Uses

func (x *HealthCheckRequestOrEndpointHealthResponse) GetEndpointHealthResponse() *EndpointHealthResponse

func (*HealthCheckRequestOrEndpointHealthResponse) GetHealthCheckRequest Uses

func (x *HealthCheckRequestOrEndpointHealthResponse) GetHealthCheckRequest() *HealthCheckRequest

func (*HealthCheckRequestOrEndpointHealthResponse) GetRequestType Uses

func (m *HealthCheckRequestOrEndpointHealthResponse) GetRequestType() isHealthCheckRequestOrEndpointHealthResponse_RequestType

func (*HealthCheckRequestOrEndpointHealthResponse) ProtoMessage Uses

func (*HealthCheckRequestOrEndpointHealthResponse) ProtoMessage()

func (*HealthCheckRequestOrEndpointHealthResponse) ProtoReflect Uses

func (x *HealthCheckRequestOrEndpointHealthResponse) ProtoReflect() protoreflect.Message

func (*HealthCheckRequestOrEndpointHealthResponse) Reset Uses

func (x *HealthCheckRequestOrEndpointHealthResponse) Reset()

func (*HealthCheckRequestOrEndpointHealthResponse) String Uses

func (x *HealthCheckRequestOrEndpointHealthResponse) String() string

func (*HealthCheckRequestOrEndpointHealthResponse) Validate Uses

func (m *HealthCheckRequestOrEndpointHealthResponse) Validate() error

Validate checks the field values on HealthCheckRequestOrEndpointHealthResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type HealthCheckRequestOrEndpointHealthResponseValidationError Uses

type HealthCheckRequestOrEndpointHealthResponseValidationError struct {
    // contains filtered or unexported fields
}

HealthCheckRequestOrEndpointHealthResponseValidationError is the validation error returned by HealthCheckRequestOrEndpointHealthResponse.Validate if the designated constraints aren't met.

func (HealthCheckRequestOrEndpointHealthResponseValidationError) Cause Uses

func (e HealthCheckRequestOrEndpointHealthResponseValidationError) Cause() error

Cause function returns cause value.

func (HealthCheckRequestOrEndpointHealthResponseValidationError) Error Uses

func (e HealthCheckRequestOrEndpointHealthResponseValidationError) Error() string

Error satisfies the builtin error interface

func (HealthCheckRequestOrEndpointHealthResponseValidationError) ErrorName Uses

func (e HealthCheckRequestOrEndpointHealthResponseValidationError) ErrorName() string

ErrorName returns error name.

func (HealthCheckRequestOrEndpointHealthResponseValidationError) Field Uses

func (e HealthCheckRequestOrEndpointHealthResponseValidationError) Field() string

Field function returns field value.

func (HealthCheckRequestOrEndpointHealthResponseValidationError) Key Uses

func (e HealthCheckRequestOrEndpointHealthResponseValidationError) Key() bool

Key function returns key value.

func (HealthCheckRequestOrEndpointHealthResponseValidationError) Reason Uses

func (e HealthCheckRequestOrEndpointHealthResponseValidationError) Reason() string

Reason function returns reason value.

type HealthCheckRequestOrEndpointHealthResponse_EndpointHealthResponse Uses

type HealthCheckRequestOrEndpointHealthResponse_EndpointHealthResponse struct {
    EndpointHealthResponse *EndpointHealthResponse `protobuf:"bytes,2,opt,name=endpoint_health_response,json=endpointHealthResponse,proto3,oneof"`
}

type HealthCheckRequestOrEndpointHealthResponse_HealthCheckRequest Uses

type HealthCheckRequestOrEndpointHealthResponse_HealthCheckRequest struct {
    HealthCheckRequest *HealthCheckRequest `protobuf:"bytes,1,opt,name=health_check_request,json=healthCheckRequest,proto3,oneof"`
}

type HealthCheckRequestValidationError Uses

type HealthCheckRequestValidationError struct {
    // contains filtered or unexported fields
}

HealthCheckRequestValidationError is the validation error returned by HealthCheckRequest.Validate if the designated constraints aren't met.

func (HealthCheckRequestValidationError) Cause Uses

func (e HealthCheckRequestValidationError) Cause() error

Cause function returns cause value.

func (HealthCheckRequestValidationError) Error Uses

func (e HealthCheckRequestValidationError) Error() string

Error satisfies the builtin error interface

func (HealthCheckRequestValidationError) ErrorName Uses

func (e HealthCheckRequestValidationError) ErrorName() string

ErrorName returns error name.

func (HealthCheckRequestValidationError) Field Uses

func (e HealthCheckRequestValidationError) Field() string

Field function returns field value.

func (HealthCheckRequestValidationError) Key Uses

func (e HealthCheckRequestValidationError) Key() bool

Key function returns key value.

func (HealthCheckRequestValidationError) Reason Uses

func (e HealthCheckRequestValidationError) Reason() string

Reason function returns reason value.

type HealthCheckSpecifier Uses

type HealthCheckSpecifier struct {
    ClusterHealthChecks []*ClusterHealthCheck `protobuf:"bytes,1,rep,name=cluster_health_checks,json=clusterHealthChecks,proto3" json:"cluster_health_checks,omitempty"`
    // The default is 1 second.
    Interval *duration.Duration `protobuf:"bytes,2,opt,name=interval,proto3" json:"interval,omitempty"`
    // contains filtered or unexported fields
}

func (*HealthCheckSpecifier) Descriptor Uses

func (*HealthCheckSpecifier) Descriptor() ([]byte, []int)

Deprecated: Use HealthCheckSpecifier.ProtoReflect.Descriptor instead.

func (*HealthCheckSpecifier) GetClusterHealthChecks Uses

func (x *HealthCheckSpecifier) GetClusterHealthChecks() []*ClusterHealthCheck

func (*HealthCheckSpecifier) GetInterval Uses

func (x *HealthCheckSpecifier) GetInterval() *duration.Duration

func (*HealthCheckSpecifier) ProtoMessage Uses

func (*HealthCheckSpecifier) ProtoMessage()

func (*HealthCheckSpecifier) ProtoReflect Uses

func (x *HealthCheckSpecifier) ProtoReflect() protoreflect.Message

func (*HealthCheckSpecifier) Reset Uses

func (x *HealthCheckSpecifier) Reset()

func (*HealthCheckSpecifier) String Uses

func (x *HealthCheckSpecifier) String() string

func (*HealthCheckSpecifier) Validate Uses

func (m *HealthCheckSpecifier) Validate() error

Validate checks the field values on HealthCheckSpecifier with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type HealthCheckSpecifierValidationError Uses

type HealthCheckSpecifierValidationError struct {
    // contains filtered or unexported fields
}

HealthCheckSpecifierValidationError is the validation error returned by HealthCheckSpecifier.Validate if the designated constraints aren't met.

func (HealthCheckSpecifierValidationError) Cause Uses

func (e HealthCheckSpecifierValidationError) Cause() error

Cause function returns cause value.

func (HealthCheckSpecifierValidationError) Error Uses

func (e HealthCheckSpecifierValidationError) Error() string

Error satisfies the builtin error interface

func (HealthCheckSpecifierValidationError) ErrorName Uses

func (e HealthCheckSpecifierValidationError) ErrorName() string

ErrorName returns error name.

func (HealthCheckSpecifierValidationError) Field Uses

func (e HealthCheckSpecifierValidationError) Field() string

Field function returns field value.

func (HealthCheckSpecifierValidationError) Key Uses

func (e HealthCheckSpecifierValidationError) Key() bool

Key function returns key value.

func (HealthCheckSpecifierValidationError) Reason Uses

func (e HealthCheckSpecifierValidationError) Reason() string

Reason function returns reason value.

type HealthDiscoveryServiceClient Uses

type HealthDiscoveryServiceClient interface {
    // 1. Envoy starts up and if its can_healthcheck option in the static
    //    bootstrap config is enabled, sends HealthCheckRequest to the management
    //    server. It supplies its capabilities (which protocol it can health check
    //    with, what zone it resides in, etc.).
    // 2. In response to (1), the management server designates this Envoy as a
    //    healthchecker to health check a subset of all upstream hosts for a given
    //    cluster (for example upstream Host 1 and Host 2). It streams
    //    HealthCheckSpecifier messages with cluster related configuration for all
    //    clusters this Envoy is designated to health check. Subsequent
    //    HealthCheckSpecifier message will be sent on changes to:
    //    a. Endpoints to health checks
    //    b. Per cluster configuration change
    // 3. Envoy creates a health probe based on the HealthCheck config and sends
    //    it to endpoint(ip:port) of Host 1 and 2. Based on the HealthCheck
    //    configuration Envoy waits upon the arrival of the probe response and
    //    looks at the content of the response to decide whether the endpoint is
    //    healthy or not. If a response hasn't been received within the timeout
    //    interval, the endpoint health status is considered TIMEOUT.
    // 4. Envoy reports results back in an EndpointHealthResponse message.
    //    Envoy streams responses as often as the interval configured by the
    //    management server in HealthCheckSpecifier.
    // 5. The management Server collects health statuses for all endpoints in the
    //    cluster (for all clusters) and uses this information to construct
    //    EndpointDiscoveryResponse messages.
    // 6. Once Envoy has a list of upstream endpoints to send traffic to, it load
    //    balances traffic to them without additional health checking. It may
    //    use inline healthcheck (i.e. consider endpoint UNHEALTHY if connection
    //    failed to a particular endpoint to account for health status propagation
    //    delay between HDS and EDS).
    // By default, can_healthcheck is true. If can_healthcheck is false, Cluster
    // configuration may not contain HealthCheck message.
    // TODO(htuch): How is can_healthcheck communicated to CDS to ensure the above
    // invariant?
    // TODO(htuch): Add @amb67's diagram.
    StreamHealthCheck(ctx context.Context, opts ...grpc.CallOption) (HealthDiscoveryService_StreamHealthCheckClient, error)
    // TODO(htuch): Unlike the gRPC version, there is no stream-based binding of
    // request/response. Should we add an identifier to the HealthCheckSpecifier
    // to bind with the response?
    FetchHealthCheck(ctx context.Context, in *HealthCheckRequestOrEndpointHealthResponse, opts ...grpc.CallOption) (*HealthCheckSpecifier, error)
}

HealthDiscoveryServiceClient is the client API for HealthDiscoveryService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewHealthDiscoveryServiceClient Uses

func NewHealthDiscoveryServiceClient(cc grpc.ClientConnInterface) HealthDiscoveryServiceClient

type HealthDiscoveryServiceServer Uses

type HealthDiscoveryServiceServer interface {
    // 1. Envoy starts up and if its can_healthcheck option in the static
    //    bootstrap config is enabled, sends HealthCheckRequest to the management
    //    server. It supplies its capabilities (which protocol it can health check
    //    with, what zone it resides in, etc.).
    // 2. In response to (1), the management server designates this Envoy as a
    //    healthchecker to health check a subset of all upstream hosts for a given
    //    cluster (for example upstream Host 1 and Host 2). It streams
    //    HealthCheckSpecifier messages with cluster related configuration for all
    //    clusters this Envoy is designated to health check. Subsequent
    //    HealthCheckSpecifier message will be sent on changes to:
    //    a. Endpoints to health checks
    //    b. Per cluster configuration change
    // 3. Envoy creates a health probe based on the HealthCheck config and sends
    //    it to endpoint(ip:port) of Host 1 and 2. Based on the HealthCheck
    //    configuration Envoy waits upon the arrival of the probe response and
    //    looks at the content of the response to decide whether the endpoint is
    //    healthy or not. If a response hasn't been received within the timeout
    //    interval, the endpoint health status is considered TIMEOUT.
    // 4. Envoy reports results back in an EndpointHealthResponse message.
    //    Envoy streams responses as often as the interval configured by the
    //    management server in HealthCheckSpecifier.
    // 5. The management Server collects health statuses for all endpoints in the
    //    cluster (for all clusters) and uses this information to construct
    //    EndpointDiscoveryResponse messages.
    // 6. Once Envoy has a list of upstream endpoints to send traffic to, it load
    //    balances traffic to them without additional health checking. It may
    //    use inline healthcheck (i.e. consider endpoint UNHEALTHY if connection
    //    failed to a particular endpoint to account for health status propagation
    //    delay between HDS and EDS).
    // By default, can_healthcheck is true. If can_healthcheck is false, Cluster
    // configuration may not contain HealthCheck message.
    // TODO(htuch): How is can_healthcheck communicated to CDS to ensure the above
    // invariant?
    // TODO(htuch): Add @amb67's diagram.
    StreamHealthCheck(HealthDiscoveryService_StreamHealthCheckServer) error
    // TODO(htuch): Unlike the gRPC version, there is no stream-based binding of
    // request/response. Should we add an identifier to the HealthCheckSpecifier
    // to bind with the response?
    FetchHealthCheck(context.Context, *HealthCheckRequestOrEndpointHealthResponse) (*HealthCheckSpecifier, error)
}

HealthDiscoveryServiceServer is the server API for HealthDiscoveryService service.

type HealthDiscoveryService_StreamHealthCheckClient Uses

type HealthDiscoveryService_StreamHealthCheckClient interface {
    Send(*HealthCheckRequestOrEndpointHealthResponse) error
    Recv() (*HealthCheckSpecifier, error)
    grpc.ClientStream
}

type HealthDiscoveryService_StreamHealthCheckServer Uses

type HealthDiscoveryService_StreamHealthCheckServer interface {
    Send(*HealthCheckSpecifier) error
    Recv() (*HealthCheckRequestOrEndpointHealthResponse, error)
    grpc.ServerStream
}

type LocalityEndpoints Uses

type LocalityEndpoints struct {
    Locality  *v4alpha.Locality `protobuf:"bytes,1,opt,name=locality,proto3" json:"locality,omitempty"`
    Endpoints []*v3.Endpoint    `protobuf:"bytes,2,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
    // contains filtered or unexported fields
}

func (*LocalityEndpoints) Descriptor Uses

func (*LocalityEndpoints) Descriptor() ([]byte, []int)

Deprecated: Use LocalityEndpoints.ProtoReflect.Descriptor instead.

func (*LocalityEndpoints) GetEndpoints Uses

func (x *LocalityEndpoints) GetEndpoints() []*v3.Endpoint

func (*LocalityEndpoints) GetLocality Uses

func (x *LocalityEndpoints) GetLocality() *v4alpha.Locality

func (*LocalityEndpoints) ProtoMessage Uses

func (*LocalityEndpoints) ProtoMessage()

func (*LocalityEndpoints) ProtoReflect Uses

func (x *LocalityEndpoints) ProtoReflect() protoreflect.Message

func (*LocalityEndpoints) Reset Uses

func (x *LocalityEndpoints) Reset()

func (*LocalityEndpoints) String Uses

func (x *LocalityEndpoints) String() string

func (*LocalityEndpoints) Validate Uses

func (m *LocalityEndpoints) Validate() error

Validate checks the field values on LocalityEndpoints with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type LocalityEndpointsHealth Uses

type LocalityEndpointsHealth struct {
    Locality        *v4alpha.Locality `protobuf:"bytes,1,opt,name=locality,proto3" json:"locality,omitempty"`
    EndpointsHealth []*EndpointHealth `protobuf:"bytes,2,rep,name=endpoints_health,json=endpointsHealth,proto3" json:"endpoints_health,omitempty"`
    // contains filtered or unexported fields
}

Group endpoint health by locality under each cluster.

func (*LocalityEndpointsHealth) Descriptor Uses

func (*LocalityEndpointsHealth) Descriptor() ([]byte, []int)

Deprecated: Use LocalityEndpointsHealth.ProtoReflect.Descriptor instead.

func (*LocalityEndpointsHealth) GetEndpointsHealth Uses

func (x *LocalityEndpointsHealth) GetEndpointsHealth() []*EndpointHealth

func (*LocalityEndpointsHealth) GetLocality Uses

func (x *LocalityEndpointsHealth) GetLocality() *v4alpha.Locality

func (*LocalityEndpointsHealth) ProtoMessage Uses

func (*LocalityEndpointsHealth) ProtoMessage()

func (*LocalityEndpointsHealth) ProtoReflect Uses

func (x *LocalityEndpointsHealth) ProtoReflect() protoreflect.Message

func (*LocalityEndpointsHealth) Reset Uses

func (x *LocalityEndpointsHealth) Reset()

func (*LocalityEndpointsHealth) String Uses

func (x *LocalityEndpointsHealth) String() string

func (*LocalityEndpointsHealth) Validate Uses

func (m *LocalityEndpointsHealth) Validate() error

Validate checks the field values on LocalityEndpointsHealth with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type LocalityEndpointsHealthValidationError Uses

type LocalityEndpointsHealthValidationError struct {
    // contains filtered or unexported fields
}

LocalityEndpointsHealthValidationError is the validation error returned by LocalityEndpointsHealth.Validate if the designated constraints aren't met.

func (LocalityEndpointsHealthValidationError) Cause Uses

func (e LocalityEndpointsHealthValidationError) Cause() error

Cause function returns cause value.

func (LocalityEndpointsHealthValidationError) Error Uses

func (e LocalityEndpointsHealthValidationError) Error() string

Error satisfies the builtin error interface

func (LocalityEndpointsHealthValidationError) ErrorName Uses

func (e LocalityEndpointsHealthValidationError) ErrorName() string

ErrorName returns error name.

func (LocalityEndpointsHealthValidationError) Field Uses

func (e LocalityEndpointsHealthValidationError) Field() string

Field function returns field value.

func (LocalityEndpointsHealthValidationError) Key Uses

func (e LocalityEndpointsHealthValidationError) Key() bool

Key function returns key value.

func (LocalityEndpointsHealthValidationError) Reason Uses

func (e LocalityEndpointsHealthValidationError) Reason() string

Reason function returns reason value.

type LocalityEndpointsValidationError Uses

type LocalityEndpointsValidationError struct {
    // contains filtered or unexported fields
}

LocalityEndpointsValidationError is the validation error returned by LocalityEndpoints.Validate if the designated constraints aren't met.

func (LocalityEndpointsValidationError) Cause Uses

func (e LocalityEndpointsValidationError) Cause() error

Cause function returns cause value.

func (LocalityEndpointsValidationError) Error Uses

func (e LocalityEndpointsValidationError) Error() string

Error satisfies the builtin error interface

func (LocalityEndpointsValidationError) ErrorName Uses

func (e LocalityEndpointsValidationError) ErrorName() string

ErrorName returns error name.

func (LocalityEndpointsValidationError) Field Uses

func (e LocalityEndpointsValidationError) Field() string

Field function returns field value.

func (LocalityEndpointsValidationError) Key Uses

func (e LocalityEndpointsValidationError) Key() bool

Key function returns key value.

func (LocalityEndpointsValidationError) Reason Uses

func (e LocalityEndpointsValidationError) Reason() string

Reason function returns reason value.

type UnimplementedHealthDiscoveryServiceServer Uses

type UnimplementedHealthDiscoveryServiceServer struct {
}

UnimplementedHealthDiscoveryServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedHealthDiscoveryServiceServer) FetchHealthCheck Uses

func (*UnimplementedHealthDiscoveryServiceServer) FetchHealthCheck(context.Context, *HealthCheckRequestOrEndpointHealthResponse) (*HealthCheckSpecifier, error)

func (*UnimplementedHealthDiscoveryServiceServer) StreamHealthCheck Uses

func (*UnimplementedHealthDiscoveryServiceServer) StreamHealthCheck(HealthDiscoveryService_StreamHealthCheckServer) error

Package envoy_service_health_v4alpha imports 26 packages (graph) and is imported by 6 packages. Updated 2021-01-08. Refresh now. Tools for package owners.