package PB.Common

Get desktop application:
View/edit binary Protocol Buffers messages

Type of data fields. @deprecated in favor of checking which field is available.

Used in: Registry.ParameterDetail

• DUMMY = 0

• INT = 1

  Number (64 bit signed)

• STRING = 2

• FLOAT = 3

• BOOL = 4

• LIST = 5

A common header used in all messages. Contains basic information about the message.

Used in: Commands.EventMessage, Commands.ExecuteRequestMessage, Commands.ExecuteResponseMessage, Commands.QueryRequestMessage, Commands.QueryResponseMessage, Commands.ScheduleNotificationMessage, Commands.SubmitRequestMessage, Commands.SubmitResponseMessage, Metrics.MetricsMessage, Metrics.MetricsQueryMessage, Registry.RegistryRequestMessage, Registry.RegistryResponseMessage, Settings.SettingsRequestMessage, Settings.SettingsResponseMessage

• string command = 1

  Command. A bundle command when the entire chunk is sent "as-is".

• string source_id = 3

  Source (sending) system. This is the system which sends the message (me).

• string sender_id = 4

  Sender is the original source of the message. This is same as source unless message has been relayed.

• string recipient_id = 5

  Recipient is the final destination. This is the same as destination_id unless message is to be relayed.

• string destination_id = 6

  Destination (target) system. The system which will receive the message next.

• string message_id = 16

  Message identification. Has no meaning apart from identification. Set by source system and retained in any processing system.

• repeated KeyValue metadata = 8

  Meta data related to the message.

• repeated string tags = 9

  A list of tags associated with the message.

• repeated Host hosts = 10

  A list of hosts. All recipient/destination ids point to objects in this data set.

Field identifying a host entry

Used in: Header

• string id = 1

  A unique identifier representing the host in *this* message

• string host = 2

  The host name

• string address = 3

  The address

• string protocol = 4

  The protocol used to talk whit this host.

• string comment = 5

  A comment describing the host

• repeated KeyValue metadata = 6

  A key value store with attributes describing this host. The content and use of this attributes are application defined.

• repeated string tags = 7

  A number of tags defined for this host

Key value pair

Used in: Commands.EventMessage.Request, Header, Host, Metrics.Metric, Registry.Information

• string key = 1

  The key identifying the value

• string value = 2

  The value

Used in: PerformanceData.FloatValue, Metrics.Metric

• double value = 1

Used in: Metrics.Metric

• string value = 1

How metrics are encoded into check results Nagios calls this performance data and we inherited the name.

Used in: Commands.QueryResponseMessage.Response.Line

• string alias = 1

  The name of the value

• oneof value

  • PerformanceData.StringValue string_value = 4

    If the value is an integer (can be only one)

  • PerformanceData.FloatValue float_value = 5

    If the value is a floating point number (can be only one)

Floating point performance data

Used in: PerformanceData

• double value = 1

  The value we are tracking

• string unit = 2

  The unit of all the values

• optional OptionalFloat warning = 3

  The warning threshold (if available)

• optional OptionalFloat critical = 4

  The warning critical (if available)

• optional OptionalFloat minimum = 6

  The lowest possible value

• optional OptionalFloat maximum = 7

  The highest possible value

Textual performance data

Used in: PerformanceData

• string value = 1

  The value

Used in: Commands.SubmitResponseMessage.Response, Metrics.MetricsMessage.Response, Registry.RegistryResponseMessage.Response, Settings.SettingsResponseMessage.Response, Storage.StorageResponseMessage.Response

• Result.StatusCodeType code = 1

• string message = 2

• string data = 3

Used in: Result

• STATUS_OK = 0

• STATUS_WARNING = 1

• STATUS_ERROR = 2

• STATUS_DELAYED = 3

A "Nagios" status result.

Used in: Commands.ExecuteResponseMessage.Response, Commands.QueryResponseMessage.Response

• OK = 0

  An ok status in Nagios

• WARNING = 1

  A warning status in Nagios

• CRITICAL = 2

  A critical status in Nagios

• UNKNOWN = 3

  Not able to determine status in Nagios