package peloton.private.eventstream

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc InitStream (InitStreamRequest, InitStreamResponse)

  eventstream.proto:36

  Client calls CreateStream to learn about information to consume the stream.

  message InitStreamRequest

  eventstream.proto:69

  Client need to call this to init a stream on server side.

  • string clientName = 1

  message InitStreamResponse

  eventstream.proto:75

  InitStreamResponse pass back the streamID and the minOffset of the events on server side.

  • optional InitStreamResponse.Error error = 1

  • string streamID = 2

    streamID is created by the server and will change when server restarts

  • uint64 minOffset = 3

    min Offset of the event in the server side circular buffer

  • uint64 previousPurgeOffset = 4

    previous purgeOffset for the client, if there is any stored on the server the client can use previousPurgeOffset as the begin offset for the next WaitForEventsRequest

• rpc WaitForEvents (WaitForEventsRequest, WaitForEventsResponse)

  eventstream.proto:38

  Wait for some task events.

  message WaitForEventsRequest

  eventstream.proto:90

  • string streamID = 1

    Current streamID

  • uint64 purgeOffset = 2

    The offeSet that the client has processed, which can be purged on the server

  • uint64 beginOffset = 3

    The begin offset of the intended data

  • int32 limit = 4

    The max number of events limit for current request

  • int32 timeoutMs = 5

    Timeout value

  • string clientName = 6

    Name of the client

  message WaitForEventsResponse

  eventstream.proto:105

  • optional WaitForEventsResponse.Error error = 1

  • repeated Event events = 2

Error message for clients that are not expected by the server For now, the server only expects a list of pre-defined clients For example. Hostmgr would expect only Job manager / resource manager to consume the task update event stream.

Used in: InitStreamResponse.Error, WaitForEventsResponse.Error

• string message = 1

Used in: WaitForEventsResponse, hostmgr.hostsvc.WatchEventStreamEventResponse, resmgr.NotifyTaskUpdatesRequest

• uint64 offset = 1

  offset is the sequence id of the event.

• Event.Type type = 2

• optional mesos.v1.TaskStatus mesosTaskStatus = 3

• optional api.v0.task.TaskEvent pelotonTaskEvent = 4

• optional api.v0.host.HostEvent hostEvent = 5

Describes the type of event.

Used in: Event

• UNKNOWN_EVENT_TYPE = 0

• MESOS_TASK_STATUS = 1

• PELOTON_TASK_EVENT = 2

• HOST_EVENT = 3

Used in: InitStreamResponse

• optional ClientUnsupported clientUnsupported = 1

Error message for incorrect purge offset

Used in: WaitForEventsResponse.Error

• uint64 purgeOffset = 1

• uint64 beginOffset = 2

Error message for clients that are not expected by the server

Used in: WaitForEventsResponse.Error

• string currentStreamID = 1

The intended event offset is out of the event range on the server side

Used in: WaitForEventsResponse.Error

• string streamID = 1

• uint64 minOffset = 2

• uint64 maxOffset = 3

• uint64 offsetRequested = 4

Used in: WaitForEventsResponse

• optional OffsetOutOfRange outOfRange = 1

• optional ClientUnsupported clientUnsupported = 2

• optional InvalidStreamID invalidStreamID = 3

• optional InvalidPurgeOffset invalidPurgeOffset = 4