package agent

Get desktop application:
View/edit binary Protocol Buffers messages

Indicates the beginning of a batch. All subsequent points should be considered part of the batch until EndBatch arrives. This includes grouping. Batches of differing groups may not be interleaved. All the meta data but tmax is provided, since tmax may not be known at the beginning of a batch. Size is the number of points in the batch. If size is 0 then the batch has an undetermined size.

Used in: Request, Response

• string name = 1

• string group = 2

• map<string, string> tags = 3

• int64 size = 4

• bool byName = 5

Used in: InfoResponse

• STREAM = 0

• BATCH = 1

Indicates the end of a batch and contains all meta data associated with the batch. The same meta information is provided for ease of use with the addition of tmax since it may not be know at BeginBatch.

Used in: Request, Response

• string name = 1

• string group = 2

• int64 tmax = 3

• map<string, string> tags = 4

• bool byName = 5

Sent from the process to Kapacitor indicating an error has occurred. If an ErrorResponse is received, Kapacitor will terminate the process.

Used in: Response

• string error = 1

Request that the process return information about available Options.

Used in: Request

(message has no fields)

Used in: Response

• EdgeType wants = 1

• EdgeType provides = 2

• map<string, OptionInfo> options = 3

Request that the process initialize itself with the provided options.

Used in: Request

• repeated Option options = 1

• string taskID = 2

• string nodeID = 3

Respond to Kapacitor whether initialization was successful.

Used in: Response

• bool success = 1

• string error = 2

Request that the process respond with a Keepalive to verify it is responding.

Used in: Request

• int64 time = 1

  The number of nanoseconds since the epoch. Used only for debugging keepalive requests.

Respond to KeepaliveRequest

Used in: Response

• int64 time = 1

  The number of nanoseconds since the epoch. Used only for debugging keepalive requests.

Used in: InitRequest

• string name = 1

• repeated OptionValue values = 2

Used in: InfoResponse

• repeated ValueType valueTypes = 1

Used in: Option

• ValueType type = 1

• oneof value

  • bool boolValue = 2

  • int64 intValue = 3

  • double doubleValue = 4

  • string stringValue = 5

  • int64 durationValue = 6

Message containing information about a single data point. Can be sent on it's own or bookended by BeginBatch and EndBatch messages.

Used in: Request, Response

• int64 time = 1

• string name = 2

• string database = 3

• string retentionPolicy = 4

• string group = 5

• repeated string dimensions = 6

• map<string, string> tags = 7

• map<string, double> fieldsDouble = 8

• map<string, int64> fieldsInt = 9

• map<string, string> fieldsString = 10

• map<string, bool> fieldsBool = 12

• bool byName = 11

Request message wrapper -- sent from Kapacitor to process

• oneof message

  • InfoRequest info = 1

    Management requests

  • InitRequest init = 2

  • KeepaliveRequest keepalive = 3

  • SnapshotRequest snapshot = 4

  • RestoreRequest restore = 5

  • BeginBatch begin = 16

    Data flow responses

  • Point point = 17

  • EndBatch end = 18

Response message wrapper -- sent from process to Kapacitor

• oneof message

  • InfoResponse info = 1

    Management responses

  • InitResponse init = 2

  • KeepaliveResponse keepalive = 3

  • SnapshotResponse snapshot = 4

  • RestoreResponse restore = 5

  • ErrorResponse error = 6

  • BeginBatch begin = 16

    Data flow responses

  • Point point = 17

  • EndBatch end = 18

Request that the process restore its state from a snapshot.

Used in: Request

• bytes snapshot = 1

Respond with success or failure to a RestoreRequest

Used in: Response

• bool success = 1

• string error = 2

Request that the process provide a snapshot of its state.

Used in: Request

(message has no fields)

Respond to Kapacitor with a serialized snapshot of the running state.

Used in: Response

• bytes snapshot = 1

Used in: OptionInfo, OptionValue

• BOOL = 0

• INT = 1

• DOUBLE = 2

• STRING = 3

• DURATION = 4