api_v3

package
v1.25.0 Latest Latest
Warning

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

 Go to latest Published: Aug 5, 2021 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package api_v3 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterQueryServiceHandler 

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

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

func RegisterQueryServiceHandlerClient 

func RegisterQueryServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client QueryServiceClient) error

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

func RegisterQueryServiceHandlerFromEndpoint 

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

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

func RegisterQueryServiceHandlerServer 

func RegisterQueryServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server QueryServiceServer) error

RegisterQueryServiceHandlerServer registers the http handlers for service QueryService to "mux". UnaryRPC :call QueryServiceServer 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 RegisterQueryServiceHandlerFromEndpoint instead.

func RegisterQueryServiceServer 

func RegisterQueryServiceServer(s *grpc.Server, srv QueryServiceServer)

Types

type FindTracesRequest 

type FindTracesRequest struct {
	Query                *TraceQueryParameters `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	XXX_NoUnkeyedLiteral struct{}              `json:"-"`
	XXX_unrecognized     []byte                `json:"-"`
	XXX_sizecache        int32                 `json:"-"`
}

Request object to search traces.

func (*FindTracesRequest) Descriptor 

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

func (*FindTracesRequest) GetQuery 

func (m *FindTracesRequest) GetQuery() *TraceQueryParameters

func (*FindTracesRequest) ProtoMessage 

func (*FindTracesRequest) ProtoMessage()

func (*FindTracesRequest) Reset 

func (m *FindTracesRequest) Reset()

func (*FindTracesRequest) String 

func (m *FindTracesRequest) String() string

func (*FindTracesRequest) XXX_DiscardUnknown 

func (m *FindTracesRequest) XXX_DiscardUnknown()

func (*FindTracesRequest) XXX_Marshal 

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

func (*FindTracesRequest) XXX_Merge 

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

func (*FindTracesRequest) XXX_Size 

func (m *FindTracesRequest) XXX_Size() int

func (*FindTracesRequest) XXX_Unmarshal 

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

type GetOperationsRequest 

type GetOperationsRequest struct {
	// Required service name.
	Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	// Optional span kind.
	SpanKind             string   `protobuf:"bytes,2,opt,name=span_kind,json=spanKind,proto3" json:"span_kind,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request object to get operation names.

func (*GetOperationsRequest) Descriptor 

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

func (*GetOperationsRequest) GetService 

func (m *GetOperationsRequest) GetService() string

func (*GetOperationsRequest) GetSpanKind 

func (m *GetOperationsRequest) GetSpanKind() string

func (*GetOperationsRequest) ProtoMessage 

func (*GetOperationsRequest) ProtoMessage()

func (*GetOperationsRequest) Reset 

func (m *GetOperationsRequest) Reset()

func (*GetOperationsRequest) String 

func (m *GetOperationsRequest) String() string

func (*GetOperationsRequest) XXX_DiscardUnknown 

func (m *GetOperationsRequest) XXX_DiscardUnknown()

func (*GetOperationsRequest) XXX_Marshal 

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

func (*GetOperationsRequest) XXX_Merge 

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

func (*GetOperationsRequest) XXX_Size 

func (m *GetOperationsRequest) XXX_Size() int

func (*GetOperationsRequest) XXX_Unmarshal 

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

type GetOperationsResponse 

type GetOperationsResponse struct {
	Operations           []*Operation `protobuf:"bytes,1,rep,name=operations,proto3" json:"operations,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

Response object to get operation names.

func (*GetOperationsResponse) Descriptor 

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

func (*GetOperationsResponse) GetOperations 

func (m *GetOperationsResponse) GetOperations() []*Operation

func (*GetOperationsResponse) ProtoMessage 

func (*GetOperationsResponse) ProtoMessage()

func (*GetOperationsResponse) Reset 

func (m *GetOperationsResponse) Reset()

func (*GetOperationsResponse) String 

func (m *GetOperationsResponse) String() string

func (*GetOperationsResponse) XXX_DiscardUnknown 

func (m *GetOperationsResponse) XXX_DiscardUnknown()

func (*GetOperationsResponse) XXX_Marshal 

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

func (*GetOperationsResponse) XXX_Merge 

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

func (*GetOperationsResponse) XXX_Size 

func (m *GetOperationsResponse) XXX_Size() int

func (*GetOperationsResponse) XXX_Unmarshal 

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

type GetServicesRequest 

type GetServicesRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request object to get service names.

func (*GetServicesRequest) Descriptor 

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

func (*GetServicesRequest) ProtoMessage 

func (*GetServicesRequest) ProtoMessage()

func (*GetServicesRequest) Reset 

func (m *GetServicesRequest) Reset()

func (*GetServicesRequest) String 

func (m *GetServicesRequest) String() string

func (*GetServicesRequest) XXX_DiscardUnknown 

func (m *GetServicesRequest) XXX_DiscardUnknown()

func (*GetServicesRequest) XXX_Marshal 

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

func (*GetServicesRequest) XXX_Merge 

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

func (*GetServicesRequest) XXX_Size 

func (m *GetServicesRequest) XXX_Size() int

func (*GetServicesRequest) XXX_Unmarshal 

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

type GetServicesResponse 

type GetServicesResponse struct {
	Services             []string `protobuf:"bytes,1,rep,name=services,proto3" json:"services,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Response object to get service names.

func (*GetServicesResponse) Descriptor 

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

func (*GetServicesResponse) GetServices 

func (m *GetServicesResponse) GetServices() []string

func (*GetServicesResponse) ProtoMessage 

func (*GetServicesResponse) ProtoMessage()

func (*GetServicesResponse) Reset 

func (m *GetServicesResponse) Reset()

func (*GetServicesResponse) String 

func (m *GetServicesResponse) String() string

func (*GetServicesResponse) XXX_DiscardUnknown 

func (m *GetServicesResponse) XXX_DiscardUnknown()

func (*GetServicesResponse) XXX_Marshal 

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

func (*GetServicesResponse) XXX_Merge 

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

func (*GetServicesResponse) XXX_Size 

func (m *GetServicesResponse) XXX_Size() int

func (*GetServicesResponse) XXX_Unmarshal 

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

type GetTraceRequest 

type GetTraceRequest struct {
	// Hex encoded 64 or 128 bit trace ID.
	TraceId              string   `protobuf:"bytes,1,opt,name=trace_id,json=traceId,proto3" json:"trace_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request object to get a trace.

func (*GetTraceRequest) Descriptor 

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

func (*GetTraceRequest) GetTraceId 

func (m *GetTraceRequest) GetTraceId() string

func (*GetTraceRequest) ProtoMessage 

func (*GetTraceRequest) ProtoMessage()

func (*GetTraceRequest) Reset 

func (m *GetTraceRequest) Reset()

func (*GetTraceRequest) String 

func (m *GetTraceRequest) String() string

func (*GetTraceRequest) XXX_DiscardUnknown 

func (m *GetTraceRequest) XXX_DiscardUnknown()

func (*GetTraceRequest) XXX_Marshal 

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

func (*GetTraceRequest) XXX_Merge 

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

func (*GetTraceRequest) XXX_Size 

func (m *GetTraceRequest) XXX_Size() int

func (*GetTraceRequest) XXX_Unmarshal 

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

type Operation 

type Operation struct {
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	SpanKind             string   `protobuf:"bytes,2,opt,name=span_kind,json=spanKind,proto3" json:"span_kind,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Operation encapsulates information about operation.

func (*Operation) Descriptor 

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

func (*Operation) GetName 

func (m *Operation) GetName() string

func (*Operation) GetSpanKind 

func (m *Operation) GetSpanKind() string

func (*Operation) ProtoMessage 

func (*Operation) ProtoMessage()

func (*Operation) Reset 

func (m *Operation) Reset()

func (*Operation) String 

func (m *Operation) String() string

func (*Operation) XXX_DiscardUnknown 

func (m *Operation) XXX_DiscardUnknown()

func (*Operation) XXX_Marshal 

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

func (*Operation) XXX_Merge 

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

func (*Operation) XXX_Size 

func (m *Operation) XXX_Size() int

func (*Operation) XXX_Unmarshal 

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

type QueryServiceClient 

type QueryServiceClient interface {
	// GetTrace returns a single trace.
	// Note that the JSON response over HTTP is wrapped into result envelope "{"result": ...}"
	// It means that the JSON response cannot be directly unmarshalled using JSONPb.
	// This can be fixed by first parsing into user-defined envelope with standard JSON library
	// or string manipulation to remove the envelope. Alternatively generate objects using OpenAPI.
	GetTrace(ctx context.Context, in *GetTraceRequest, opts ...grpc.CallOption) (QueryService_GetTraceClient, error)
	// FindTraces searches for traces.
	// See GetTrace for JSON unmarshalling.
	FindTraces(ctx context.Context, in *FindTracesRequest, opts ...grpc.CallOption) (QueryService_FindTracesClient, error)
	// GetServices returns service names.
	GetServices(ctx context.Context, in *GetServicesRequest, opts ...grpc.CallOption) (*GetServicesResponse, error)
	// GetOperations returns operation names.
	GetOperations(ctx context.Context, in *GetOperationsRequest, opts ...grpc.CallOption) (*GetOperationsResponse, error)
}

QueryServiceClient is the client API for QueryService service.

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

func NewQueryServiceClient 

func NewQueryServiceClient(cc *grpc.ClientConn) QueryServiceClient

type QueryServiceServer 

type QueryServiceServer interface {
	// GetTrace returns a single trace.
	// Note that the JSON response over HTTP is wrapped into result envelope "{"result": ...}"
	// It means that the JSON response cannot be directly unmarshalled using JSONPb.
	// This can be fixed by first parsing into user-defined envelope with standard JSON library
	// or string manipulation to remove the envelope. Alternatively generate objects using OpenAPI.
	GetTrace(*GetTraceRequest, QueryService_GetTraceServer) error
	// FindTraces searches for traces.
	// See GetTrace for JSON unmarshalling.
	FindTraces(*FindTracesRequest, QueryService_FindTracesServer) error
	// GetServices returns service names.
	GetServices(context.Context, *GetServicesRequest) (*GetServicesResponse, error)
	// GetOperations returns operation names.
	GetOperations(context.Context, *GetOperationsRequest) (*GetOperationsResponse, error)
}

QueryServiceServer is the server API for QueryService service.

type QueryService_FindTracesClient 

type QueryService_FindTracesClient interface {
	Recv() (*SpansResponseChunk, error)
	grpc.ClientStream
}

type QueryService_FindTracesServer 

type QueryService_FindTracesServer interface {
	Send(*SpansResponseChunk) error
	grpc.ServerStream
}

type QueryService_GetTraceClient 

type QueryService_GetTraceClient interface {
	Recv() (*SpansResponseChunk, error)
	grpc.ClientStream
}

type QueryService_GetTraceServer 

type QueryService_GetTraceServer interface {
	Send(*SpansResponseChunk) error
	grpc.ServerStream
}

type SpansResponseChunk 

type SpansResponseChunk struct {
	// A list of OpenTelemetry ResourceSpans.
	// In case of JSON format the ids (trace_id, span_id, parent_id) are encoded in base64 even though OpenTelemetry specification
	// mandates to use hex encoding [2].
	// Base64 is chosen to keep compatibility with JSONPb codec.
	// [1]: https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/trace/v1/trace.proto
	// [2]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#otlphttp
	ResourceSpans        []*v1.ResourceSpans `protobuf:"bytes,1,rep,name=resource_spans,json=resourceSpans,proto3" json:"resource_spans,omitempty"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

Response object with spans.

func (*SpansResponseChunk) Descriptor 

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

func (*SpansResponseChunk) GetResourceSpans 

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

func (*SpansResponseChunk) ProtoMessage 

func (*SpansResponseChunk) ProtoMessage()

func (*SpansResponseChunk) Reset 

func (m *SpansResponseChunk) Reset()

func (*SpansResponseChunk) String 

func (m *SpansResponseChunk) String() string

func (*SpansResponseChunk) XXX_DiscardUnknown 

func (m *SpansResponseChunk) XXX_DiscardUnknown()

func (*SpansResponseChunk) XXX_Marshal 

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

func (*SpansResponseChunk) XXX_Merge 

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

func (*SpansResponseChunk) XXX_Size 

func (m *SpansResponseChunk) XXX_Size() int

func (*SpansResponseChunk) XXX_Unmarshal 

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

type TraceQueryParameters 

type TraceQueryParameters struct {
	ServiceName   string `protobuf:"bytes,1,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
	OperationName string `protobuf:"bytes,2,opt,name=operation_name,json=operationName,proto3" json:"operation_name,omitempty"`
	// Attributes are matched against Span and Resource attributes.
	// At least one span in a trace must match all specified attributes.
	Attributes map[string]string `` /* 161-byte string literal not displayed */
	// Span min start time in. REST API uses RFC-3339ns format. Required.
	StartTimeMin *types.Timestamp `protobuf:"bytes,4,opt,name=start_time_min,json=startTimeMin,proto3" json:"start_time_min,omitempty"`
	// Span max start time. REST API uses RFC-3339ns format. Required.
	StartTimeMax *types.Timestamp `protobuf:"bytes,5,opt,name=start_time_max,json=startTimeMax,proto3" json:"start_time_max,omitempty"`
	// Span min duration. REST API uses Golang's time format e.g. 10s.
	DurationMin *types.Duration `protobuf:"bytes,6,opt,name=duration_min,json=durationMin,proto3" json:"duration_min,omitempty"`
	// Span max duration. REST API uses Golang's time format e.g. 10s.
	DurationMax *types.Duration `protobuf:"bytes,7,opt,name=duration_max,json=durationMax,proto3" json:"duration_max,omitempty"`
	// Maximum number of traces in the response.
	NumTraces            int32    `protobuf:"varint,8,opt,name=num_traces,json=numTraces,proto3" json:"num_traces,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Query parameters to find traces. Note that some storage implementations do not guarantee the correct implementation of all parameters.

func (*TraceQueryParameters) Descriptor 

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

func (*TraceQueryParameters) GetAttributes 

func (m *TraceQueryParameters) GetAttributes() map[string]string

func (*TraceQueryParameters) GetDurationMax 

func (m *TraceQueryParameters) GetDurationMax() *types.Duration

func (*TraceQueryParameters) GetDurationMin 

func (m *TraceQueryParameters) GetDurationMin() *types.Duration

func (*TraceQueryParameters) GetNumTraces 

func (m *TraceQueryParameters) GetNumTraces() int32

func (*TraceQueryParameters) GetOperationName 

func (m *TraceQueryParameters) GetOperationName() string

func (*TraceQueryParameters) GetServiceName 

func (m *TraceQueryParameters) GetServiceName() string

func (*TraceQueryParameters) GetStartTimeMax 

func (m *TraceQueryParameters) GetStartTimeMax() *types.Timestamp

func (*TraceQueryParameters) GetStartTimeMin 

func (m *TraceQueryParameters) GetStartTimeMin() *types.Timestamp

func (*TraceQueryParameters) ProtoMessage 

func (*TraceQueryParameters) ProtoMessage()

func (*TraceQueryParameters) Reset 

func (m *TraceQueryParameters) Reset()

func (*TraceQueryParameters) String 

func (m *TraceQueryParameters) String() string

func (*TraceQueryParameters) XXX_DiscardUnknown 

func (m *TraceQueryParameters) XXX_DiscardUnknown()

func (*TraceQueryParameters) XXX_Marshal 

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

func (*TraceQueryParameters) XXX_Merge 

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

func (*TraceQueryParameters) XXX_Size 

func (m *TraceQueryParameters) XXX_Size() int

func (*TraceQueryParameters) XXX_Unmarshal 

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

type UnimplementedQueryServiceServer 

type UnimplementedQueryServiceServer struct {
}

UnimplementedQueryServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedQueryServiceServer) FindTraces 

func (*UnimplementedQueryServiceServer) FindTraces(req *FindTracesRequest, srv QueryService_FindTracesServer) error

func (*UnimplementedQueryServiceServer) GetOperations 

func (*UnimplementedQueryServiceServer) GetOperations(ctx context.Context, req *GetOperationsRequest) (*GetOperationsResponse, error)

func (*UnimplementedQueryServiceServer) GetServices 

func (*UnimplementedQueryServiceServer) GetServices(ctx context.Context, req *GetServicesRequest) (*GetServicesResponse, error)

func (*UnimplementedQueryServiceServer) GetTrace 

func (*UnimplementedQueryServiceServer) GetTrace(req *GetTraceRequest, srv QueryService_GetTraceServer) error

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.