Documentation
¶
Overview ¶
Package v1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterMetricsServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterMetricsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MetricsServiceClient) error
- func RegisterMetricsServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterMetricsServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MetricsServiceServer) error
- func RegisterMetricsServiceServer(s grpc.ServiceRegistrar, srv MetricsServiceServer)
- type ExportMetricsPartialSuccess
- func (*ExportMetricsPartialSuccess) Descriptor() ([]byte, []int)deprecated
- func (x *ExportMetricsPartialSuccess) GetErrorMessage() string
- func (x *ExportMetricsPartialSuccess) GetRejectedDataPoints() int64
- func (*ExportMetricsPartialSuccess) ProtoMessage()
- func (x *ExportMetricsPartialSuccess) ProtoReflect() protoreflect.Message
- func (x *ExportMetricsPartialSuccess) Reset()
- func (x *ExportMetricsPartialSuccess) String() string
- type ExportMetricsServiceRequest
- func (*ExportMetricsServiceRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ExportMetricsServiceRequest) GetResourceMetrics() []*v1.ResourceMetrics
- func (*ExportMetricsServiceRequest) ProtoMessage()
- func (x *ExportMetricsServiceRequest) ProtoReflect() protoreflect.Message
- func (x *ExportMetricsServiceRequest) Reset()
- func (x *ExportMetricsServiceRequest) String() string
- type ExportMetricsServiceResponse
- func (*ExportMetricsServiceResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ExportMetricsServiceResponse) GetPartialSuccess() *ExportMetricsPartialSuccess
- func (*ExportMetricsServiceResponse) ProtoMessage()
- func (x *ExportMetricsServiceResponse) ProtoReflect() protoreflect.Message
- func (x *ExportMetricsServiceResponse) Reset()
- func (x *ExportMetricsServiceResponse) String() string
- type MetricsServiceClient
- type MetricsServiceServer
- type UnimplementedMetricsServiceServer
- type UnsafeMetricsServiceServer
Constants ¶
This section is empty.
Variables ¶
var File_opentelemetry_proto_collector_metrics_v1_metrics_service_proto protoreflect.FileDescriptor
var MetricsService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "opentelemetry.proto.collector.metrics.v1.MetricsService", HandlerType: (*MetricsServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Export", Handler: _MetricsService_Export_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "opentelemetry/proto/collector/metrics/v1/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 RegisterMetricsServiceHandler ¶
func RegisterMetricsServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterMetricsServiceHandler registers the http handlers for service MetricsService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterMetricsServiceHandlerClient ¶
func RegisterMetricsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MetricsServiceClient) error
RegisterMetricsServiceHandlerClient registers the http handlers for service MetricsService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "MetricsServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "MetricsServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "MetricsServiceClient" to call the correct interceptors.
func RegisterMetricsServiceHandlerFromEndpoint ¶
func RegisterMetricsServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterMetricsServiceHandlerFromEndpoint is same as RegisterMetricsServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterMetricsServiceHandlerServer ¶
func RegisterMetricsServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MetricsServiceServer) error
RegisterMetricsServiceHandlerServer registers the http handlers for service MetricsService to "mux". UnaryRPC :call MetricsServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterMetricsServiceHandlerFromEndpoint instead.
func RegisterMetricsServiceServer ¶
func RegisterMetricsServiceServer(s grpc.ServiceRegistrar, srv MetricsServiceServer)
Types ¶
type ExportMetricsPartialSuccess ¶ added in v0.19.0
type ExportMetricsPartialSuccess struct {
// The number of rejected data points.
//
// A `rejected_<signal>` field holding a `0` value indicates that the
// request was fully accepted.
RejectedDataPoints int64 `protobuf:"varint,1,opt,name=rejected_data_points,json=rejectedDataPoints,proto3" json:"rejected_data_points,omitempty"`
// A developer-facing human-readable message in English. It should be used
// either to explain why the server rejected parts of the data during a partial
// success or to convey warnings/suggestions during a full success. The message
// should offer guidance on how users can address such issues.
//
// error_message is an optional field. An error_message with an empty value
// is equivalent to it not being set.
ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
// contains filtered or unexported fields
}
func (*ExportMetricsPartialSuccess) Descriptor
deprecated
added in
v0.19.0
func (*ExportMetricsPartialSuccess) Descriptor() ([]byte, []int)
Deprecated: Use ExportMetricsPartialSuccess.ProtoReflect.Descriptor instead.
func (*ExportMetricsPartialSuccess) GetErrorMessage ¶ added in v0.19.0
func (x *ExportMetricsPartialSuccess) GetErrorMessage() string
func (*ExportMetricsPartialSuccess) GetRejectedDataPoints ¶ added in v0.19.0
func (x *ExportMetricsPartialSuccess) GetRejectedDataPoints() int64
func (*ExportMetricsPartialSuccess) ProtoMessage ¶ added in v0.19.0
func (*ExportMetricsPartialSuccess) ProtoMessage()
func (*ExportMetricsPartialSuccess) ProtoReflect ¶ added in v0.19.0
func (x *ExportMetricsPartialSuccess) ProtoReflect() protoreflect.Message
func (*ExportMetricsPartialSuccess) Reset ¶ added in v0.19.0
func (x *ExportMetricsPartialSuccess) Reset()
func (*ExportMetricsPartialSuccess) String ¶ added in v0.19.0
func (x *ExportMetricsPartialSuccess) String() string
type ExportMetricsServiceRequest ¶
type ExportMetricsServiceRequest struct {
// An array of ResourceMetrics.
// For data coming from a single resource this array will typically contain one
// element. Intermediary nodes (such as OpenTelemetry Collector) that receive
// data from multiple origins typically batch the data before forwarding further and
// in that case this array will contain multiple elements.
ResourceMetrics []*v1.ResourceMetrics `protobuf:"bytes,1,rep,name=resource_metrics,json=resourceMetrics,proto3" json:"resource_metrics,omitempty"`
// contains filtered or unexported fields
}
func (*ExportMetricsServiceRequest) Descriptor
deprecated
func (*ExportMetricsServiceRequest) Descriptor() ([]byte, []int)
Deprecated: Use ExportMetricsServiceRequest.ProtoReflect.Descriptor instead.
func (*ExportMetricsServiceRequest) GetResourceMetrics ¶
func (x *ExportMetricsServiceRequest) GetResourceMetrics() []*v1.ResourceMetrics
func (*ExportMetricsServiceRequest) ProtoMessage ¶
func (*ExportMetricsServiceRequest) ProtoMessage()
func (*ExportMetricsServiceRequest) ProtoReflect ¶
func (x *ExportMetricsServiceRequest) ProtoReflect() protoreflect.Message
func (*ExportMetricsServiceRequest) Reset ¶
func (x *ExportMetricsServiceRequest) Reset()
func (*ExportMetricsServiceRequest) String ¶
func (x *ExportMetricsServiceRequest) String() string
type ExportMetricsServiceResponse ¶
type ExportMetricsServiceResponse struct {
// The details of a partially successful export request.
//
// If the request is only partially accepted
// (i.e. when the server accepts only parts of the data and rejects the rest)
// the server MUST initialize the `partial_success` field and MUST
// set the `rejected_<signal>` with the number of items it rejected.
//
// Servers MAY also make use of the `partial_success` field to convey
// warnings/suggestions to senders even when the request was fully accepted.
// In such cases, the `rejected_<signal>` MUST have a value of `0` and
// the `error_message` MUST be non-empty.
//
// A `partial_success` message with an empty value (rejected_<signal> = 0 and
// `error_message` = "") is equivalent to it not being set/present. Senders
// SHOULD interpret it the same way as in the full success case.
PartialSuccess *ExportMetricsPartialSuccess `protobuf:"bytes,1,opt,name=partial_success,json=partialSuccess,proto3" json:"partial_success,omitempty"`
// contains filtered or unexported fields
}
func (*ExportMetricsServiceResponse) Descriptor
deprecated
func (*ExportMetricsServiceResponse) Descriptor() ([]byte, []int)
Deprecated: Use ExportMetricsServiceResponse.ProtoReflect.Descriptor instead.
func (*ExportMetricsServiceResponse) GetPartialSuccess ¶ added in v0.19.0
func (x *ExportMetricsServiceResponse) GetPartialSuccess() *ExportMetricsPartialSuccess
func (*ExportMetricsServiceResponse) ProtoMessage ¶
func (*ExportMetricsServiceResponse) ProtoMessage()
func (*ExportMetricsServiceResponse) ProtoReflect ¶
func (x *ExportMetricsServiceResponse) ProtoReflect() protoreflect.Message
func (*ExportMetricsServiceResponse) Reset ¶
func (x *ExportMetricsServiceResponse) Reset()
func (*ExportMetricsServiceResponse) String ¶
func (x *ExportMetricsServiceResponse) String() string
type MetricsServiceClient ¶
type MetricsServiceClient interface {
Export(ctx context.Context, in *ExportMetricsServiceRequest, opts ...grpc.CallOption) (*ExportMetricsServiceResponse, 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 {
Export(context.Context, *ExportMetricsServiceRequest) (*ExportMetricsServiceResponse, error)
// contains filtered or unexported methods
}
MetricsServiceServer is the server API for MetricsService service. All implementations must embed UnimplementedMetricsServiceServer for forward compatibility
type UnimplementedMetricsServiceServer ¶
type UnimplementedMetricsServiceServer struct {
}
UnimplementedMetricsServiceServer must be embedded to have forward compatible implementations.
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.