pmetricotlp

Documentation

Index

• func RegisterServer(s *grpc.Server, srv GRPCServer)
• type Client
• type GRPCClient
  • func NewClient(cc *grpc.ClientConn) GRPCClient
• type GRPCServer
• type Request
  • func NewRequest() Request
  • func NewRequestFromMetrics(md pmetric.Metrics) Request
  • func (mr Request) MarshalJSON() ([]byte, error)
  • func (mr Request) MarshalProto() ([]byte, error)
  • func (mr Request) Metrics() pmetric.Metrics
  • func (mr Request) UnmarshalJSON(data []byte) error
  • func (mr Request) UnmarshalProto(data []byte) error
• type Response
  • func NewResponse() Response
  • func (mr Response) MarshalJSON() ([]byte, error)
  • func (mr Response) MarshalProto() ([]byte, error)
  • func (mr Response) UnmarshalJSON(data []byte) error
  • func (mr Response) UnmarshalProto(data []byte) error
• type Server

Functions

func RegisterServer

func RegisterServer(s *grpc.Server, srv GRPCServer)

RegisterServer registers the GRPCServer to the grpc.Server.

Types

type Client

type Client = GRPCClient

Deprecated: [0.61.0] Use GRPCClient instead

type GRPCClient

type GRPCClient interface {
	// Export pmetric.Metrics to the server.
	//
	// For performance reasons, it is recommended to keep this RPC
	// alive for the entire life of the application.
	Export(ctx context.Context, request Request, opts ...grpc.CallOption) (Response, error)
}

GRPCClient is the client API for OTLP-GRPC Metrics service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewClient

func NewClient(cc *grpc.ClientConn) GRPCClient

NewClient returns a new Client connected using the given connection.

type GRPCServer

type GRPCServer interface {
	// Export is called every time a new request is received.
	//
	// For performance reasons, it is recommended to keep this RPC
	// alive for the entire life of the application.
	Export(context.Context, Request) (Response, error)
}

GRPCServer is the server API for OTLP gRPC MetricsService service.

type Request

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

Request represents the request for gRPC/HTTP client/server. It's a wrapper for pmetric.Metrics data.

func NewRequest

func NewRequest() Request

NewRequest returns an empty Request.

func NewRequestFromMetrics

func NewRequestFromMetrics(md pmetric.Metrics) Request

NewRequestFromMetrics returns a Request from pmetric.Metrics. Because Request is a wrapper for pmetric.Metrics, any changes to the provided Metrics struct will be reflected in the Request and vice versa.

func (Request) MarshalJSON

func (mr Request) MarshalJSON() ([]byte, error)

MarshalJSON marshals Request into JSON bytes.

func (Request) MarshalProto

func (mr Request) MarshalProto() ([]byte, error)

MarshalProto marshals Request into proto bytes.

func (Request) Metrics

func (mr Request) Metrics() pmetric.Metrics

func (Request) UnmarshalJSON

func (mr Request) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshalls Request from JSON bytes.

func (Request) UnmarshalProto

func (mr Request) UnmarshalProto(data []byte) error

UnmarshalProto unmarshalls Request from proto bytes.

type Response

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

Response represents the response for gRPC/HTTP client/server.

func NewResponse

func NewResponse() Response

NewResponse returns an empty Response.

func (Response) MarshalJSON

func (mr Response) MarshalJSON() ([]byte, error)

MarshalJSON marshals Response into JSON bytes.

func (Response) MarshalProto

func (mr Response) MarshalProto() ([]byte, error)

MarshalProto marshals Response into proto bytes.

func (Response) UnmarshalJSON

func (mr Response) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshalls Response from JSON bytes.

func (Response) UnmarshalProto

func (mr Response) UnmarshalProto(data []byte) error

UnmarshalProto unmarshalls Response from proto bytes.

type Server

type Server = GRPCServer

Deprecated: [0.61.0] Use GRPCServer instead