grpc: google.golang.org/grpc/profiling/proto Index | Files

package proto

import "google.golang.org/grpc/profiling/proto"

Index

Package Files

service.pb.go service_grpc.pb.go

func RegisterProfilingServer Uses

func RegisterProfilingServer(s grpc.ServiceRegistrar, srv ProfilingServer)

RegisterProfilingServer registers a service implementation with a gRPC server.

func RegisterProfilingService Uses

func RegisterProfilingService(s grpc.ServiceRegistrar, srv *ProfilingService)

RegisterProfilingService registers a service implementation with a gRPC server.

type EnableRequest Uses

type EnableRequest struct {
    // Setting this to true will enable profiling. Setting this to false will
    // disable profiling.
    Enabled              bool     `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

EnableRequest defines the fields in a /Profiling/Enable method request to toggle profiling on and off within a gRPC program.

func (*EnableRequest) Descriptor Uses

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

func (*EnableRequest) GetEnabled Uses

func (m *EnableRequest) GetEnabled() bool

func (*EnableRequest) ProtoMessage Uses

func (*EnableRequest) ProtoMessage()

func (*EnableRequest) Reset Uses

func (m *EnableRequest) Reset()

func (*EnableRequest) String Uses

func (m *EnableRequest) String() string

func (*EnableRequest) XXX_DiscardUnknown Uses

func (m *EnableRequest) XXX_DiscardUnknown()

func (*EnableRequest) XXX_Marshal Uses

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

func (*EnableRequest) XXX_Merge Uses

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

func (*EnableRequest) XXX_Size Uses

func (m *EnableRequest) XXX_Size() int

func (*EnableRequest) XXX_Unmarshal Uses

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

type EnableResponse Uses

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

EnableResponse defines the fields in a /Profiling/Enable method response.

func (*EnableResponse) Descriptor Uses

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

func (*EnableResponse) ProtoMessage Uses

func (*EnableResponse) ProtoMessage()

func (*EnableResponse) Reset Uses

func (m *EnableResponse) Reset()

func (*EnableResponse) String Uses

func (m *EnableResponse) String() string

func (*EnableResponse) XXX_DiscardUnknown Uses

func (m *EnableResponse) XXX_DiscardUnknown()

func (*EnableResponse) XXX_Marshal Uses

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

func (*EnableResponse) XXX_Merge Uses

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

func (*EnableResponse) XXX_Size Uses

func (m *EnableResponse) XXX_Size() int

func (*EnableResponse) XXX_Unmarshal Uses

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

type GetStreamStatsRequest Uses

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

GetStreamStatsRequest defines the fields in a /Profiling/GetStreamStats method request to retrieve stream-level stats in a gRPC client/server.

func (*GetStreamStatsRequest) Descriptor Uses

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

func (*GetStreamStatsRequest) ProtoMessage Uses

func (*GetStreamStatsRequest) ProtoMessage()

func (*GetStreamStatsRequest) Reset Uses

func (m *GetStreamStatsRequest) Reset()

func (*GetStreamStatsRequest) String Uses

func (m *GetStreamStatsRequest) String() string

func (*GetStreamStatsRequest) XXX_DiscardUnknown Uses

func (m *GetStreamStatsRequest) XXX_DiscardUnknown()

func (*GetStreamStatsRequest) XXX_Marshal Uses

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

func (*GetStreamStatsRequest) XXX_Merge Uses

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

func (*GetStreamStatsRequest) XXX_Size Uses

func (m *GetStreamStatsRequest) XXX_Size() int

func (*GetStreamStatsRequest) XXX_Unmarshal Uses

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

type GetStreamStatsResponse Uses

type GetStreamStatsResponse struct {
    StreamStats          []*Stat  `protobuf:"bytes,1,rep,name=stream_stats,json=streamStats,proto3" json:"stream_stats,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

GetStreamStatsResponse defines the fields in a /Profiling/GetStreamStats method response.

func (*GetStreamStatsResponse) Descriptor Uses

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

func (*GetStreamStatsResponse) GetStreamStats Uses

func (m *GetStreamStatsResponse) GetStreamStats() []*Stat

func (*GetStreamStatsResponse) ProtoMessage Uses

func (*GetStreamStatsResponse) ProtoMessage()

func (*GetStreamStatsResponse) Reset Uses

func (m *GetStreamStatsResponse) Reset()

func (*GetStreamStatsResponse) String Uses

func (m *GetStreamStatsResponse) String() string

func (*GetStreamStatsResponse) XXX_DiscardUnknown Uses

func (m *GetStreamStatsResponse) XXX_DiscardUnknown()

func (*GetStreamStatsResponse) XXX_Marshal Uses

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

func (*GetStreamStatsResponse) XXX_Merge Uses

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

func (*GetStreamStatsResponse) XXX_Size Uses

func (m *GetStreamStatsResponse) XXX_Size() int

func (*GetStreamStatsResponse) XXX_Unmarshal Uses

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

type ProfilingClient Uses

type ProfilingClient interface {
    // Enable allows users to toggle profiling on and off remotely.
    Enable(ctx context.Context, in *EnableRequest, opts ...grpc.CallOption) (*EnableResponse, error)
    // GetStreamStats is used to retrieve an array of stream-level stats from a
    // gRPC client/server.
    GetStreamStats(ctx context.Context, in *GetStreamStatsRequest, opts ...grpc.CallOption) (*GetStreamStatsResponse, error)
}

ProfilingClient is the client API for Profiling 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 NewProfilingClient Uses

func NewProfilingClient(cc grpc.ClientConnInterface) ProfilingClient

type ProfilingServer Uses

type ProfilingServer interface {
    // Enable allows users to toggle profiling on and off remotely.
    Enable(context.Context, *EnableRequest) (*EnableResponse, error)
    // GetStreamStats is used to retrieve an array of stream-level stats from a
    // gRPC client/server.
    GetStreamStats(context.Context, *GetStreamStatsRequest) (*GetStreamStatsResponse, error)
}

ProfilingServer is the service API for Profiling service. New methods may be added to this interface if they are added to the service definition, which is not a backward-compatible change. For this reason, use of this type is not recommended unless you own the service definition.

type ProfilingService Uses

type ProfilingService struct {
    // Enable allows users to toggle profiling on and off remotely.
    Enable func(context.Context, *EnableRequest) (*EnableResponse, error)
    // GetStreamStats is used to retrieve an array of stream-level stats from a
    // gRPC client/server.
    GetStreamStats func(context.Context, *GetStreamStatsRequest) (*GetStreamStatsResponse, error)
}

ProfilingService is the service API for Profiling service. Fields should be assigned to their respective handler implementations only before RegisterProfilingService is called. Any unassigned fields will result in the handler for that method returning an Unimplemented error.

type Stat Uses

type Stat struct {
    // tags is a comma-separated list of strings used to categorize a stat.
    Tags string `protobuf:"bytes,1,opt,name=tags,proto3" json:"tags,omitempty"`
    // timers is an array of Timers, each representing a different
    // (but possibly overlapping) component within this stat.
    Timers []*Timer `protobuf:"bytes,2,rep,name=timers,proto3" json:"timers,omitempty"`
    // metadata is an array of bytes used to uniquely identify a stat with an
    // undefined encoding format. For example, the Stats returned by the
    // /Profiling/GetStreamStats service use the metadata field to encode the
    // connection ID and the stream ID of each query.
    Metadata             []byte   `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

A Stat is a collection of Timers along with some additional metadata to tag and identify itself.

func (*Stat) Descriptor Uses

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

func (*Stat) GetMetadata Uses

func (m *Stat) GetMetadata() []byte

func (*Stat) GetTags Uses

func (m *Stat) GetTags() string

func (*Stat) GetTimers Uses

func (m *Stat) GetTimers() []*Timer

func (*Stat) ProtoMessage Uses

func (*Stat) ProtoMessage()

func (*Stat) Reset Uses

func (m *Stat) Reset()

func (*Stat) String Uses

func (m *Stat) String() string

func (*Stat) XXX_DiscardUnknown Uses

func (m *Stat) XXX_DiscardUnknown()

func (*Stat) XXX_Marshal Uses

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

func (*Stat) XXX_Merge Uses

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

func (*Stat) XXX_Size Uses

func (m *Stat) XXX_Size() int

func (*Stat) XXX_Unmarshal Uses

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

type Timer Uses

type Timer struct {
    // tags is a comma-separated list of strings used to tag a timer.
    Tags string `protobuf:"bytes,1,opt,name=tags,proto3" json:"tags,omitempty"`
    // begin_sec and begin_nsec are the start epoch second and nanosecond,
    // respectively, of the component profiled by this timer in UTC. begin_nsec
    // must be a non-negative integer.
    BeginSec  int64 `protobuf:"varint,2,opt,name=begin_sec,json=beginSec,proto3" json:"begin_sec,omitempty"`
    BeginNsec int32 `protobuf:"varint,3,opt,name=begin_nsec,json=beginNsec,proto3" json:"begin_nsec,omitempty"`
    // end_sec and end_nsec are the end epoch second and nanosecond,
    // respectively, of the component profiled by this timer in UTC. end_nsec
    // must be a non-negative integer.
    EndSec  int64 `protobuf:"varint,4,opt,name=end_sec,json=endSec,proto3" json:"end_sec,omitempty"`
    EndNsec int32 `protobuf:"varint,5,opt,name=end_nsec,json=endNsec,proto3" json:"end_nsec,omitempty"`
    // go_id is the goroutine ID of the component being profiled.
    GoId                 int64    `protobuf:"varint,6,opt,name=go_id,json=goId,proto3" json:"go_id,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

A Timer measures the start and end of execution of a component within gRPC that's being profiled. It includes a tag and some additional metadata to identify itself.

func (*Timer) Descriptor Uses

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

func (*Timer) GetBeginNsec Uses

func (m *Timer) GetBeginNsec() int32

func (*Timer) GetBeginSec Uses

func (m *Timer) GetBeginSec() int64

func (*Timer) GetEndNsec Uses

func (m *Timer) GetEndNsec() int32

func (*Timer) GetEndSec Uses

func (m *Timer) GetEndSec() int64

func (*Timer) GetGoId Uses

func (m *Timer) GetGoId() int64

func (*Timer) GetTags Uses

func (m *Timer) GetTags() string

func (*Timer) ProtoMessage Uses

func (*Timer) ProtoMessage()

func (*Timer) Reset Uses

func (m *Timer) Reset()

func (*Timer) String Uses

func (m *Timer) String() string

func (*Timer) XXX_DiscardUnknown Uses

func (m *Timer) XXX_DiscardUnknown()

func (*Timer) XXX_Marshal Uses

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

func (*Timer) XXX_Merge Uses

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

func (*Timer) XXX_Size Uses

func (m *Timer) XXX_Size() int

func (*Timer) XXX_Unmarshal Uses

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

type UnimplementedProfilingServer Uses

type UnimplementedProfilingServer struct {
}

UnimplementedProfilingServer can be embedded to have forward compatible implementations of ProfilingServer

func (*UnimplementedProfilingServer) Enable Uses

func (*UnimplementedProfilingServer) Enable(context.Context, *EnableRequest) (*EnableResponse, error)

func (*UnimplementedProfilingServer) GetStreamStats Uses

func (*UnimplementedProfilingServer) GetStreamStats(context.Context, *GetStreamStatsRequest) (*GetStreamStatsResponse, error)

Package proto imports 7 packages (graph) and is imported by 2 packages. Updated 2020-09-17. Refresh now. Tools for package owners.