metricsv2grpc

Documentation

Index

• Constants
• Variables
• func RegisterMetricsServiceServer(s grpc.ServiceRegistrar, srv MetricsServiceServer)
• type MetricsServiceClient
  • func NewMetricsServiceClient(cc grpc.ClientConnInterface) MetricsServiceClient
• type MetricsServiceServer
• type MetricsService_StreamMetricsClient
• type MetricsService_StreamMetricsServer
• type UnimplementedMetricsServiceServer
  • func (UnimplementedMetricsServiceServer) StreamMetrics(grpc.ClientStreamingServer[v2.StreamMetricsMessage, v2.StreamMetricsResponse]) error
• type UnsafeMetricsServiceServer

Constants

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

Variables

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[v2.StreamMetricsMessage, v2.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[v2.StreamMetricsMessage, v2.StreamMetricsResponse]) error
}

MetricsServiceServer is the server API for MetricsService service. All implementations should 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[v2.StreamMetricsMessage, v2.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[v2.StreamMetricsMessage, v2.StreamMetricsResponse]

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

type UnimplementedMetricsServiceServer

type UnimplementedMetricsServiceServer struct{}

UnimplementedMetricsServiceServer should 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[v2.StreamMetricsMessage, v2.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.