Documentation

Overview

    Package v1 is a reverse proxy.

    It translates gRPC into RESTful JSON APIs.

    Index

    Constants

    This section is empty.

    Variables

    View Source
    var (
    	ErrInvalidLengthTraceConfig        = fmt.Errorf("proto: negative length found during unmarshaling")
    	ErrIntOverflowTraceConfig          = fmt.Errorf("proto: integer overflow")
    	ErrUnexpectedEndOfGroupTraceConfig = fmt.Errorf("proto: unexpected end of group")
    )
    View Source
    var (
    	ErrInvalidLengthTraceService        = fmt.Errorf("proto: negative length found during unmarshaling")
    	ErrIntOverflowTraceService          = fmt.Errorf("proto: integer overflow")
    	ErrUnexpectedEndOfGroupTraceService = fmt.Errorf("proto: unexpected end of group")
    )
    View Source
    var ConstantSampler_ConstantDecision_name = map[int32]string{
    	0: "ALWAYS_OFF",
    	1: "ALWAYS_ON",
    	2: "ALWAYS_PARENT",
    }
    View Source
    var ConstantSampler_ConstantDecision_value = map[string]int32{
    	"ALWAYS_OFF":    0,
    	"ALWAYS_ON":     1,
    	"ALWAYS_PARENT": 2,
    }

    Functions

    func RegisterTraceServiceHandler

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

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

      func RegisterTraceServiceHandlerClient

      func RegisterTraceServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TraceServiceClient) error

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

        func RegisterTraceServiceHandlerFromEndpoint

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

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

          func RegisterTraceServiceHandlerServer

          func RegisterTraceServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TraceServiceServer) error

            RegisterTraceServiceHandlerServer registers the http handlers for service TraceService to "mux". UnaryRPC :call TraceServiceServer 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 RegisterTraceServiceHandlerFromEndpoint instead.

            func RegisterTraceServiceHandlerServerAlias

            func RegisterTraceServiceHandlerServerAlias(ctx context.Context, mux *runtime.ServeMux, server TraceServiceServer) error

              RegisterTraceServiceHandlerServerAlias registers the http handlers for service TraceService to "mux". UnaryRPC :call TraceServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.

              RegisterTraceServiceHandlerServerAlias is the alias version of RegisterTraceServiceHandlerServer, and uses patternTraceServiceExport0Alias instead of pattern_TraceService_Export_0.

              func RegisterTraceServiceServer

              func RegisterTraceServiceServer(s *grpc.Server, srv TraceServiceServer)

              Types

              type ConstantSampler

              type ConstantSampler struct {
              	Decision ConstantSampler_ConstantDecision `` /* 137-byte string literal not displayed */
              }

                Sampler that always makes a constant decision on span sampling.

                func (*ConstantSampler) Descriptor

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

                func (*ConstantSampler) GetDecision

                func (*ConstantSampler) Marshal

                func (m *ConstantSampler) Marshal() (dAtA []byte, err error)

                func (*ConstantSampler) MarshalTo

                func (m *ConstantSampler) MarshalTo(dAtA []byte) (int, error)

                func (*ConstantSampler) MarshalToSizedBuffer

                func (m *ConstantSampler) MarshalToSizedBuffer(dAtA []byte) (int, error)

                func (*ConstantSampler) ProtoMessage

                func (*ConstantSampler) ProtoMessage()

                func (*ConstantSampler) Reset

                func (m *ConstantSampler) Reset()

                func (*ConstantSampler) Size

                func (m *ConstantSampler) Size() (n int)

                func (*ConstantSampler) String

                func (m *ConstantSampler) String() string

                func (*ConstantSampler) Unmarshal

                func (m *ConstantSampler) Unmarshal(dAtA []byte) error

                func (*ConstantSampler) XXX_DiscardUnknown

                func (m *ConstantSampler) XXX_DiscardUnknown()

                func (*ConstantSampler) XXX_Marshal

                func (m *ConstantSampler) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                func (*ConstantSampler) XXX_Merge

                func (m *ConstantSampler) XXX_Merge(src proto.Message)

                func (*ConstantSampler) XXX_Size

                func (m *ConstantSampler) XXX_Size() int

                func (*ConstantSampler) XXX_Unmarshal

                func (m *ConstantSampler) XXX_Unmarshal(b []byte) error

                type ConstantSampler_ConstantDecision

                type ConstantSampler_ConstantDecision int32

                  How spans should be sampled: - Always off - Always on - Always follow the parent Span's decision (off if no parent).

                  const (
                  	ConstantSampler_ALWAYS_OFF    ConstantSampler_ConstantDecision = 0
                  	ConstantSampler_ALWAYS_ON     ConstantSampler_ConstantDecision = 1
                  	ConstantSampler_ALWAYS_PARENT ConstantSampler_ConstantDecision = 2
                  )

                  func (ConstantSampler_ConstantDecision) EnumDescriptor

                  func (ConstantSampler_ConstantDecision) EnumDescriptor() ([]byte, []int)

                  func (ConstantSampler_ConstantDecision) String

                  type ExportTraceServiceRequest

                  type ExportTraceServiceRequest struct {
                  	// An array of ResourceSpans.
                  	// 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.
                  	ResourceSpans []*v1.ResourceSpans `protobuf:"bytes,1,rep,name=resource_spans,json=resourceSpans,proto3" json:"resource_spans,omitempty"`
                  }

                  func (*ExportTraceServiceRequest) Descriptor

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

                  func (*ExportTraceServiceRequest) GetResourceSpans

                  func (m *ExportTraceServiceRequest) GetResourceSpans() []*v1.ResourceSpans

                  func (*ExportTraceServiceRequest) Marshal

                  func (m *ExportTraceServiceRequest) Marshal() (dAtA []byte, err error)

                  func (*ExportTraceServiceRequest) MarshalTo

                  func (m *ExportTraceServiceRequest) MarshalTo(dAtA []byte) (int, error)

                  func (*ExportTraceServiceRequest) MarshalToSizedBuffer

                  func (m *ExportTraceServiceRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

                  func (*ExportTraceServiceRequest) ProtoMessage

                  func (*ExportTraceServiceRequest) ProtoMessage()

                  func (*ExportTraceServiceRequest) Reset

                  func (m *ExportTraceServiceRequest) Reset()

                  func (*ExportTraceServiceRequest) Size

                  func (m *ExportTraceServiceRequest) Size() (n int)

                  func (*ExportTraceServiceRequest) String

                  func (m *ExportTraceServiceRequest) String() string

                  func (*ExportTraceServiceRequest) Unmarshal

                  func (m *ExportTraceServiceRequest) Unmarshal(dAtA []byte) error

                  func (*ExportTraceServiceRequest) XXX_DiscardUnknown

                  func (m *ExportTraceServiceRequest) XXX_DiscardUnknown()

                  func (*ExportTraceServiceRequest) XXX_Marshal

                  func (m *ExportTraceServiceRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                  func (*ExportTraceServiceRequest) XXX_Merge

                  func (m *ExportTraceServiceRequest) XXX_Merge(src proto.Message)

                  func (*ExportTraceServiceRequest) XXX_Size

                  func (m *ExportTraceServiceRequest) XXX_Size() int

                  func (*ExportTraceServiceRequest) XXX_Unmarshal

                  func (m *ExportTraceServiceRequest) XXX_Unmarshal(b []byte) error

                  type ExportTraceServiceResponse

                  type ExportTraceServiceResponse struct {
                  }

                  func (*ExportTraceServiceResponse) Descriptor

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

                  func (*ExportTraceServiceResponse) Marshal

                  func (m *ExportTraceServiceResponse) Marshal() (dAtA []byte, err error)

                  func (*ExportTraceServiceResponse) MarshalTo

                  func (m *ExportTraceServiceResponse) MarshalTo(dAtA []byte) (int, error)

                  func (*ExportTraceServiceResponse) MarshalToSizedBuffer

                  func (m *ExportTraceServiceResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

                  func (*ExportTraceServiceResponse) ProtoMessage

                  func (*ExportTraceServiceResponse) ProtoMessage()

                  func (*ExportTraceServiceResponse) Reset

                  func (m *ExportTraceServiceResponse) Reset()

                  func (*ExportTraceServiceResponse) Size

                  func (m *ExportTraceServiceResponse) Size() (n int)

                  func (*ExportTraceServiceResponse) String

                  func (m *ExportTraceServiceResponse) String() string

                  func (*ExportTraceServiceResponse) Unmarshal

                  func (m *ExportTraceServiceResponse) Unmarshal(dAtA []byte) error

                  func (*ExportTraceServiceResponse) XXX_DiscardUnknown

                  func (m *ExportTraceServiceResponse) XXX_DiscardUnknown()

                  func (*ExportTraceServiceResponse) XXX_Marshal

                  func (m *ExportTraceServiceResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                  func (*ExportTraceServiceResponse) XXX_Merge

                  func (m *ExportTraceServiceResponse) XXX_Merge(src proto.Message)

                  func (*ExportTraceServiceResponse) XXX_Size

                  func (m *ExportTraceServiceResponse) XXX_Size() int

                  func (*ExportTraceServiceResponse) XXX_Unmarshal

                  func (m *ExportTraceServiceResponse) XXX_Unmarshal(b []byte) error

                  type RateLimitingSampler

                  type RateLimitingSampler struct {
                  	// Rate per second.
                  	Qps int64 `protobuf:"varint,1,opt,name=qps,proto3" json:"qps,omitempty"`
                  }

                    Sampler that tries to sample with a rate per time window.

                    func (*RateLimitingSampler) Descriptor

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

                    func (*RateLimitingSampler) GetQps

                    func (m *RateLimitingSampler) GetQps() int64

                    func (*RateLimitingSampler) Marshal

                    func (m *RateLimitingSampler) Marshal() (dAtA []byte, err error)

                    func (*RateLimitingSampler) MarshalTo

                    func (m *RateLimitingSampler) MarshalTo(dAtA []byte) (int, error)

                    func (*RateLimitingSampler) MarshalToSizedBuffer

                    func (m *RateLimitingSampler) MarshalToSizedBuffer(dAtA []byte) (int, error)

                    func (*RateLimitingSampler) ProtoMessage

                    func (*RateLimitingSampler) ProtoMessage()

                    func (*RateLimitingSampler) Reset

                    func (m *RateLimitingSampler) Reset()

                    func (*RateLimitingSampler) Size

                    func (m *RateLimitingSampler) Size() (n int)

                    func (*RateLimitingSampler) String

                    func (m *RateLimitingSampler) String() string

                    func (*RateLimitingSampler) Unmarshal

                    func (m *RateLimitingSampler) Unmarshal(dAtA []byte) error

                    func (*RateLimitingSampler) XXX_DiscardUnknown

                    func (m *RateLimitingSampler) XXX_DiscardUnknown()

                    func (*RateLimitingSampler) XXX_Marshal

                    func (m *RateLimitingSampler) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                    func (*RateLimitingSampler) XXX_Merge

                    func (m *RateLimitingSampler) XXX_Merge(src proto.Message)

                    func (*RateLimitingSampler) XXX_Size

                    func (m *RateLimitingSampler) XXX_Size() int

                    func (*RateLimitingSampler) XXX_Unmarshal

                    func (m *RateLimitingSampler) XXX_Unmarshal(b []byte) error

                    type TraceConfig

                    type TraceConfig struct {
                    	// The global default sampler used to make decisions on span sampling.
                    	//
                    	// Types that are valid to be assigned to Sampler:
                    	//	*TraceConfig_ConstantSampler
                    	//	*TraceConfig_TraceIdRatioBased
                    	//	*TraceConfig_RateLimitingSampler
                    	Sampler isTraceConfig_Sampler `protobuf_oneof:"sampler"`
                    	// The global default max number of attributes per span.
                    	MaxNumberOfAttributes int64 `` /* 129-byte string literal not displayed */
                    	// The global default max number of annotation events per span.
                    	MaxNumberOfTimedEvents int64 `` /* 134-byte string literal not displayed */
                    	// The global default max number of attributes per timed event.
                    	MaxNumberOfAttributesPerTimedEvent int64 `` /* 174-byte string literal not displayed */
                    	// The global default max number of link entries per span.
                    	MaxNumberOfLinks int64 `protobuf:"varint,7,opt,name=max_number_of_links,json=maxNumberOfLinks,proto3" json:"max_number_of_links,omitempty"`
                    	// The global default max number of attributes per span.
                    	MaxNumberOfAttributesPerLink int64 `` /* 154-byte string literal not displayed */
                    }

                      Global configuration of the trace service. All fields must be specified, or the default (zero) values will be used for each type.

                      func (*TraceConfig) Descriptor

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

                      func (*TraceConfig) GetConstantSampler

                      func (m *TraceConfig) GetConstantSampler() *ConstantSampler

                      func (*TraceConfig) GetMaxNumberOfAttributes

                      func (m *TraceConfig) GetMaxNumberOfAttributes() int64
                      func (m *TraceConfig) GetMaxNumberOfAttributesPerLink() int64

                      func (*TraceConfig) GetMaxNumberOfAttributesPerTimedEvent

                      func (m *TraceConfig) GetMaxNumberOfAttributesPerTimedEvent() int64
                      func (m *TraceConfig) GetMaxNumberOfLinks() int64

                      func (*TraceConfig) GetMaxNumberOfTimedEvents

                      func (m *TraceConfig) GetMaxNumberOfTimedEvents() int64

                      func (*TraceConfig) GetRateLimitingSampler

                      func (m *TraceConfig) GetRateLimitingSampler() *RateLimitingSampler

                      func (*TraceConfig) GetSampler

                      func (m *TraceConfig) GetSampler() isTraceConfig_Sampler

                      func (*TraceConfig) GetTraceIdRatioBased

                      func (m *TraceConfig) GetTraceIdRatioBased() *TraceIdRatioBased

                      func (*TraceConfig) Marshal

                      func (m *TraceConfig) Marshal() (dAtA []byte, err error)

                      func (*TraceConfig) MarshalTo

                      func (m *TraceConfig) MarshalTo(dAtA []byte) (int, error)

                      func (*TraceConfig) MarshalToSizedBuffer

                      func (m *TraceConfig) MarshalToSizedBuffer(dAtA []byte) (int, error)

                      func (*TraceConfig) ProtoMessage

                      func (*TraceConfig) ProtoMessage()

                      func (*TraceConfig) Reset

                      func (m *TraceConfig) Reset()

                      func (*TraceConfig) Size

                      func (m *TraceConfig) Size() (n int)

                      func (*TraceConfig) String

                      func (m *TraceConfig) String() string

                      func (*TraceConfig) Unmarshal

                      func (m *TraceConfig) Unmarshal(dAtA []byte) error

                      func (*TraceConfig) XXX_DiscardUnknown

                      func (m *TraceConfig) XXX_DiscardUnknown()

                      func (*TraceConfig) XXX_Marshal

                      func (m *TraceConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                      func (*TraceConfig) XXX_Merge

                      func (m *TraceConfig) XXX_Merge(src proto.Message)

                      func (*TraceConfig) XXX_OneofWrappers

                      func (*TraceConfig) XXX_OneofWrappers() []interface{}

                        XXX_OneofWrappers is for the internal use of the proto package.

                        func (*TraceConfig) XXX_Size

                        func (m *TraceConfig) XXX_Size() int

                        func (*TraceConfig) XXX_Unmarshal

                        func (m *TraceConfig) XXX_Unmarshal(b []byte) error

                        type TraceConfig_ConstantSampler

                        type TraceConfig_ConstantSampler struct {
                        	ConstantSampler *ConstantSampler `protobuf:"bytes,1,opt,name=constant_sampler,json=constantSampler,proto3,oneof" json:"constant_sampler,omitempty"`
                        }

                        func (*TraceConfig_ConstantSampler) MarshalTo

                        func (m *TraceConfig_ConstantSampler) MarshalTo(dAtA []byte) (int, error)

                        func (*TraceConfig_ConstantSampler) MarshalToSizedBuffer

                        func (m *TraceConfig_ConstantSampler) MarshalToSizedBuffer(dAtA []byte) (int, error)

                        func (*TraceConfig_ConstantSampler) Size

                        func (m *TraceConfig_ConstantSampler) Size() (n int)

                        type TraceConfig_RateLimitingSampler

                        type TraceConfig_RateLimitingSampler struct {
                        	RateLimitingSampler *RateLimitingSampler `` /* 126-byte string literal not displayed */
                        }

                        func (*TraceConfig_RateLimitingSampler) MarshalTo

                        func (m *TraceConfig_RateLimitingSampler) MarshalTo(dAtA []byte) (int, error)

                        func (*TraceConfig_RateLimitingSampler) MarshalToSizedBuffer

                        func (m *TraceConfig_RateLimitingSampler) MarshalToSizedBuffer(dAtA []byte) (int, error)

                        func (*TraceConfig_RateLimitingSampler) Size

                        func (m *TraceConfig_RateLimitingSampler) Size() (n int)

                        type TraceConfig_TraceIdRatioBased

                        type TraceConfig_TraceIdRatioBased struct {
                        	TraceIdRatioBased *TraceIdRatioBased `protobuf:"bytes,2,opt,name=trace_id_ratio_based,json=traceIdRatioBased,proto3,oneof" json:"trace_id_ratio_based,omitempty"`
                        }

                        func (*TraceConfig_TraceIdRatioBased) MarshalTo

                        func (m *TraceConfig_TraceIdRatioBased) MarshalTo(dAtA []byte) (int, error)

                        func (*TraceConfig_TraceIdRatioBased) MarshalToSizedBuffer

                        func (m *TraceConfig_TraceIdRatioBased) MarshalToSizedBuffer(dAtA []byte) (int, error)

                        func (*TraceConfig_TraceIdRatioBased) Size

                        func (m *TraceConfig_TraceIdRatioBased) Size() (n int)

                        type TraceIdRatioBased

                        type TraceIdRatioBased struct {
                        	// The desired ratio of sampling. Must be within [0.0, 1.0].
                        	SamplingRatio float64 `protobuf:"fixed64,1,opt,name=samplingRatio,proto3" json:"samplingRatio,omitempty"`
                        }

                          Sampler that tries to uniformly sample traces with a given ratio. The ratio of sampling a trace is equal to that of the specified ratio.

                          func (*TraceIdRatioBased) Descriptor

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

                          func (*TraceIdRatioBased) GetSamplingRatio

                          func (m *TraceIdRatioBased) GetSamplingRatio() float64

                          func (*TraceIdRatioBased) Marshal

                          func (m *TraceIdRatioBased) Marshal() (dAtA []byte, err error)

                          func (*TraceIdRatioBased) MarshalTo

                          func (m *TraceIdRatioBased) MarshalTo(dAtA []byte) (int, error)

                          func (*TraceIdRatioBased) MarshalToSizedBuffer

                          func (m *TraceIdRatioBased) MarshalToSizedBuffer(dAtA []byte) (int, error)

                          func (*TraceIdRatioBased) ProtoMessage

                          func (*TraceIdRatioBased) ProtoMessage()

                          func (*TraceIdRatioBased) Reset

                          func (m *TraceIdRatioBased) Reset()

                          func (*TraceIdRatioBased) Size

                          func (m *TraceIdRatioBased) Size() (n int)

                          func (*TraceIdRatioBased) String

                          func (m *TraceIdRatioBased) String() string

                          func (*TraceIdRatioBased) Unmarshal

                          func (m *TraceIdRatioBased) Unmarshal(dAtA []byte) error

                          func (*TraceIdRatioBased) XXX_DiscardUnknown

                          func (m *TraceIdRatioBased) XXX_DiscardUnknown()

                          func (*TraceIdRatioBased) XXX_Marshal

                          func (m *TraceIdRatioBased) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                          func (*TraceIdRatioBased) XXX_Merge

                          func (m *TraceIdRatioBased) XXX_Merge(src proto.Message)

                          func (*TraceIdRatioBased) XXX_Size

                          func (m *TraceIdRatioBased) XXX_Size() int

                          func (*TraceIdRatioBased) XXX_Unmarshal

                          func (m *TraceIdRatioBased) XXX_Unmarshal(b []byte) error

                          type TraceServiceClient

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

                            TraceServiceClient is the client API for TraceService service.

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

                            func NewTraceServiceClient

                            func NewTraceServiceClient(cc *grpc.ClientConn) TraceServiceClient

                            type TraceServiceServer

                            type TraceServiceServer interface {
                            	// For performance reasons, it is recommended to keep this RPC
                            	// alive for the entire life of the application.
                            	Export(context.Context, *ExportTraceServiceRequest) (*ExportTraceServiceResponse, error)
                            }

                              TraceServiceServer is the server API for TraceService service.

                              type UnimplementedTraceServiceServer

                              type UnimplementedTraceServiceServer struct {
                              }

                                UnimplementedTraceServiceServer can be embedded to have forward compatible implementations.

                                func (*UnimplementedTraceServiceServer) Export