Documentation ¶
Overview ¶
Package profilestorev1alpha1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterProfileStoreServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterProfileStoreServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ProfileStoreServiceClient) error
- func RegisterProfileStoreServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterProfileStoreServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ProfileStoreServiceServer) error
- func RegisterProfileStoreServiceServer(s grpc.ServiceRegistrar, srv ProfileStoreServiceServer)
- type Label
- type LabelSet
- type ProfileStoreServiceClient
- type ProfileStoreServiceServer
- type RawProfileSeries
- func (*RawProfileSeries) Descriptor() ([]byte, []int)deprecated
- func (x *RawProfileSeries) GetLabels() *LabelSet
- func (x *RawProfileSeries) GetSamples() []*RawSample
- func (*RawProfileSeries) ProtoMessage()
- func (x *RawProfileSeries) ProtoReflect() protoreflect.Message
- func (x *RawProfileSeries) Reset()
- func (x *RawProfileSeries) String() string
- type RawSample
- type UnimplementedProfileStoreServiceServer
- type UnsafeProfileStoreServiceServer
- type WriteRawRequest
- func (*WriteRawRequest) Descriptor() ([]byte, []int)deprecated
- func (x *WriteRawRequest) GetSeries() []*RawProfileSeries
- func (x *WriteRawRequest) GetTenant() string
- func (*WriteRawRequest) ProtoMessage()
- func (x *WriteRawRequest) ProtoReflect() protoreflect.Message
- func (x *WriteRawRequest) Reset()
- func (x *WriteRawRequest) String() string
- type WriteRawResponse
Constants ¶
This section is empty.
Variables ¶
var File_parca_profilestore_v1alpha1_profilestore_proto protoreflect.FileDescriptor
var ProfileStoreService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "parca.profilestore.v1alpha1.ProfileStoreService", HandlerType: (*ProfileStoreServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "WriteRaw", Handler: _ProfileStoreService_WriteRaw_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "parca/profilestore/v1alpha1/profilestore.proto", }
ProfileStoreService_ServiceDesc is the grpc.ServiceDesc for ProfileStoreService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterProfileStoreServiceHandler ¶
func RegisterProfileStoreServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterProfileStoreServiceHandler registers the http handlers for service ProfileStoreService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterProfileStoreServiceHandlerClient ¶
func RegisterProfileStoreServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ProfileStoreServiceClient) error
RegisterProfileStoreServiceHandlerClient registers the http handlers for service ProfileStoreService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ProfileStoreServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ProfileStoreServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ProfileStoreServiceClient" to call the correct interceptors.
func RegisterProfileStoreServiceHandlerFromEndpoint ¶
func RegisterProfileStoreServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterProfileStoreServiceHandlerFromEndpoint is same as RegisterProfileStoreServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterProfileStoreServiceHandlerServer ¶
func RegisterProfileStoreServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ProfileStoreServiceServer) error
RegisterProfileStoreServiceHandlerServer registers the http handlers for service ProfileStoreService to "mux". UnaryRPC :call ProfileStoreServiceServer 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 RegisterProfileStoreServiceHandlerFromEndpoint instead.
func RegisterProfileStoreServiceServer ¶
func RegisterProfileStoreServiceServer(s grpc.ServiceRegistrar, srv ProfileStoreServiceServer)
Types ¶
type Label ¶
type Label struct { // name is the label name Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // value is the value for the label name Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
Label is a key value pair of identifiers
func (*Label) Descriptor
deprecated
func (*Label) ProtoMessage ¶
func (*Label) ProtoMessage()
func (*Label) ProtoReflect ¶
func (x *Label) ProtoReflect() protoreflect.Message
type LabelSet ¶
type LabelSet struct { // labels are the grouping of labels Labels []*Label `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"` // contains filtered or unexported fields }
LabelSet is a group of labels
func (*LabelSet) Descriptor
deprecated
func (*LabelSet) ProtoMessage ¶
func (*LabelSet) ProtoMessage()
func (*LabelSet) ProtoReflect ¶
func (x *LabelSet) ProtoReflect() protoreflect.Message
type ProfileStoreServiceClient ¶
type ProfileStoreServiceClient interface { // WriteRaw accepts a raw set of bytes of a pprof file WriteRaw(ctx context.Context, in *WriteRawRequest, opts ...grpc.CallOption) (*WriteRawResponse, error) }
ProfileStoreServiceClient is the client API for ProfileStoreService 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 NewProfileStoreServiceClient ¶
func NewProfileStoreServiceClient(cc grpc.ClientConnInterface) ProfileStoreServiceClient
type ProfileStoreServiceServer ¶
type ProfileStoreServiceServer interface { // WriteRaw accepts a raw set of bytes of a pprof file WriteRaw(context.Context, *WriteRawRequest) (*WriteRawResponse, error) }
ProfileStoreServiceServer is the server API for ProfileStoreService service. All implementations should embed UnimplementedProfileStoreServiceServer for forward compatibility
type RawProfileSeries ¶
type RawProfileSeries struct { // LabelSet is the key value pairs to identify the corresponding profile Labels *LabelSet `protobuf:"bytes,1,opt,name=labels,proto3" json:"labels,omitempty"` // samples are the set of profile bytes Samples []*RawSample `protobuf:"bytes,2,rep,name=samples,proto3" json:"samples,omitempty"` // contains filtered or unexported fields }
RawProfileSeries represents the pprof profile and its associated labels
func (*RawProfileSeries) Descriptor
deprecated
func (*RawProfileSeries) Descriptor() ([]byte, []int)
Deprecated: Use RawProfileSeries.ProtoReflect.Descriptor instead.
func (*RawProfileSeries) GetLabels ¶
func (x *RawProfileSeries) GetLabels() *LabelSet
func (*RawProfileSeries) GetSamples ¶
func (x *RawProfileSeries) GetSamples() []*RawSample
func (*RawProfileSeries) ProtoMessage ¶
func (*RawProfileSeries) ProtoMessage()
func (*RawProfileSeries) ProtoReflect ¶
func (x *RawProfileSeries) ProtoReflect() protoreflect.Message
func (*RawProfileSeries) Reset ¶
func (x *RawProfileSeries) Reset()
func (*RawProfileSeries) String ¶
func (x *RawProfileSeries) String() string
type RawSample ¶
type RawSample struct { // raw_profile is the set of bytes of the pprof profile RawProfile []byte `protobuf:"bytes,1,opt,name=raw_profile,json=rawProfile,proto3" json:"raw_profile,omitempty"` // contains filtered or unexported fields }
RawSample is the set of bytes that correspond to a pprof profile
func (*RawSample) Descriptor
deprecated
func (*RawSample) GetRawProfile ¶
func (*RawSample) ProtoMessage ¶
func (*RawSample) ProtoMessage()
func (*RawSample) ProtoReflect ¶
func (x *RawSample) ProtoReflect() protoreflect.Message
type UnimplementedProfileStoreServiceServer ¶
type UnimplementedProfileStoreServiceServer struct { }
UnimplementedProfileStoreServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedProfileStoreServiceServer) WriteRaw ¶
func (UnimplementedProfileStoreServiceServer) WriteRaw(context.Context, *WriteRawRequest) (*WriteRawResponse, error)
type UnsafeProfileStoreServiceServer ¶
type UnsafeProfileStoreServiceServer interface {
// contains filtered or unexported methods
}
UnsafeProfileStoreServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ProfileStoreServiceServer will result in compilation errors.
type WriteRawRequest ¶
type WriteRawRequest struct { // tenant is the given tenant to store the pprof profile under Tenant string `protobuf:"bytes,1,opt,name=tenant,proto3" json:"tenant,omitempty"` // series is a set raw pprof profiles and accompanying labels Series []*RawProfileSeries `protobuf:"bytes,2,rep,name=series,proto3" json:"series,omitempty"` // contains filtered or unexported fields }
WriteRawRequest writes a pprof profile for a given tenant
func (*WriteRawRequest) Descriptor
deprecated
func (*WriteRawRequest) Descriptor() ([]byte, []int)
Deprecated: Use WriteRawRequest.ProtoReflect.Descriptor instead.
func (*WriteRawRequest) GetSeries ¶
func (x *WriteRawRequest) GetSeries() []*RawProfileSeries
func (*WriteRawRequest) GetTenant ¶
func (x *WriteRawRequest) GetTenant() string
func (*WriteRawRequest) ProtoMessage ¶
func (*WriteRawRequest) ProtoMessage()
func (*WriteRawRequest) ProtoReflect ¶
func (x *WriteRawRequest) ProtoReflect() protoreflect.Message
func (*WriteRawRequest) Reset ¶
func (x *WriteRawRequest) Reset()
func (*WriteRawRequest) String ¶
func (x *WriteRawRequest) String() string
type WriteRawResponse ¶
type WriteRawResponse struct {
// contains filtered or unexported fields
}
WriteRawResponse is the empty response
func (*WriteRawResponse) Descriptor
deprecated
func (*WriteRawResponse) Descriptor() ([]byte, []int)
Deprecated: Use WriteRawResponse.ProtoReflect.Descriptor instead.
func (*WriteRawResponse) ProtoMessage ¶
func (*WriteRawResponse) ProtoMessage()
func (*WriteRawResponse) ProtoReflect ¶
func (x *WriteRawResponse) ProtoReflect() protoreflect.Message
func (*WriteRawResponse) Reset ¶
func (x *WriteRawResponse) Reset()
func (*WriteRawResponse) String ¶
func (x *WriteRawResponse) String() string