Documentation ¶
Overview ¶
Package api is a generated protocol buffer package.
It is generated from these files:
pprof.proto
It has these top-level messages:
Chunk CmdlineRequest CmdlineResponse CPUProfileRequest TraceRequest SymbolRequest LookupRequest SymbolResponse LookupResponse
Index ¶
- Variables
- func NewChunkReader(recv ChunkReceiver) io.Reader
- func NewChunkWriter(sender ChunkSender) io.Writer
- func RegisterPProfServiceServer(s *grpc.Server, srv PProfServiceServer)
- type CPUProfileRequest
- func (*CPUProfileRequest) Descriptor() ([]byte, []int)
- func (m *CPUProfileRequest) GetDuration() *google_protobuf.Duration
- func (m *CPUProfileRequest) Marshal() (dAtA []byte, err error)
- func (m *CPUProfileRequest) MarshalTo(dAtA []byte) (int, error)
- func (*CPUProfileRequest) ProtoMessage()
- func (m *CPUProfileRequest) Reset()
- func (m *CPUProfileRequest) Size() (n int)
- func (m *CPUProfileRequest) String() string
- func (m *CPUProfileRequest) Unmarshal(dAtA []byte) error
- type Chunk
- func (*Chunk) Descriptor() ([]byte, []int)
- func (m *Chunk) GetChunk() []byte
- func (m *Chunk) Marshal() (dAtA []byte, err error)
- func (m *Chunk) MarshalTo(dAtA []byte) (int, error)
- func (*Chunk) ProtoMessage()
- func (m *Chunk) Reset()
- func (m *Chunk) Size() (n int)
- func (m *Chunk) String() string
- func (m *Chunk) Unmarshal(dAtA []byte) error
- type ChunkReceiver
- type ChunkSender
- type CmdlineRequest
- func (*CmdlineRequest) Descriptor() ([]byte, []int)
- func (m *CmdlineRequest) Marshal() (dAtA []byte, err error)
- func (m *CmdlineRequest) MarshalTo(dAtA []byte) (int, error)
- func (*CmdlineRequest) ProtoMessage()
- func (m *CmdlineRequest) Reset()
- func (m *CmdlineRequest) Size() (n int)
- func (m *CmdlineRequest) String() string
- func (m *CmdlineRequest) Unmarshal(dAtA []byte) error
- type CmdlineResponse
- func (*CmdlineResponse) Descriptor() ([]byte, []int)
- func (m *CmdlineResponse) GetCommand() string
- func (m *CmdlineResponse) Marshal() (dAtA []byte, err error)
- func (m *CmdlineResponse) MarshalTo(dAtA []byte) (int, error)
- func (*CmdlineResponse) ProtoMessage()
- func (m *CmdlineResponse) Reset()
- func (m *CmdlineResponse) Size() (n int)
- func (m *CmdlineResponse) String() string
- func (m *CmdlineResponse) Unmarshal(dAtA []byte) error
- type LookupRequest
- func (*LookupRequest) Descriptor() ([]byte, []int)
- func (m *LookupRequest) GetDebug() int32
- func (m *LookupRequest) GetGcBeforeHeap() bool
- func (m *LookupRequest) GetName() string
- func (m *LookupRequest) Marshal() (dAtA []byte, err error)
- func (m *LookupRequest) MarshalTo(dAtA []byte) (int, error)
- func (*LookupRequest) ProtoMessage()
- func (m *LookupRequest) Reset()
- func (m *LookupRequest) Size() (n int)
- func (m *LookupRequest) String() string
- func (m *LookupRequest) Unmarshal(dAtA []byte) error
- type LookupResponse
- func (*LookupResponse) Descriptor() ([]byte, []int)
- func (m *LookupResponse) GetData() []byte
- func (m *LookupResponse) Marshal() (dAtA []byte, err error)
- func (m *LookupResponse) MarshalTo(dAtA []byte) (int, error)
- func (*LookupResponse) ProtoMessage()
- func (m *LookupResponse) Reset()
- func (m *LookupResponse) Size() (n int)
- func (m *LookupResponse) String() string
- func (m *LookupResponse) Unmarshal(dAtA []byte) error
- type PProfServiceClient
- type PProfServiceServer
- type PProfService_CPUProfileClient
- type PProfService_CPUProfileServer
- type PProfService_TraceClient
- type PProfService_TraceServer
- type SymbolRequest
- func (*SymbolRequest) Descriptor() ([]byte, []int)
- func (m *SymbolRequest) GetSymbol() uint64
- func (m *SymbolRequest) Marshal() (dAtA []byte, err error)
- func (m *SymbolRequest) MarshalTo(dAtA []byte) (int, error)
- func (*SymbolRequest) ProtoMessage()
- func (m *SymbolRequest) Reset()
- func (m *SymbolRequest) Size() (n int)
- func (m *SymbolRequest) String() string
- func (m *SymbolRequest) Unmarshal(dAtA []byte) error
- type SymbolResponse
- func (*SymbolResponse) Descriptor() ([]byte, []int)
- func (m *SymbolResponse) GetName() string
- func (m *SymbolResponse) GetSymbol() uint64
- func (m *SymbolResponse) Marshal() (dAtA []byte, err error)
- func (m *SymbolResponse) MarshalTo(dAtA []byte) (int, error)
- func (*SymbolResponse) ProtoMessage()
- func (m *SymbolResponse) Reset()
- func (m *SymbolResponse) Size() (n int)
- func (m *SymbolResponse) String() string
- func (m *SymbolResponse) Unmarshal(dAtA []byte) error
- type TraceRequest
- func (*TraceRequest) Descriptor() ([]byte, []int)
- func (m *TraceRequest) GetDuration() *google_protobuf.Duration
- func (m *TraceRequest) Marshal() (dAtA []byte, err error)
- func (m *TraceRequest) MarshalTo(dAtA []byte) (int, error)
- func (*TraceRequest) ProtoMessage()
- func (m *TraceRequest) Reset()
- func (m *TraceRequest) Size() (n int)
- func (m *TraceRequest) String() string
- func (m *TraceRequest) Unmarshal(dAtA []byte) error
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLengthPprof = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowPprof = fmt.Errorf("proto: integer overflow") )
Functions ¶
func NewChunkReader ¶
func NewChunkReader(recv ChunkReceiver) io.Reader
NewChunkReader creates an io.Reader from a ChunkReceiver. The reader works to stitch back together Chunks (a protobuf encapsulated stream of bytes) as a single stream.
func NewChunkWriter ¶
func NewChunkWriter(sender ChunkSender) io.Writer
NewChunkWriter creates an io.Writer from a `ChunkSender`. This can be useful for passing a stream down into lower-level parts of the system w/o having to manually deal with the chunking required by the protocol.
func RegisterPProfServiceServer ¶
func RegisterPProfServiceServer(s *grpc.Server, srv PProfServiceServer)
Types ¶
type CPUProfileRequest ¶
type CPUProfileRequest struct {
Duration *google_protobuf.Duration `protobuf:"bytes,1,opt,name=duration" json:"duration,omitempty"`
}
CPURequest is used with the `PProfService` `CPU` endpoint.
func (*CPUProfileRequest) Descriptor ¶
func (*CPUProfileRequest) Descriptor() ([]byte, []int)
func (*CPUProfileRequest) GetDuration ¶
func (m *CPUProfileRequest) GetDuration() *google_protobuf.Duration
func (*CPUProfileRequest) Marshal ¶
func (m *CPUProfileRequest) Marshal() (dAtA []byte, err error)
func (*CPUProfileRequest) MarshalTo ¶
func (m *CPUProfileRequest) MarshalTo(dAtA []byte) (int, error)
func (*CPUProfileRequest) ProtoMessage ¶
func (*CPUProfileRequest) ProtoMessage()
func (*CPUProfileRequest) Reset ¶
func (m *CPUProfileRequest) Reset()
func (*CPUProfileRequest) Size ¶
func (m *CPUProfileRequest) Size() (n int)
func (*CPUProfileRequest) String ¶
func (m *CPUProfileRequest) String() string
func (*CPUProfileRequest) Unmarshal ¶
func (m *CPUProfileRequest) Unmarshal(dAtA []byte) error
type Chunk ¶
type Chunk struct {
Chunk []byte `protobuf:"bytes,1,opt,name=chunk,proto3" json:"chunk,omitempty"`
}
Chunk is used by endpoints that send opaque chunks of data
func (*Chunk) Descriptor ¶
func (*Chunk) ProtoMessage ¶
func (*Chunk) ProtoMessage()
type ChunkReceiver ¶
ChunkReceiver is when creating a chunk reader to be able to accept different streaming endpoints from the API server.
type ChunkSender ¶
ChunkSender is when creating a chunk writer to be able to accept different streaming endpoints from the API server.
type CmdlineRequest ¶
type CmdlineRequest struct { }
CmdlineRequest is used by the `PProfService` `Cmdline` endpoint. It is currently just an empty request.
func (*CmdlineRequest) Descriptor ¶
func (*CmdlineRequest) Descriptor() ([]byte, []int)
func (*CmdlineRequest) Marshal ¶
func (m *CmdlineRequest) Marshal() (dAtA []byte, err error)
func (*CmdlineRequest) ProtoMessage ¶
func (*CmdlineRequest) ProtoMessage()
func (*CmdlineRequest) Reset ¶
func (m *CmdlineRequest) Reset()
func (*CmdlineRequest) Size ¶
func (m *CmdlineRequest) Size() (n int)
func (*CmdlineRequest) String ¶
func (m *CmdlineRequest) String() string
func (*CmdlineRequest) Unmarshal ¶
func (m *CmdlineRequest) Unmarshal(dAtA []byte) error
type CmdlineResponse ¶
type CmdlineResponse struct {
Command string `protobuf:"bytes,1,opt,name=command,proto3" json:"command,omitempty"`
}
CmdlineResponse is responded by the `PProfService` `Cmdline` endpoint. It contains the command line options used to start the running process as a set of null-terminated strings.
func (*CmdlineResponse) Descriptor ¶
func (*CmdlineResponse) Descriptor() ([]byte, []int)
func (*CmdlineResponse) GetCommand ¶
func (m *CmdlineResponse) GetCommand() string
func (*CmdlineResponse) Marshal ¶
func (m *CmdlineResponse) Marshal() (dAtA []byte, err error)
func (*CmdlineResponse) ProtoMessage ¶
func (*CmdlineResponse) ProtoMessage()
func (*CmdlineResponse) Reset ¶
func (m *CmdlineResponse) Reset()
func (*CmdlineResponse) Size ¶
func (m *CmdlineResponse) Size() (n int)
func (*CmdlineResponse) String ¶
func (m *CmdlineResponse) String() string
func (*CmdlineResponse) Unmarshal ¶
func (m *CmdlineResponse) Unmarshal(dAtA []byte) error
type LookupRequest ¶
type LookupRequest struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Debug int32 `protobuf:"varint,2,opt,name=debug,proto3" json:"debug,omitempty"` GcBeforeHeap bool `protobuf:"varint,3,opt,name=gc_before_heap,json=gcBeforeHeap,proto3" json:"gc_before_heap,omitempty"` }
LookupRequest is used with the `PProfService` `Lookup` endpoint. It is used to specify the profile data to lookup, e.g. `goroutine`, `heap`. See https://golang.org/pkg/runtime/pprof/#PProf
func (*LookupRequest) Descriptor ¶
func (*LookupRequest) Descriptor() ([]byte, []int)
func (*LookupRequest) GetDebug ¶
func (m *LookupRequest) GetDebug() int32
func (*LookupRequest) GetGcBeforeHeap ¶
func (m *LookupRequest) GetGcBeforeHeap() bool
func (*LookupRequest) GetName ¶
func (m *LookupRequest) GetName() string
func (*LookupRequest) Marshal ¶
func (m *LookupRequest) Marshal() (dAtA []byte, err error)
func (*LookupRequest) ProtoMessage ¶
func (*LookupRequest) ProtoMessage()
func (*LookupRequest) Reset ¶
func (m *LookupRequest) Reset()
func (*LookupRequest) Size ¶
func (m *LookupRequest) Size() (n int)
func (*LookupRequest) String ¶
func (m *LookupRequest) String() string
func (*LookupRequest) Unmarshal ¶
func (m *LookupRequest) Unmarshal(dAtA []byte) error
type LookupResponse ¶
type LookupResponse struct {
Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
}
LookupResponse is used with the `PProfService` `Lookup` endpoint. containing an opaque blob suitable for consumption by pprof tooling.
func (*LookupResponse) Descriptor ¶
func (*LookupResponse) Descriptor() ([]byte, []int)
func (*LookupResponse) GetData ¶
func (m *LookupResponse) GetData() []byte
func (*LookupResponse) Marshal ¶
func (m *LookupResponse) Marshal() (dAtA []byte, err error)
func (*LookupResponse) ProtoMessage ¶
func (*LookupResponse) ProtoMessage()
func (*LookupResponse) Reset ¶
func (m *LookupResponse) Reset()
func (*LookupResponse) Size ¶
func (m *LookupResponse) Size() (n int)
func (*LookupResponse) String ¶
func (m *LookupResponse) String() string
func (*LookupResponse) Unmarshal ¶
func (m *LookupResponse) Unmarshal(dAtA []byte) error
type PProfServiceClient ¶
type PProfServiceClient interface { Cmdline(ctx context.Context, in *CmdlineRequest, opts ...grpc.CallOption) (*CmdlineResponse, error) CPUProfile(ctx context.Context, in *CPUProfileRequest, opts ...grpc.CallOption) (PProfService_CPUProfileClient, error) Trace(ctx context.Context, in *TraceRequest, opts ...grpc.CallOption) (PProfService_TraceClient, error) Symbol(ctx context.Context, in *SymbolRequest, opts ...grpc.CallOption) (*SymbolResponse, error) Lookup(ctx context.Context, in *LookupRequest, opts ...grpc.CallOption) (*LookupResponse, error) }
func NewPProfServiceClient ¶
func NewPProfServiceClient(cc *grpc.ClientConn) PProfServiceClient
type PProfServiceServer ¶
type PProfServiceServer interface { Cmdline(context.Context, *CmdlineRequest) (*CmdlineResponse, error) CPUProfile(*CPUProfileRequest, PProfService_CPUProfileServer) error Trace(*TraceRequest, PProfService_TraceServer) error Symbol(context.Context, *SymbolRequest) (*SymbolResponse, error) Lookup(context.Context, *LookupRequest) (*LookupResponse, error) }
type PProfService_CPUProfileClient ¶
type PProfService_CPUProfileClient interface { Recv() (*Chunk, error) grpc.ClientStream }
type PProfService_CPUProfileServer ¶
type PProfService_CPUProfileServer interface { Send(*Chunk) error grpc.ServerStream }
type PProfService_TraceClient ¶
type PProfService_TraceClient interface { Recv() (*Chunk, error) grpc.ClientStream }
type PProfService_TraceServer ¶
type PProfService_TraceServer interface { Send(*Chunk) error grpc.ServerStream }
type SymbolRequest ¶
type SymbolRequest struct {
Symbol uint64 `protobuf:"varint,1,opt,name=symbol,proto3" json:"symbol,omitempty"`
}
SymbolRequest is used with the `PProfService` `Symbol` endpoint.
func (*SymbolRequest) Descriptor ¶
func (*SymbolRequest) Descriptor() ([]byte, []int)
func (*SymbolRequest) GetSymbol ¶
func (m *SymbolRequest) GetSymbol() uint64
func (*SymbolRequest) Marshal ¶
func (m *SymbolRequest) Marshal() (dAtA []byte, err error)
func (*SymbolRequest) ProtoMessage ¶
func (*SymbolRequest) ProtoMessage()
func (*SymbolRequest) Reset ¶
func (m *SymbolRequest) Reset()
func (*SymbolRequest) Size ¶
func (m *SymbolRequest) Size() (n int)
func (*SymbolRequest) String ¶
func (m *SymbolRequest) String() string
func (*SymbolRequest) Unmarshal ¶
func (m *SymbolRequest) Unmarshal(dAtA []byte) error
type SymbolResponse ¶
type SymbolResponse struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Symbol uint64 `protobuf:"varint,2,opt,name=symbol,proto3" json:"symbol,omitempty"` }
SymbolResponse is used with the `PProfService` `Symbol` endpoint. It returns the name/symbol mapping
func (*SymbolResponse) Descriptor ¶
func (*SymbolResponse) Descriptor() ([]byte, []int)
func (*SymbolResponse) GetName ¶
func (m *SymbolResponse) GetName() string
func (*SymbolResponse) GetSymbol ¶
func (m *SymbolResponse) GetSymbol() uint64
func (*SymbolResponse) Marshal ¶
func (m *SymbolResponse) Marshal() (dAtA []byte, err error)
func (*SymbolResponse) ProtoMessage ¶
func (*SymbolResponse) ProtoMessage()
func (*SymbolResponse) Reset ¶
func (m *SymbolResponse) Reset()
func (*SymbolResponse) Size ¶
func (m *SymbolResponse) Size() (n int)
func (*SymbolResponse) String ¶
func (m *SymbolResponse) String() string
func (*SymbolResponse) Unmarshal ¶
func (m *SymbolResponse) Unmarshal(dAtA []byte) error
type TraceRequest ¶
type TraceRequest struct {
Duration *google_protobuf.Duration `protobuf:"bytes,1,opt,name=duration" json:"duration,omitempty"`
}
CPURequest is used with the `PProfService` `Trace` endpoint.
func (*TraceRequest) Descriptor ¶
func (*TraceRequest) Descriptor() ([]byte, []int)
func (*TraceRequest) GetDuration ¶
func (m *TraceRequest) GetDuration() *google_protobuf.Duration
func (*TraceRequest) Marshal ¶
func (m *TraceRequest) Marshal() (dAtA []byte, err error)
func (*TraceRequest) ProtoMessage ¶
func (*TraceRequest) ProtoMessage()
func (*TraceRequest) Reset ¶
func (m *TraceRequest) Reset()
func (*TraceRequest) Size ¶
func (m *TraceRequest) Size() (n int)
func (*TraceRequest) String ¶
func (m *TraceRequest) String() string
func (*TraceRequest) Unmarshal ¶
func (m *TraceRequest) Unmarshal(dAtA []byte) error