healthv3

package
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 9, 2024 License: Apache-2.0 Imports: 27 Imported by: 29

Documentation

Index

Constants

View Source
const (
	HealthDiscoveryService_StreamHealthCheck_FullMethodName = "/envoy.service.health.v3.HealthDiscoveryService/StreamHealthCheck"
	HealthDiscoveryService_FetchHealthCheck_FullMethodName  = "/envoy.service.health.v3.HealthDiscoveryService/FetchHealthCheck"
)

Variables

View Source
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.

View Source
var File_envoy_service_health_v3_hds_proto protoreflect.FileDescriptor
View Source
var HealthDiscoveryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "envoy.service.health.v3.HealthDiscoveryService",
	HandlerType: (*HealthDiscoveryServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "FetchHealthCheck",
			Handler:    _HealthDiscoveryService_FetchHealthCheck_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamHealthCheck",
			Handler:       _HealthDiscoveryService_StreamHealthCheck_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "envoy/service/health/v3/hds.proto",
}

HealthDiscoveryService_ServiceDesc is the grpc.ServiceDesc for HealthDiscoveryService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterHealthDiscoveryServiceServer

func RegisterHealthDiscoveryServiceServer(s grpc.ServiceRegistrar, srv HealthDiscoveryServiceServer)

Types

type Capability

