Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterMetricsServiceServer(s grpc.ServiceRegistrar, srv MetricsServiceServer)
- type MetricsServiceClient
- type MetricsServiceServer
- type MetricsService_StreamMetricsClient
- type MetricsService_StreamMetricsServer
- type StreamMetricsMessage
- func (*StreamMetricsMessage) Descriptor() ([]byte, []int)deprecated
- func (x *StreamMetricsMessage) GetEnvoyMetrics() []*_go.MetricFamily
- func (x *StreamMetricsMessage) GetIdentifier() *StreamMetricsMessage_Identifier
- func (*StreamMetricsMessage) ProtoMessage()
- func (x *StreamMetricsMessage) ProtoReflect() protoreflect.Message
- func (x *StreamMetricsMessage) Reset()
- func (x *StreamMetricsMessage) String() string
- func (m *StreamMetricsMessage) Validate() error
- func (m *StreamMetricsMessage) ValidateAll() error
- type StreamMetricsMessageMultiError
- type StreamMetricsMessageValidationError
- func (e StreamMetricsMessageValidationError) Cause() error
- func (e StreamMetricsMessageValidationError) Error() string
- func (e StreamMetricsMessageValidationError) ErrorName() string
- func (e StreamMetricsMessageValidationError) Field() string
- func (e StreamMetricsMessageValidationError) Key() bool
- func (e StreamMetricsMessageValidationError) Reason() string
- type StreamMetricsMessage_Identifier
- func (*StreamMetricsMessage_Identifier) Descriptor() ([]byte, []int)deprecated
- func (x *StreamMetricsMessage_Identifier) GetNode() *v3.Node
- func (*StreamMetricsMessage_Identifier) ProtoMessage()
- func (x *StreamMetricsMessage_Identifier) ProtoReflect() protoreflect.Message
- func (x *StreamMetricsMessage_Identifier) Reset()
- func (x *StreamMetricsMessage_Identifier) String() string
- func (m *StreamMetricsMessage_Identifier) Validate() error
- func (m *StreamMetricsMessage_Identifier) ValidateAll() error
- type StreamMetricsMessage_IdentifierMultiError
- type StreamMetricsMessage_IdentifierValidationError
- func (e StreamMetricsMessage_IdentifierValidationError) Cause() error
- func (e StreamMetricsMessage_IdentifierValidationError) Error() string
- func (e StreamMetricsMessage_IdentifierValidationError) ErrorName() string
- func (e StreamMetricsMessage_IdentifierValidationError) Field() string
- func (e StreamMetricsMessage_IdentifierValidationError) Key() bool
- func (e StreamMetricsMessage_IdentifierValidationError) Reason() string
- type StreamMetricsResponse
- func (*StreamMetricsResponse) Descriptor() ([]byte, []int)deprecated
- func (*StreamMetricsResponse) ProtoMessage()
- func (x *StreamMetricsResponse) ProtoReflect() protoreflect.Message
- func (x *StreamMetricsResponse) Reset()
- func (x *StreamMetricsResponse) String() string
- func (m *StreamMetricsResponse) Validate() error
- func (m *StreamMetricsResponse) ValidateAll() error
- type StreamMetricsResponseMultiError
- type StreamMetricsResponseValidationError
- func (e StreamMetricsResponseValidationError) Cause() error
- func (e StreamMetricsResponseValidationError) Error() string
- func (e StreamMetricsResponseValidationError) ErrorName() string
- func (e StreamMetricsResponseValidationError) Field() string
- func (e StreamMetricsResponseValidationError) Key() bool
- func (e StreamMetricsResponseValidationError) Reason() string
- type UnimplementedMetricsServiceServer
- type UnsafeMetricsServiceServer
Constants ¶
const (
MetricsService_StreamMetrics_FullMethodName = "/envoy.service.metrics.v3.MetricsService/StreamMetrics"
)
Variables ¶
var File_envoy_service_metrics_v3_metrics_service_proto protoreflect.FileDescriptor
var MetricsService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "envoy.service.metrics.v3.MetricsService", HandlerType: (*MetricsServiceServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "StreamMetrics", Handler: _MetricsService_StreamMetrics_Handler, ClientStreams: true, }, }, Metadata: "envoy/service/metrics/v3/metrics_service.proto", }
MetricsService_ServiceDesc is the grpc.ServiceDesc for MetricsService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterMetricsServiceServer ¶
func RegisterMetricsServiceServer(s grpc.ServiceRegistrar, srv MetricsServiceServer)
Types ¶
type MetricsServiceClient ¶
type MetricsServiceClient interface { // Envoy will connect and send StreamMetricsMessage messages forever. It does not expect any // response to be sent as nothing would be done in the case of failure. StreamMetrics(ctx context.Context, opts ...grpc.CallOption) (MetricsService_StreamMetricsClient, error) }
MetricsServiceClient is the client API for MetricsService 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.
func NewMetricsServiceClient ¶
func NewMetricsServiceClient(cc grpc.ClientConnInterface) MetricsServiceClient
type MetricsServiceServer ¶
type MetricsServiceServer interface { // Envoy will connect and send StreamMetricsMessage messages forever. It does not expect any // response to be sent as nothing would be done in the case of failure. StreamMetrics(MetricsService_StreamMetricsServer) error }
MetricsServiceServer is the server API for MetricsService service. All implementations should embed UnimplementedMetricsServiceServer for forward compatibility
type MetricsService_StreamMetricsClient ¶
type MetricsService_StreamMetricsClient interface { Send(*StreamMetricsMessage) error CloseAndRecv() (*StreamMetricsResponse, error) grpc.ClientStream }
type MetricsService_StreamMetricsServer ¶
type MetricsService_StreamMetricsServer interface { SendAndClose(*StreamMetricsResponse) error Recv() (*StreamMetricsMessage, error) grpc.ServerStream }
type StreamMetricsMessage ¶
type StreamMetricsMessage struct { // Identifier data effectively is a structured metadata. As a performance optimization this will // only be sent in the first message on the stream. Identifier *StreamMetricsMessage_Identifier `protobuf:"bytes,1,opt,name=identifier,proto3" json:"identifier,omitempty"` // A list of metric entries EnvoyMetrics []*_go.MetricFamily `protobuf:"bytes,2,rep,name=envoy_metrics,json=envoyMetrics,proto3" json:"envoy_metrics,omitempty"` // contains filtered or unexported fields }
func (*StreamMetricsMessage) Descriptor
deprecated
func (*StreamMetricsMessage) Descriptor() ([]byte, []int)
Deprecated: Use StreamMetricsMessage.ProtoReflect.Descriptor instead.
func (*StreamMetricsMessage) GetEnvoyMetrics ¶
func (x *StreamMetricsMessage) GetEnvoyMetrics() []*_go.MetricFamily
func (*StreamMetricsMessage) GetIdentifier ¶
func (x *StreamMetricsMessage) GetIdentifier() *StreamMetricsMessage_Identifier
func (*StreamMetricsMessage) ProtoMessage ¶
func (*StreamMetricsMessage) ProtoMessage()
func (*StreamMetricsMessage) ProtoReflect ¶ added in v0.9.6
func (x *StreamMetricsMessage) ProtoReflect() protoreflect.Message
func (*StreamMetricsMessage) Reset ¶
func (x *StreamMetricsMessage) Reset()
func (*StreamMetricsMessage) String ¶
func (x *StreamMetricsMessage) String() string
func (*StreamMetricsMessage) Validate ¶
func (m *StreamMetricsMessage) Validate() error
Validate checks the field values on StreamMetricsMessage 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 (*StreamMetricsMessage) ValidateAll ¶ added in v0.10.0
func (m *StreamMetricsMessage) ValidateAll() error
ValidateAll checks the field values on StreamMetricsMessage 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 StreamMetricsMessageMultiError, or nil if none found.
type StreamMetricsMessageMultiError ¶ added in v0.10.0
type StreamMetricsMessageMultiError []error
StreamMetricsMessageMultiError is an error wrapping multiple validation errors returned by StreamMetricsMessage.ValidateAll() if the designated constraints aren't met.
func (StreamMetricsMessageMultiError) AllErrors ¶ added in v0.10.0
func (m StreamMetricsMessageMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (StreamMetricsMessageMultiError) Error ¶ added in v0.10.0
func (m StreamMetricsMessageMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type StreamMetricsMessageValidationError ¶
type StreamMetricsMessageValidationError struct {
// contains filtered or unexported fields
}
StreamMetricsMessageValidationError is the validation error returned by StreamMetricsMessage.Validate if the designated constraints aren't met.
func (StreamMetricsMessageValidationError) Cause ¶
func (e StreamMetricsMessageValidationError) Cause() error
Cause function returns cause value.
func (StreamMetricsMessageValidationError) Error ¶
func (e StreamMetricsMessageValidationError) Error() string
Error satisfies the builtin error interface
func (StreamMetricsMessageValidationError) ErrorName ¶
func (e StreamMetricsMessageValidationError) ErrorName() string
ErrorName returns error name.
func (StreamMetricsMessageValidationError) Field ¶
func (e StreamMetricsMessageValidationError) Field() string
Field function returns field value.
func (StreamMetricsMessageValidationError) Key ¶
func (e StreamMetricsMessageValidationError) Key() bool
Key function returns key value.
func (StreamMetricsMessageValidationError) Reason ¶
func (e StreamMetricsMessageValidationError) Reason() string
Reason function returns reason value.
type StreamMetricsMessage_Identifier ¶
type StreamMetricsMessage_Identifier struct { // The node sending metrics over the stream. Node *v3.Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"` // contains filtered or unexported fields }
func (*StreamMetricsMessage_Identifier) Descriptor
deprecated
func (*StreamMetricsMessage_Identifier) Descriptor() ([]byte, []int)
Deprecated: Use StreamMetricsMessage_Identifier.ProtoReflect.Descriptor instead.
func (*StreamMetricsMessage_Identifier) GetNode ¶
func (x *StreamMetricsMessage_Identifier) GetNode() *v3.Node
func (*StreamMetricsMessage_Identifier) ProtoMessage ¶
func (*StreamMetricsMessage_Identifier) ProtoMessage()
func (*StreamMetricsMessage_Identifier) ProtoReflect ¶ added in v0.9.6
func (x *StreamMetricsMessage_Identifier) ProtoReflect() protoreflect.Message
func (*StreamMetricsMessage_Identifier) Reset ¶
func (x *StreamMetricsMessage_Identifier) Reset()
func (*StreamMetricsMessage_Identifier) String ¶
func (x *StreamMetricsMessage_Identifier) String() string
func (*StreamMetricsMessage_Identifier) Validate ¶
func (m *StreamMetricsMessage_Identifier) Validate() error
Validate checks the field values on StreamMetricsMessage_Identifier 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 (*StreamMetricsMessage_Identifier) ValidateAll ¶ added in v0.10.0
func (m *StreamMetricsMessage_Identifier) ValidateAll() error
ValidateAll checks the field values on StreamMetricsMessage_Identifier 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 StreamMetricsMessage_IdentifierMultiError, or nil if none found.
type StreamMetricsMessage_IdentifierMultiError ¶ added in v0.10.0
type StreamMetricsMessage_IdentifierMultiError []error
StreamMetricsMessage_IdentifierMultiError is an error wrapping multiple validation errors returned by StreamMetricsMessage_Identifier.ValidateAll() if the designated constraints aren't met.
func (StreamMetricsMessage_IdentifierMultiError) AllErrors ¶ added in v0.10.0
func (m StreamMetricsMessage_IdentifierMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (StreamMetricsMessage_IdentifierMultiError) Error ¶ added in v0.10.0
func (m StreamMetricsMessage_IdentifierMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type StreamMetricsMessage_IdentifierValidationError ¶
type StreamMetricsMessage_IdentifierValidationError struct {
// contains filtered or unexported fields
}
StreamMetricsMessage_IdentifierValidationError is the validation error returned by StreamMetricsMessage_Identifier.Validate if the designated constraints aren't met.
func (StreamMetricsMessage_IdentifierValidationError) Cause ¶
func (e StreamMetricsMessage_IdentifierValidationError) Cause() error
Cause function returns cause value.
func (StreamMetricsMessage_IdentifierValidationError) Error ¶
func (e StreamMetricsMessage_IdentifierValidationError) Error() string
Error satisfies the builtin error interface
func (StreamMetricsMessage_IdentifierValidationError) ErrorName ¶
func (e StreamMetricsMessage_IdentifierValidationError) ErrorName() string
ErrorName returns error name.
func (StreamMetricsMessage_IdentifierValidationError) Field ¶
func (e StreamMetricsMessage_IdentifierValidationError) Field() string
Field function returns field value.
func (StreamMetricsMessage_IdentifierValidationError) Key ¶
func (e StreamMetricsMessage_IdentifierValidationError) Key() bool
Key function returns key value.
func (StreamMetricsMessage_IdentifierValidationError) Reason ¶
func (e StreamMetricsMessage_IdentifierValidationError) Reason() string
Reason function returns reason value.
type StreamMetricsResponse ¶
type StreamMetricsResponse struct {
// contains filtered or unexported fields
}
func (*StreamMetricsResponse) Descriptor
deprecated
func (*StreamMetricsResponse) Descriptor() ([]byte, []int)
Deprecated: Use StreamMetricsResponse.ProtoReflect.Descriptor instead.
func (*StreamMetricsResponse) ProtoMessage ¶
func (*StreamMetricsResponse) ProtoMessage()
func (*StreamMetricsResponse) ProtoReflect ¶ added in v0.9.6
func (x *StreamMetricsResponse) ProtoReflect() protoreflect.Message
func (*StreamMetricsResponse) Reset ¶
func (x *StreamMetricsResponse) Reset()
func (*StreamMetricsResponse) String ¶
func (x *StreamMetricsResponse) String() string
func (*StreamMetricsResponse) Validate ¶
func (m *StreamMetricsResponse) Validate() error
Validate checks the field values on StreamMetricsResponse 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 (*StreamMetricsResponse) ValidateAll ¶ added in v0.10.0
func (m *StreamMetricsResponse) ValidateAll() error
ValidateAll checks the field values on StreamMetricsResponse 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 StreamMetricsResponseMultiError, or nil if none found.
type StreamMetricsResponseMultiError ¶ added in v0.10.0
type StreamMetricsResponseMultiError []error
StreamMetricsResponseMultiError is an error wrapping multiple validation errors returned by StreamMetricsResponse.ValidateAll() if the designated constraints aren't met.
func (StreamMetricsResponseMultiError) AllErrors ¶ added in v0.10.0
func (m StreamMetricsResponseMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (StreamMetricsResponseMultiError) Error ¶ added in v0.10.0
func (m StreamMetricsResponseMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type StreamMetricsResponseValidationError ¶
type StreamMetricsResponseValidationError struct {
// contains filtered or unexported fields
}
StreamMetricsResponseValidationError is the validation error returned by StreamMetricsResponse.Validate if the designated constraints aren't met.
func (StreamMetricsResponseValidationError) Cause ¶
func (e StreamMetricsResponseValidationError) Cause() error
Cause function returns cause value.
func (StreamMetricsResponseValidationError) Error ¶
func (e StreamMetricsResponseValidationError) Error() string
Error satisfies the builtin error interface
func (StreamMetricsResponseValidationError) ErrorName ¶
func (e StreamMetricsResponseValidationError) ErrorName() string
ErrorName returns error name.
func (StreamMetricsResponseValidationError) Field ¶
func (e StreamMetricsResponseValidationError) Field() string
Field function returns field value.
func (StreamMetricsResponseValidationError) Key ¶
func (e StreamMetricsResponseValidationError) Key() bool
Key function returns key value.
func (StreamMetricsResponseValidationError) Reason ¶
func (e StreamMetricsResponseValidationError) Reason() string
Reason function returns reason value.
type UnimplementedMetricsServiceServer ¶
type UnimplementedMetricsServiceServer struct { }
UnimplementedMetricsServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedMetricsServiceServer) StreamMetrics ¶
func (UnimplementedMetricsServiceServer) StreamMetrics(MetricsService_StreamMetricsServer) error
type UnsafeMetricsServiceServer ¶ added in v0.13.0
type UnsafeMetricsServiceServer interface {
// contains filtered or unexported methods
}
UnsafeMetricsServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to MetricsServiceServer will result in compilation errors.