v1development

package
v1.4.0 Latest Latest
Warning

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

 Go to latest Published: Dec 2, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package v1development is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var File_opentelemetry_proto_collector_profiles_v1development_profiles_service_proto protoreflect.FileDescriptor
View Source 
var ProfilesService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "opentelemetry.proto.collector.profiles.v1development.ProfilesService",
	HandlerType: (*ProfilesServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Export",
			Handler:    _ProfilesService_Export_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "opentelemetry/proto/collector/profiles/v1development/profiles_service.proto",
}

ProfilesService_ServiceDesc is the grpc.ServiceDesc for ProfilesService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterProfilesServiceHandler 

func RegisterProfilesServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterProfilesServiceHandler registers the http handlers for service ProfilesService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterProfilesServiceHandlerClient 

func RegisterProfilesServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ProfilesServiceClient) error

RegisterProfilesServiceHandlerClient registers the http handlers for service ProfilesService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ProfilesServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ProfilesServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ProfilesServiceClient" to call the correct interceptors.

func RegisterProfilesServiceHandlerFromEndpoint 

func RegisterProfilesServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterProfilesServiceHandlerFromEndpoint is same as RegisterProfilesServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterProfilesServiceHandlerServer 

func RegisterProfilesServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ProfilesServiceServer) error

RegisterProfilesServiceHandlerServer registers the http handlers for service ProfilesService to "mux". UnaryRPC :call ProfilesServiceServer 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 RegisterProfilesServiceHandlerFromEndpoint instead.

func RegisterProfilesServiceServer 

func RegisterProfilesServiceServer(s grpc.ServiceRegistrar, srv ProfilesServiceServer)

Types

type ExportProfilesPartialSuccess 

type ExportProfilesPartialSuccess struct {

	// The number of rejected profiles.
	//
	// A `rejected_<signal>` field holding a `0` value indicates that the
	// request was fully accepted.
	RejectedProfiles int64 `protobuf:"varint,1,opt,name=rejected_profiles,json=rejectedProfiles,proto3" json:"rejected_profiles,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 (*ExportProfilesPartialSuccess) Descriptor deprecated 

func (*ExportProfilesPartialSuccess) Descriptor() ([]byte, []int)

Deprecated: Use ExportProfilesPartialSuccess.ProtoReflect.Descriptor instead.

func (*ExportProfilesPartialSuccess) GetErrorMessage 

func (x *ExportProfilesPartialSuccess) GetErrorMessage() string

func (*ExportProfilesPartialSuccess) GetRejectedProfiles 

func (x *ExportProfilesPartialSuccess) GetRejectedProfiles() int64

func (*ExportProfilesPartialSuccess) ProtoMessage 

func (*ExportProfilesPartialSuccess) ProtoMessage()

func (*ExportProfilesPartialSuccess) ProtoReflect 

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

func (*ExportProfilesPartialSuccess) Reset 

func (x *ExportProfilesPartialSuccess) Reset()

func (*ExportProfilesPartialSuccess) String 

func (x *ExportProfilesPartialSuccess) String() string

type ExportProfilesServiceRequest 

type ExportProfilesServiceRequest struct {

	// An array of ResourceProfiles.
	// 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.
	ResourceProfiles []*v1development.ResourceProfiles `protobuf:"bytes,1,rep,name=resource_profiles,json=resourceProfiles,proto3" json:"resource_profiles,omitempty"`
	// contains filtered or unexported fields
}

func (*ExportProfilesServiceRequest) Descriptor deprecated 

func (*ExportProfilesServiceRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportProfilesServiceRequest.ProtoReflect.Descriptor instead.

func (*ExportProfilesServiceRequest) GetResourceProfiles 

func (x *ExportProfilesServiceRequest) GetResourceProfiles() []*v1development.ResourceProfiles

func (*ExportProfilesServiceRequest) ProtoMessage 

func (*ExportProfilesServiceRequest) ProtoMessage()

func (*ExportProfilesServiceRequest) ProtoReflect 

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

func (*ExportProfilesServiceRequest) Reset 

func (x *ExportProfilesServiceRequest) Reset()

func (*ExportProfilesServiceRequest) String 

func (x *ExportProfilesServiceRequest) String() string

type ExportProfilesServiceResponse 

type ExportProfilesServiceResponse 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 *ExportProfilesPartialSuccess `protobuf:"bytes,1,opt,name=partial_success,json=partialSuccess,proto3" json:"partial_success,omitempty"`
	// contains filtered or unexported fields
}

func (*ExportProfilesServiceResponse) Descriptor deprecated 

func (*ExportProfilesServiceResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportProfilesServiceResponse.ProtoReflect.Descriptor instead.

func (*ExportProfilesServiceResponse) GetPartialSuccess 

func (x *ExportProfilesServiceResponse) GetPartialSuccess() *ExportProfilesPartialSuccess

func (*ExportProfilesServiceResponse) ProtoMessage 

func (*ExportProfilesServiceResponse) ProtoMessage()

func (*ExportProfilesServiceResponse) ProtoReflect 

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

func (*ExportProfilesServiceResponse) Reset 

func (x *ExportProfilesServiceResponse) Reset()

func (*ExportProfilesServiceResponse) String 

func (x *ExportProfilesServiceResponse) String() string

type ProfilesServiceClient 

type ProfilesServiceClient interface {
	// For performance reasons, it is recommended to keep this RPC
	// alive for the entire life of the application.
	Export(ctx context.Context, in *ExportProfilesServiceRequest, opts ...grpc.CallOption) (*ExportProfilesServiceResponse, error)
}

ProfilesServiceClient is the client API for ProfilesService 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 NewProfilesServiceClient 

func NewProfilesServiceClient(cc grpc.ClientConnInterface) ProfilesServiceClient

type ProfilesServiceServer 

type ProfilesServiceServer interface {
	// For performance reasons, it is recommended to keep this RPC
	// alive for the entire life of the application.
	Export(context.Context, *ExportProfilesServiceRequest) (*ExportProfilesServiceResponse, error)
	// contains filtered or unexported methods
}

ProfilesServiceServer is the server API for ProfilesService service. All implementations must embed UnimplementedProfilesServiceServer for forward compatibility

type UnimplementedProfilesServiceServer 

type UnimplementedProfilesServiceServer struct {
}

UnimplementedProfilesServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedProfilesServiceServer) Export 

func (UnimplementedProfilesServiceServer) Export(context.Context, *ExportProfilesServiceRequest) (*ExportProfilesServiceResponse, error)

type UnsafeProfilesServiceServer 

type UnsafeProfilesServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeProfilesServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ProfilesServiceServer 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.