package grpc.go.profiling.v1alpha

Get desktop application:
View/edit binary Protocol Buffers messages

The Profiling service exposes functions to remotely manage the gRPC profiling behaviour in a program.

• rpc Enable (EnableRequest, EnableResponse)

  service.proto:93

  Enable allows users to toggle profiling on and off remotely.

  message EnableRequest

  service.proto:28

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

  • bool enabled = 1

    Setting this to true will enable profiling. Setting this to false will disable profiling.

  message EnableResponse

  service.proto:35

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

  (message has no fields)

• rpc GetStreamStats (GetStreamStatsRequest, GetStreamStatsResponse)

  service.proto:97

  GetStreamStats is used to retrieve an array of stream-level stats from a gRPC client/server.

  message GetStreamStatsRequest

  service.proto:40

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

  (message has no fields)

  message GetStreamStatsResponse

  service.proto:45

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

  • repeated Stat stream_stats = 1

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

Used in: GetStreamStatsResponse

• string tags = 1

  tags is a comma-separated list of strings used to categorize a stat.

• repeated Timer timers = 2

  timers is an array of Timers, each representing a different (but possibly overlapping) component within this stat.

• bytes metadata = 3

  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.

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.

Used in: Stat

• string tags = 1

  tags is a comma-separated list of strings used to tag a timer.

• int64 begin_sec = 2

  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.

• int32 begin_nsec = 3

• int64 end_sec = 4

  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.

• int32 end_nsec = 5

• int64 go_id = 6

  go_id is the goroutine ID of the component being profiled.