type Capability struct {
	HealthCheckProtocols []Capability_Protocol `` /* 180-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*Capability) Descriptor deprecated

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

Deprecated: Use Capability.ProtoReflect.Descriptor instead.

func (*Capability) GetHealthCheckProtocols

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

func (*Capability) ProtoMessage

func (*Capability) ProtoMessage()

func (*Capability) ProtoReflect added in v0.9.6

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

func (*Capability) Reset

func (x *Capability) Reset()

func (*Capability) String

func (x *Capability) String() string

func (*Capability) Validate

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, the first error encountered is returned, or nil if there are no violations.

func (*Capability) ValidateAll added in v0.10.0

func (m *Capability) ValidateAll() error

ValidateAll checks the field values on Capability with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CapabilityMultiError, or nil if none found.

type CapabilityMultiError added in v0.10.0

type CapabilityMultiError []error

CapabilityMultiError is an error wrapping multiple validation errors returned by Capability.ValidateAll() if the designated constraints aren't met.

func (CapabilityMultiError) AllErrors added in v0.10.0

func (m CapabilityMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CapabilityMultiError) Error added in v0.10.0

func (m CapabilityMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type CapabilityValidationError

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

func (e CapabilityValidationError) Cause() error

Cause function returns cause value.

func (CapabilityValidationError) Error

Error satisfies the builtin error interface

func (CapabilityValidationError) ErrorName

func (e CapabilityValidationError) ErrorName() string

ErrorName returns error name.

func (CapabilityValidationError) Field

Field function returns field value.

func (CapabilityValidationError) Key

Key function returns key value.

func (CapabilityValidationError) Reason

func (e CapabilityValidationError) Reason() string

Reason function returns reason value.

type Capability_Protocol

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 added in v0.9.6

func (Capability_Protocol) Enum added in v0.9.6

func (Capability_Protocol) EnumDescriptor deprecated

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

Deprecated: Use Capability_Protocol.Descriptor instead.

func (Capability_Protocol) Number added in v0.9.6

func (Capability_Protocol) String

func (x Capability_Protocol) String() string

func (Capability_Protocol) Type added in v0.9.6

type ClusterEndpointsHealth added in v0.9.7

type ClusterEndpointsHealth struct {
	ClusterName             string                     `protobuf:"bytes,1,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
	LocalityEndpointsHealth []*LocalityEndpointsHealth `` /* 132-byte string literal not displayed */
	// 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 deprecated added in v0.9.7

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

Deprecated: Use ClusterEndpointsHealth.ProtoReflect.Descriptor instead.

func (*ClusterEndpointsHealth) GetClusterName added in v0.9.7

func (x *ClusterEndpointsHealth) GetClusterName() string

func (*ClusterEndpointsHealth) GetLocalityEndpointsHealth added in v0.9.7

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

func (*ClusterEndpointsHealth) ProtoMessage added in v0.9.7

func (*ClusterEndpointsHealth) ProtoMessage()

func (*ClusterEndpointsHealth) ProtoReflect added in v0.9.7

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

func (*ClusterEndpointsHealth) Reset added in v0.9.7

func (x *ClusterEndpointsHealth) Reset()

func (*ClusterEndpointsHealth) String added in v0.9.7

func (x *ClusterEndpointsHealth) String() string

func (*ClusterEndpointsHealth) Validate added in v0.9.7

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, the first error encountered is returned, or nil if there are no violations.

func (*ClusterEndpointsHealth) ValidateAll added in v0.10.0

func (m *ClusterEndpointsHealth) ValidateAll() error

ValidateAll checks the field values on ClusterEndpointsHealth with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ClusterEndpointsHealthMultiError, or nil if none found.

type ClusterEndpointsHealthMultiError added in v0.10.0

type ClusterEndpointsHealthMultiError []error

ClusterEndpointsHealthMultiError is an error wrapping multiple validation errors returned by ClusterEndpointsHealth.ValidateAll() if the designated constraints aren't met.

func (ClusterEndpointsHealthMultiError) AllErrors added in v0.10.0

func (m ClusterEndpointsHealthMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ClusterEndpointsHealthMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type ClusterEndpointsHealthValidationError added in v0.9.7

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 added in v0.9.7

Cause function returns cause value.

func (ClusterEndpointsHealthValidationError) Error added in v0.9.7

Error satisfies the builtin error interface

func (ClusterEndpointsHealthValidationError) ErrorName added in v0.9.7

ErrorName returns error name.

func (ClusterEndpointsHealthValidationError) Field added in v0.9.7

Field function returns field value.

func (ClusterEndpointsHealthValidationError) Key added in v0.9.7

Key function returns key value.

func (ClusterEndpointsHealthValidationError) Reason added in v0.9.7

Reason function returns reason value.

type ClusterHealthCheck

type ClusterHealthCheck struct {
	ClusterName       string               `protobuf:"bytes,1,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
	HealthChecks      []*v3.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_v3_api_field_config.core.v3.HealthCheck.transport_socket_match_criteria>`
	// on connection when health checking. For more details, see
	// :ref:`config.cluster.v3.Cluster.transport_socket_matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`.
	TransportSocketMatches []*v32.Cluster_TransportSocketMatch `` /* 129-byte string literal not displayed */
	// Optional configuration used to bind newly established upstream connections.
	// If the address and port are empty, no bind will be performed.
	UpstreamBindConfig *v3.BindConfig `protobuf:"bytes,5,opt,name=upstream_bind_config,json=upstreamBindConfig,proto3" json:"upstream_bind_config,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. [#next-free-field: 6]

func (*ClusterHealthCheck) Descriptor deprecated

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

Deprecated: Use ClusterHealthCheck.ProtoReflect.Descriptor instead.

func (*ClusterHealthCheck) GetClusterName

func (x *ClusterHealthCheck) GetClusterName() string

func (*ClusterHealthCheck) GetHealthChecks

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

func (*ClusterHealthCheck) GetLocalityEndpoints

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

func (*ClusterHealthCheck) GetTransportSocketMatches added in v0.9.7

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

func (*ClusterHealthCheck) GetUpstreamBindConfig added in v0.11.0

func (x *ClusterHealthCheck) GetUpstreamBindConfig() *v3.BindConfig

func (*ClusterHealthCheck) ProtoMessage

func (*ClusterHealthCheck) ProtoMessage()

func (*ClusterHealthCheck) ProtoReflect added in v0.9.6

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

func (*ClusterHealthCheck) Reset

func (x *ClusterHealthCheck) Reset()

func (*ClusterHealthCheck) String

func (x *ClusterHealthCheck) String() string

func (*ClusterHealthCheck) Validate

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, the first error encountered is returned, or nil if there are no violations.

func (*ClusterHealthCheck) ValidateAll added in v0.10.0

func (m *ClusterHealthCheck) ValidateAll() error

ValidateAll checks the field values on ClusterHealthCheck with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ClusterHealthCheckMultiError, or nil if none found.

type ClusterHealthCheckMultiError added in v0.10.0

type ClusterHealthCheckMultiError []error

ClusterHealthCheckMultiError is an error wrapping multiple validation errors returned by ClusterHealthCheck.ValidateAll() if the designated constraints aren't met.

func (ClusterHealthCheckMultiError) AllErrors added in v0.10.0

func (m ClusterHealthCheckMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ClusterHealthCheckMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type ClusterHealthCheckValidationError

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

Cause function returns cause value.

func (ClusterHealthCheckValidationError) Error

Error satisfies the builtin error interface

func (ClusterHealthCheckValidationError) ErrorName

ErrorName returns error name.

func (ClusterHealthCheckValidationError) Field

Field function returns field value.

func (ClusterHealthCheckValidationError) Key

Key function returns key value.

func (ClusterHealthCheckValidationError) Reason

Reason function returns reason value.

type EndpointHealth

type EndpointHealth struct {
	Endpoint     *v31.Endpoint   `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	HealthStatus v3.HealthStatus `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*EndpointHealth) Descriptor deprecated

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

Deprecated: Use EndpointHealth.ProtoReflect.Descriptor instead.

func (*EndpointHealth) GetEndpoint

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

func (*EndpointHealth) GetHealthStatus

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

func (*EndpointHealth) ProtoMessage

func (*EndpointHealth) ProtoMessage()

func (*EndpointHealth) ProtoReflect added in v0.9.6

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

func (*EndpointHealth) Reset

func (x *EndpointHealth) Reset()

func (*EndpointHealth) String

func (x *EndpointHealth) String() string

func (*EndpointHealth) Validate

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, the first error encountered is returned, or nil if there are no violations.

func (*EndpointHealth) ValidateAll added in v0.10.0

func (m *EndpointHealth) ValidateAll() error

ValidateAll checks the field values on EndpointHealth with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in EndpointHealthMultiError, or nil if none found.

type EndpointHealthMultiError added in v0.10.0

type EndpointHealthMultiError []error

EndpointHealthMultiError is an error wrapping multiple validation errors returned by EndpointHealth.ValidateAll() if the designated constraints aren't met.

func (EndpointHealthMultiError) AllErrors added in v0.10.0

func (m EndpointHealthMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (EndpointHealthMultiError) Error added in v0.10.0

func (m EndpointHealthMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type EndpointHealthResponse

type EndpointHealthResponse struct {

	// Deprecated - Flat list of endpoint health information.
	//
	// Deprecated: Marked as deprecated in envoy/service/health/v3/hds.proto.
	EndpointsHealth []*EndpointHealth `protobuf:"bytes,1,rep,name=endpoints_health,json=endpointsHealth,proto3" json:"endpoints_health,omitempty"`
	// Organize Endpoint health information by cluster.
	ClusterEndpointsHealth []*ClusterEndpointsHealth `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*EndpointHealthResponse) Descriptor deprecated

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

Deprecated: Use EndpointHealthResponse.ProtoReflect.Descriptor instead.

func (*EndpointHealthResponse) GetClusterEndpointsHealth added in v0.9.7

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

func (*EndpointHealthResponse) GetEndpointsHealth deprecated

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

Deprecated: Marked as deprecated in envoy/service/health/v3/hds.proto.

func (*EndpointHealthResponse) ProtoMessage

func (*EndpointHealthResponse) ProtoMessage()

func (*EndpointHealthResponse) ProtoReflect added in v0.9.6

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

func (*EndpointHealthResponse) Reset

func (x *EndpointHealthResponse) Reset()

func (*EndpointHealthResponse) String

func (x *EndpointHealthResponse) String() string

func (*EndpointHealthResponse) Validate

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, the first error encountered is returned, or nil if there are no violations.

func (*EndpointHealthResponse) ValidateAll added in v0.10.0

func (m *EndpointHealthResponse) ValidateAll() error

ValidateAll checks the field values on EndpointHealthResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in EndpointHealthResponseMultiError, or nil if none found.

type EndpointHealthResponseMultiError added in v0.10.0

type EndpointHealthResponseMultiError []error

EndpointHealthResponseMultiError is an error wrapping multiple validation errors returned by EndpointHealthResponse.ValidateAll() if the designated constraints aren't met.

func (EndpointHealthResponseMultiError) AllErrors added in v0.10.0

func (m EndpointHealthResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (EndpointHealthResponseMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type EndpointHealthResponseValidationError

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

Cause function returns cause value.

func (EndpointHealthResponseValidationError) Error

Error satisfies the builtin error interface

func (EndpointHealthResponseValidationError) ErrorName

ErrorName returns error name.

func (EndpointHealthResponseValidationError) Field

Field function returns field value.

func (EndpointHealthResponseValidationError) Key

Key function returns key value.

func (EndpointHealthResponseValidationError) Reason

Reason function returns reason value.

type EndpointHealthValidationError

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

Cause function returns cause value.

func (EndpointHealthValidationError) Error

Error satisfies the builtin error interface

func (EndpointHealthValidationError) ErrorName

func (e EndpointHealthValidationError) ErrorName() string

ErrorName returns error name.

func (EndpointHealthValidationError) Field

Field function returns field value.

func (EndpointHealthValidationError) Key

Key function returns key value.

func (EndpointHealthValidationError) Reason

Reason function returns reason value.

type HdsDummy added in v0.10.0

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

[#not-implemented-hide:] Not configuration. Workaround c++ protobuf issue with importing services: https://github.com/google/protobuf/issues/4221 and protoxform to upgrade the file.

func (*HdsDummy) Descriptor deprecated added in v0.10.0

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

Deprecated: Use HdsDummy.ProtoReflect.Descriptor instead.

func (*HdsDummy) ProtoMessage added in v0.10.0

func (*HdsDummy) ProtoMessage()

func (*HdsDummy) ProtoReflect added in v0.10.0

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

func (*HdsDummy) Reset added in v0.10.0

func (x *HdsDummy) Reset()

func (*HdsDummy) String added in v0.10.0

func (x *HdsDummy) String() string

func (*HdsDummy) Validate added in v0.10.0

func (m *HdsDummy) Validate() error

Validate checks the field values on HdsDummy with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*HdsDummy) ValidateAll added in v0.10.0

func (m *HdsDummy) ValidateAll() error

ValidateAll checks the field values on HdsDummy with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in HdsDummyMultiError, or nil if none found.

type HdsDummyMultiError added in v0.10.0

type HdsDummyMultiError []error

HdsDummyMultiError is an error wrapping multiple validation errors returned by HdsDummy.ValidateAll() if the designated constraints aren't met.

func (HdsDummyMultiError) AllErrors added in v0.10.0

func (m HdsDummyMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HdsDummyMultiError) Error added in v0.10.0

func (m HdsDummyMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type HdsDummyValidationError added in v0.10.0

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

HdsDummyValidationError is the validation error returned by HdsDummy.Validate if the designated constraints aren't met.

func (HdsDummyValidationError) Cause added in v0.10.0

func (e HdsDummyValidationError) Cause() error

Cause function returns cause value.

func (HdsDummyValidationError) Error added in v0.10.0

func (e HdsDummyValidationError) Error() string

Error satisfies the builtin error interface

func (HdsDummyValidationError) ErrorName added in v0.10.0

func (e HdsDummyValidationError) ErrorName() string

ErrorName returns error name.

func (HdsDummyValidationError) Field added in v0.10.0

func (e HdsDummyValidationError) Field() string

Field function returns field value.

func (HdsDummyValidationError) Key added in v0.10.0

func (e HdsDummyValidationError) Key() bool

Key function returns key value.

func (HdsDummyValidationError) Reason added in v0.10.0

func (e HdsDummyValidationError) Reason() string

Reason function returns reason value.

type HealthCheckRequest

type HealthCheckRequest struct {
	Node       *v3.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 deprecated

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

Deprecated: Use HealthCheckRequest.ProtoReflect.Descriptor instead.

func (*HealthCheckRequest) GetCapability

func (x *HealthCheckRequest) GetCapability() *Capability

func (*HealthCheckRequest) GetNode

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

func (*HealthCheckRequest) ProtoMessage

func (*HealthCheckRequest) ProtoMessage()

func (*HealthCheckRequest) ProtoReflect added in v0.9.6

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

func (*HealthCheckRequest) Reset

func (x *HealthCheckRequest) Reset()

func (*HealthCheckRequest) String

func (x *HealthCheckRequest) String() string

func (*HealthCheckRequest) Validate

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, the first error encountered is returned, or nil if there are no violations.

func (*HealthCheckRequest) ValidateAll added in v0.10.0

func (m *HealthCheckRequest) ValidateAll() error

ValidateAll checks the field values on HealthCheckRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in HealthCheckRequestMultiError, or nil if none found.

type HealthCheckRequestMultiError added in v0.10.0

type HealthCheckRequestMultiError []error

HealthCheckRequestMultiError is an error wrapping multiple validation errors returned by HealthCheckRequest.ValidateAll() if the designated constraints aren't met.

func (HealthCheckRequestMultiError) AllErrors added in v0.10.0

func (m HealthCheckRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HealthCheckRequestMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type HealthCheckRequestOrEndpointHealthResponse

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 deprecated

Deprecated: Use HealthCheckRequestOrEndpointHealthResponse.ProtoReflect.Descriptor instead.

func (*HealthCheckRequestOrEndpointHealthResponse) GetEndpointHealthResponse

func (*HealthCheckRequestOrEndpointHealthResponse) GetHealthCheckRequest

func (*HealthCheckRequestOrEndpointHealthResponse) GetRequestType

func (m *HealthCheckRequestOrEndpointHealthResponse) GetRequestType() isHealthCheckRequestOrEndpointHealthResponse_RequestType

func (*HealthCheckRequestOrEndpointHealthResponse) ProtoMessage

func (*HealthCheckRequestOrEndpointHealthResponse) ProtoReflect added in v0.9.6

func (*HealthCheckRequestOrEndpointHealthResponse) Reset

func (*HealthCheckRequestOrEndpointHealthResponse) String

func (*HealthCheckRequestOrEndpointHealthResponse) Validate

Validate checks the field values on HealthCheckRequestOrEndpointHealthResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*HealthCheckRequestOrEndpointHealthResponse) ValidateAll added in v0.10.0

ValidateAll checks the field values on HealthCheckRequestOrEndpointHealthResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in HealthCheckRequestOrEndpointHealthResponseMultiError, or nil if none found.

type HealthCheckRequestOrEndpointHealthResponseMultiError added in v0.10.0

type HealthCheckRequestOrEndpointHealthResponseMultiError []error

HealthCheckRequestOrEndpointHealthResponseMultiError is an error wrapping multiple validation errors returned by HealthCheckRequestOrEndpointHealthResponse.ValidateAll() if the designated constraints aren't met.

func (HealthCheckRequestOrEndpointHealthResponseMultiError) AllErrors added in v0.10.0

AllErrors returns a list of validation violation errors.

func (HealthCheckRequestOrEndpointHealthResponseMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type HealthCheckRequestOrEndpointHealthResponseValidationError

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

Cause function returns cause value.

func (HealthCheckRequestOrEndpointHealthResponseValidationError) Error

Error satisfies the builtin error interface

func (HealthCheckRequestOrEndpointHealthResponseValidationError) ErrorName

ErrorName returns error name.

func (HealthCheckRequestOrEndpointHealthResponseValidationError) Field

Field function returns field value.

func (HealthCheckRequestOrEndpointHealthResponseValidationError) Key

Key function returns key value.

func (HealthCheckRequestOrEndpointHealthResponseValidationError) Reason

Reason function returns reason value.

type HealthCheckRequestOrEndpointHealthResponse_EndpointHealthResponse

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

type HealthCheckRequestOrEndpointHealthResponse_HealthCheckRequest

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

type HealthCheckRequestValidationError

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

Cause function returns cause value.

func (HealthCheckRequestValidationError) Error

Error satisfies the builtin error interface

func (HealthCheckRequestValidationError) ErrorName

ErrorName returns error name.

func (HealthCheckRequestValidationError) Field

Field function returns field value.

func (HealthCheckRequestValidationError) Key

Key function returns key value.

func (HealthCheckRequestValidationError) Reason

Reason function returns reason value.

type HealthCheckSpecifier

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 *durationpb.Duration `protobuf:"bytes,2,opt,name=interval,proto3" json:"interval,omitempty"`
	// contains filtered or unexported fields
}

func (*HealthCheckSpecifier) Descriptor deprecated

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

Deprecated: Use HealthCheckSpecifier.ProtoReflect.Descriptor instead.

func (*HealthCheckSpecifier) GetClusterHealthChecks

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

func (*HealthCheckSpecifier) GetInterval

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

func (*HealthCheckSpecifier) ProtoMessage

func (*HealthCheckSpecifier) ProtoMessage()

func (*HealthCheckSpecifier) ProtoReflect added in v0.9.6

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

func (*HealthCheckSpecifier) Reset

func (x *HealthCheckSpecifier) Reset()

func (*HealthCheckSpecifier) String

func (x *HealthCheckSpecifier) String() string

func (*HealthCheckSpecifier) Validate

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, the first error encountered is returned, or nil if there are no violations.

func (*HealthCheckSpecifier) ValidateAll added in v0.10.0

func (m *HealthCheckSpecifier) ValidateAll() error

ValidateAll checks the field values on HealthCheckSpecifier with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in HealthCheckSpecifierMultiError, or nil if none found.

type HealthCheckSpecifierMultiError added in v0.10.0

type HealthCheckSpecifierMultiError []error

HealthCheckSpecifierMultiError is an error wrapping multiple validation errors returned by HealthCheckSpecifier.ValidateAll() if the designated constraints aren't met.

func (HealthCheckSpecifierMultiError) AllErrors added in v0.10.0

func (m HealthCheckSpecifierMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HealthCheckSpecifierMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type HealthCheckSpecifierValidationError

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

Cause function returns cause value.

func (HealthCheckSpecifierValidationError) Error

Error satisfies the builtin error interface

func (HealthCheckSpecifierValidationError) ErrorName

ErrorName returns error name.

func (HealthCheckSpecifierValidationError) Field

Field function returns field value.

func (HealthCheckSpecifierValidationError) Key

Key function returns key value.

func (HealthCheckSpecifierValidationError) Reason

Reason function returns reason value.

type HealthDiscoveryServiceClient

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://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type HealthDiscoveryServiceServer

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. All implementations should embed UnimplementedHealthDiscoveryServiceServer for forward compatibility

type HealthDiscoveryService_StreamHealthCheckClient

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

type HealthDiscoveryService_StreamHealthCheckServer

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

type LocalityEndpoints

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

func (*LocalityEndpoints) Descriptor deprecated

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

Deprecated: Use LocalityEndpoints.ProtoReflect.Descriptor instead.

func (*LocalityEndpoints) GetEndpoints

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

func (*LocalityEndpoints) GetLocality

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

func (*LocalityEndpoints) ProtoMessage

func (*LocalityEndpoints) ProtoMessage()

func (*LocalityEndpoints) ProtoReflect added in v0.9.6

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

func (*LocalityEndpoints) Reset

func (x *LocalityEndpoints) Reset()

func (*LocalityEndpoints) String

func (x *LocalityEndpoints) String() string

func (*LocalityEndpoints) Validate

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, the first error encountered is returned, or nil if there are no violations.

func (*LocalityEndpoints) ValidateAll added in v0.10.0

func (m *LocalityEndpoints) ValidateAll() error

ValidateAll checks the field values on LocalityEndpoints with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in LocalityEndpointsMultiError, or nil if none found.

type LocalityEndpointsHealth added in v0.9.7

type LocalityEndpointsHealth struct {
	Locality        *v3.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 deprecated added in v0.9.7

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

Deprecated: Use LocalityEndpointsHealth.ProtoReflect.Descriptor instead.

func (*LocalityEndpointsHealth) GetEndpointsHealth added in v0.9.7

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

func (*LocalityEndpointsHealth) GetLocality added in v0.9.7

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

func (*LocalityEndpointsHealth) ProtoMessage added in v0.9.7

func (*LocalityEndpointsHealth) ProtoMessage()

func (*LocalityEndpointsHealth) ProtoReflect added in v0.9.7

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

func (*LocalityEndpointsHealth) Reset added in v0.9.7

func (x *LocalityEndpointsHealth) Reset()

func (*LocalityEndpointsHealth) String added in v0.9.7

func (x *LocalityEndpointsHealth) String() string

func (*LocalityEndpointsHealth) Validate added in v0.9.7

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, the first error encountered is returned, or nil if there are no violations.

func (*LocalityEndpointsHealth) ValidateAll added in v0.10.0

func (m *LocalityEndpointsHealth) ValidateAll() error

ValidateAll checks the field values on LocalityEndpointsHealth with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in LocalityEndpointsHealthMultiError, or nil if none found.

type LocalityEndpointsHealthMultiError added in v0.10.0

type LocalityEndpointsHealthMultiError []error

LocalityEndpointsHealthMultiError is an error wrapping multiple validation errors returned by LocalityEndpointsHealth.ValidateAll() if the designated constraints aren't met.

func (LocalityEndpointsHealthMultiError) AllErrors added in v0.10.0

func (m LocalityEndpointsHealthMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (LocalityEndpointsHealthMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type LocalityEndpointsHealthValidationError added in v0.9.7

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 added in v0.9.7

Cause function returns cause value.

func (LocalityEndpointsHealthValidationError) Error added in v0.9.7

Error satisfies the builtin error interface

func (LocalityEndpointsHealthValidationError) ErrorName added in v0.9.7

ErrorName returns error name.

func (LocalityEndpointsHealthValidationError) Field added in v0.9.7

Field function returns field value.

func (LocalityEndpointsHealthValidationError) Key added in v0.9.7

Key function returns key value.

func (LocalityEndpointsHealthValidationError) Reason added in v0.9.7

Reason function returns reason value.

type LocalityEndpointsMultiError added in v0.10.0

type LocalityEndpointsMultiError []error

LocalityEndpointsMultiError is an error wrapping multiple validation errors returned by LocalityEndpoints.ValidateAll() if the designated constraints aren't met.

func (LocalityEndpointsMultiError) AllErrors added in v0.10.0

func (m LocalityEndpointsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (LocalityEndpointsMultiError) Error added in v0.10.0

Error returns a concatenation of all the error messages it wraps.

type LocalityEndpointsValidationError

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

Cause function returns cause value.

func (LocalityEndpointsValidationError) Error

Error satisfies the builtin error interface

func (LocalityEndpointsValidationError) ErrorName

ErrorName returns error name.

func (LocalityEndpointsValidationError) Field

Field function returns field value.

func (LocalityEndpointsValidationError) Key

Key function returns key value.

func (LocalityEndpointsValidationError) Reason

Reason function returns reason value.

type UnimplementedHealthDiscoveryServiceServer

type UnimplementedHealthDiscoveryServiceServer struct {
}

UnimplementedHealthDiscoveryServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedHealthDiscoveryServiceServer) StreamHealthCheck

type UnsafeHealthDiscoveryServiceServer added in v0.13.0

type UnsafeHealthDiscoveryServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeHealthDiscoveryServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to HealthDiscoveryServiceServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL