metricsv2

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Aug 8, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MetricsService_StreamMetrics_FullMethodName = "/envoy.service.metrics.v2.MetricsService/StreamMetrics"
)

Variables

View Source 
var File_envoy_service_metrics_v2_metrics_service_proto protoreflect.FileDescriptor
View Source 
var MetricsService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "envoy.service.metrics.v2.MetricsService",
	HandlerType: (*MetricsServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamMetrics",
			Handler:       _MetricsService_StreamMetrics_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "envoy/service/metrics/v2/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) (grpc.ClientStreamingClient[StreamMetricsMessage, StreamMetricsResponse], 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.

Service for streaming metrics to server that consumes the metrics data. It uses Prometheus metric data model as a standard to represent metrics information.

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(grpc.ClientStreamingServer[StreamMetricsMessage, StreamMetricsResponse]) error
	// contains filtered or unexported methods
}

MetricsServiceServer is the server API for MetricsService service. All implementations must embed UnimplementedMetricsServiceServer for forward compatibility.

Service for streaming metrics to server that consumes the metrics data. It uses Prometheus metric data model as a standard to represent metrics information.

type MetricsService_StreamMetricsClient 

type MetricsService_StreamMetricsClient = grpc.ClientStreamingClient[StreamMetricsMessage, StreamMetricsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type MetricsService_StreamMetricsServer 

type MetricsService_StreamMetricsServer = grpc.ClientStreamingServer[StreamMetricsMessage, StreamMetricsResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

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 

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

func (*StreamMetricsMessage) Reset 

func (x *StreamMetricsMessage) Reset()

func (*StreamMetricsMessage) String 

func (x *StreamMetricsMessage) String() string

type StreamMetricsMessage_Identifier 

type StreamMetricsMessage_Identifier struct {

	// The node sending metrics over the stream.
	Node *core.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() *core.Node

func (*StreamMetricsMessage_Identifier) ProtoMessage 

func (*StreamMetricsMessage_Identifier) ProtoMessage()

func (*StreamMetricsMessage_Identifier) ProtoReflect 

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

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 

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

func (*StreamMetricsResponse) Reset 

func (x *StreamMetricsResponse) Reset()

func (*StreamMetricsResponse) String 

func (x *StreamMetricsResponse) String() string

type UnimplementedMetricsServiceServer 

type UnimplementedMetricsServiceServer struct{}

UnimplementedMetricsServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedMetricsServiceServer) StreamMetrics 

func (UnimplementedMetricsServiceServer) StreamMetrics(grpc.ClientStreamingServer[StreamMetricsMessage, StreamMetricsResponse]) error

type UnsafeMetricsServiceServer 

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.