package rs.tokio.console.instrument

Get desktop application:
View/edit binary Protocol Buffers messages

`InstrumentServer<T>` implements `Instrument` as a service.

• rpc WatchUpdates (InstrumentRequest, stream Update)

  instrument.proto:14

  Produces a stream of updates representing the behavior of the instrumented async runtime.

  message InstrumentRequest

  instrument.proto:31

  InstrumentRequest requests the stream of updates to observe the async runtime state over time. TODO: In the future allow for the request to specify only the data that the caller cares about (i.e. only tasks but no resources)

  (message has no fields)

  message Update

  instrument.proto:57

  Update carries all information regarding tasks, resources, async operations and resource operations in one message. There are a couple of reasons to combine all of these into a single message: - we can use one single timestamp for all the data - we can have all the new_metadata in one place - things such as async ops and resource ops do not make sense on their own as they have relations to tasks and resources

  • optional google.protobuf.Timestamp now = 1

    The system time when this update was recorded. This is the timestamp any durations in the included `Stats` were calculated relative to.

  • optional tasks.TaskUpdate task_update = 2

    Task state update.

  • optional resources.ResourceUpdate resource_update = 3

    Resource state update.

  • optional async_ops.AsyncOpUpdate async_op_update = 4

    Async operations state update

  • optional common.RegisterMetadata new_metadata = 5

    Any new span metadata that was registered since the last update.

• rpc WatchTaskDetails (TaskDetailsRequest, stream tasks.TaskDetails)

  instrument.proto:16

  Produces a stream of updates describing the activity of a specific task.

  message TaskDetailsRequest

  instrument.proto:36

  TaskDetailsRequest requests the stream of updates about the specific task identified in the request.

  • optional common.Id id = 1

    Identifies the task for which details were requested.

• rpc WatchState (StateRequest, stream State)

  instrument.proto:18

  Produces a stream of state of the aggregator.

  message StateRequest

  instrument.proto:78

  StateRequest requests the current state of the aggregator.

  (message has no fields)

  message State

  instrument.proto:82

  State carries the current state of the aggregator.

  • Temporality temporality = 1

• rpc Pause (PauseRequest, PauseResponse)

  instrument.proto:20

  Registers that the console observer wants to pause the stream.

  message PauseRequest

  instrument.proto:42

  PauseRequest requests the stream of updates to pause.

  (message has no fields)

  message PauseResponse

  instrument.proto:95

  `PauseResponse` is the value returned after a pause request.

  (message has no fields)

• rpc Resume (ResumeRequest, ResumeResponse)

  instrument.proto:22

  Registers that the console observer wants to resume the stream.

  message ResumeRequest

  instrument.proto:46

  ResumeRequest requests the stream of updates to resume after a pause.

  (message has no fields)

  message ResumeResponse

  instrument.proto:99

  `ResumeResponse` is the value returned after a resume request.

  (message has no fields)

The time "state" of the aggregator.

Used in: State

• LIVE = 0

  The aggregator is currently live.

• PAUSED = 1

  The aggregator is currently paused.