metricsv3connect

Documentation

Index

• Constants
• func NewMetricsServiceHandler(svc MetricsServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type MetricsServiceClient
  • func NewMetricsServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) MetricsServiceClient
• type MetricsServiceHandler
• type UnimplementedMetricsServiceHandler
  • func (UnimplementedMetricsServiceHandler) StreamMetrics(context.Context, *connect.ClientStream[v3.StreamMetricsMessage]) (*connect.Response[v3.StreamMetricsResponse], error)

Constants

const (
	// MetricsServiceName is the fully-qualified name of the MetricsService service.
	MetricsServiceName = "envoy.service.metrics.v3.MetricsService"
)

const (
	// MetricsServiceStreamMetricsProcedure is the fully-qualified name of the MetricsService's
	// StreamMetrics RPC.
	MetricsServiceStreamMetricsProcedure = "/envoy.service.metrics.v3.MetricsService/StreamMetrics"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

Functions

func NewMetricsServiceHandler

func NewMetricsServiceHandler(svc MetricsServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewMetricsServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

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(context.Context) *connect.ClientStreamForClient[v3.StreamMetricsMessage, v3.StreamMetricsResponse]
}

MetricsServiceClient is a client for the envoy.service.metrics.v3.MetricsService service.

func NewMetricsServiceClient

func NewMetricsServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) MetricsServiceClient

NewMetricsServiceClient constructs a client for the envoy.service.metrics.v3.MetricsService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type MetricsServiceHandler

type MetricsServiceHandler 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(context.Context, *connect.ClientStream[v3.StreamMetricsMessage]) (*connect.Response[v3.StreamMetricsResponse], error)
}

MetricsServiceHandler is an implementation of the envoy.service.metrics.v3.MetricsService service.

type UnimplementedMetricsServiceHandler

type UnimplementedMetricsServiceHandler struct{}

UnimplementedMetricsServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedMetricsServiceHandler) StreamMetrics

func (UnimplementedMetricsServiceHandler) StreamMetrics(context.Context, *connect.ClientStream[v3.StreamMetricsMessage]) (*connect.Response[v3.StreamMetricsResponse], error)