Skip to main content
Version: ⭐ 22.04

Centreon Broker Event Mapping

Centreon Broker uses global mapping tables for events that can be exchanged. This page list properties available for each event type.

NEB​

Acknowledgement​

PropertyTypeDescription
acknowledgement_typeshort integerHost acknowledgement when 0, service acknowledgement when 1.
authorstringAcknowledgement author.
commentstringComment associated to the acknowledgement.
deletion_timetimeTime at which the acknowledgement was deleted. If 0, it was not deleted.
entry_timetimeTime at which the acknowledgement was created.
host_idunsigned integerHost ID.
instance_idunsigned integerInstance ID.
is_stickybooleanSticky flag.
notify_contactsbooleanNotification flag.
persistent_commentbooleanTrue if the comment is persistent.
service_idunsigned integerService ID. 0 for a host acknowledgement.
stateshort integerHost / service state.
notify_only_if_not_already_acknowledgedbooleanA notification should be sent only if not already ack.

Comment​

PropertyTypeDescription
authorstringComment author.
comment_typeshort integer1 for a host comment, 2 for a service comment.
datastringComment data (text).
deletion_timetimeTime at which the comment was deleted. 0 if the comment was not deleted (yet).
entry_timetimeTime at which the comment was created.
entry_typeshort integer1 for a user comment (through external command), 2 for a downtime comment, 3 for a flapping comment and 4 for an acknowledgement comment.
expire_timetimeComment expiration time. 0 if no expiration time.
expiresboolTrue if the comment expires.
host_idunsigned integerHost ID.
internal_idunsigned integerInternal monitoring engine ID of the comment.
persistentbooleanTrue if the comment is persistent.
instance_idunsigned integerInstance ID.
service_idunsigned integerService ID. 0 if this is a host comment.
sourceshort integer0 when the comment originates from the monitoring engine (internal) or 1 when the comment comes from another source (external).

Custom variable​

PropertyTypeDescription
enabledbooleanTrue if the custom variable is enabled.
host_idunsigned integerHost ID.
modifiedbooleanTrue if the variable was modified.
namestringVariable name.
service_idunsigned integerService ID. 0 if this is a host custom variable.
update_timetimeLast time at which the variable was updated.
var_typeshort integer0 for a host custom variable, 1 for a service custom variable.
valuestringVariable value.
default_valuestringThe default value of the custom var.

Custom variable status​

Custom variable status events are generated when a custom variable needs to be updated.

PropertyTypeDescription
host_idunsigned integerHost ID.
modifiedbooleanTrue if the variable was modified.
namestringVariable name.
service_idunsigned integerService ID. 0 if this is a host custom variable.
update_timetimeLast time at which the variable was updated.
valuestringVariable value.

Downtime​

PropertyTypeDescription
actual_end_timetimeActual time at which the downtime ended.
actual_start_timetimeActual time at which the downtime started.
authorstringDowntime creator.
downtime_typeshort integer1 for a service downtime, 2 for a host downtime.
deletion_timetimeTime at which the downtime was deleted.
durationtimeDowntime duration.
end_timetimeScheduled downtime end time.
entry_timetimeTime at which the downtime was created.
fixedbooleanTrue if the downtime is fixed, false if it is flexible.
host_idunsigned integerHost ID.
instance_idunsigned integerInstance ID.
internal_idunsigned integerInternal monitoring engine ID.
service_idunsigned integerService ID. 0 if this is a host downtime.
start_timetimeScheduled downtime start time.
triggered_byunsigned integerInternal ID of the downtime that triggered this downtime.
was_cancelledbooleanTrue if the downtime was cancelled.
was_startedbooleanTrue if the downtime has been started.
commentstringDowntime comment.
is_recurringbooleanTrue if this downtime is recurring.
recurring_tpstringThe recurring timepriod of the recurring downtime.
come_fromshortId of the parent recurring downtime for spawned downtimes.

Event handler​

PropertyTypeDescription
early_timeoutbooleanTrue if the event handler timed out.
end_timetimeTime at which the event handler execution ended.
execution_timerealExecution time in seconds.
handler_typeshort integer0 for host-specific event handler, 1 for service-specific event handler, 2 for global host event handler and 3 for global service event handler.
host_idunsigned integerHost ID.
return_codeshort integerValue returned by the event handler.
service_idunsigned integerService ID. 0 if this is a host event handler.
start_timetimeTime at which the event handler started.
stateshort integerHost / service state.
state_typeshort integer0 for SOFT, 1 for HARD.
timeoutshort integerEvent handler timeout in seconds.
command_argsstringEvent handler arguments.
command_linestringEvent handler command line.
outputstringOutput returned by the event handler.
source_idunsigned integerThe id of the source instance of this event.
destination_idunsigned integerThe id of the destination instance of this event.

Flapping status​

PropertyTypeDescription
event_timetime
event_typeinteger
flapping_typeshort integer
high_thresholdrealHigh flapping threshold.
host_idunsigned integerHost ID.
low_thresholdrealLow flapping threshold.
percent_state_changereal
reason_typeshort integer
service_idunsigned integerService ID. 0 if this is a host flapping entry.

Host​

PropertyTypeDescriptionVersion
acknowledgedboolean
acknowledgement_typeshort integer
action_urlstring
active_checks_enabledboolean
addressstring
aliasstring
check_freshnessboolean
check_intervalreal
check_periodstring
check_typeshort integer
current_check_attemptshort integer
current_stateshort integer
default_active_checks_enabledboolean
default_event_handler_enabledboolean
default_flap_detection_enabledboolean
default_notifications_enabledboolean
default_passive_checks_enabledboolean
downtime_depthshort integer
display_namestring
enabledboolean
event_handlerstring
event_handler_enabledboolean
execution_timereal
first_notification_delayreal
flap_detection_enabledboolean
flap_detection_on_downboolean
flap_detection_on_unreachableboolean
flap_detection_on_upboolean
freshness_thresholdreal
has_been_checkedboolean
high_flap_thresholdreal
host_namestring
host_idunsigned integer
icon_imagestring
icon_image_altstring
instance_idunsigned integer
is_flappingboolean
last_checktime
last_hard_stateshort integer
last_hard_state_changetime
last_notificationtime
last_state_changetime
last_time_downtime
last_time_unreachabletime
last_time_uptime
last_updatetime
latencyreal
low_flap_thresholdreal
max_check_attemptsshort integer
next_checktime
next_notificationtime
no_more_notificationsboolean
notesstring
notes_urlstring
notification_intervalreal
notification_numbershort integer
notification_periodstring
notifications_enabledboolean
notify_on_downboolean
notify_on_downtimeboolean
notify_on_flappingboolean
notify_on_recoveryboolean
notify_on_unreachableboolean
obsess_overboolean
passive_checks_enabledboolean
percent_state_changereal
retry_intervalreal
should_be_scheduledboolean
stalk_on_downboolean
stalk_on_unreachableboolean
stalk_on_upboolean
statusmap_imagestring
state_typeshort integer
check_commandstring
outputstring
perf_datastring
retain_nonstatus_informationboolean
retain_status_informationboolean
timezonestring

Host check​

PropertyTypeDescriptionVersion
active_checks_enabledbooleanTrue if active checks are enabled on the host.
check_typeshort integer
host_idunsigned integerHost ID.
next_checktimeTime at which the next check is scheduled.
command_linestringCheck command line.
source_idunsigned integerThe id of the source instance this event.
destination_idunsigned integerThe id of the destination instance of this event.

Host dependency​

PropertyTypeDescriptionVersion
dependency_periodstring
dependent_host_idunsigned integer
enabledboolean
execution_failure_optionsstring
inherits_parentboolean
host_idunsigned integer
notification_failure_optionsstring

Host group​

PropertyTypeDescriptionVersion
host_group_idunsigned integer
namestringGroup name.
enabledbooleanTrue if the group is enabled, false if it is not (deletion).
poller_idunsigned integer

Host group member​

PropertyTypeDescriptionVersion
enabledbooleanTrue if the membership is enabled, false if it is not (deletion).
groupstringGroup name.
instance_idunsigned integerInstance ID.
host_idunsigned integerHost ID.
source_idunsigned integerThe id of the source instance this event.
destination_idunsigned integerThe id of the destination instance of this event.

Host parent​

PropertyTypeDescriptionVersion
enabledbooleanTrue if parenting is enabled, false if it is not (deletion).
child_idunsigned integerChild host ID.
parent_idunsigned integerParent host ID.

Host status​

PropertyTypeDescriptionVersion
acknowledgedboolean
acknowledgement_typeshort integer
active_checks_enabledboolean
check_intervalreal
check_periodstring
check_typeshort integer
current_check_attemptshort integer
current_stateshort integer
downtime_depthshort integer
enabledboolean
event_handlerstring
event_handler_enabledboolean
execution_timereal
flap_detection_enabledboolean
has_been_checkedboolean
host_idunsigned integer
is_flappingboolean
last_checktime
last_hard_stateshort integer
last_hard_state_changetime
last_notificationtime
last_state_changetime
last_time_downtime
last_time_unreachabletime
last_time_uptime
last_updatetime
latencyreal
max_check_attemptsshort integer
next_checktime
next_host_notificationtime
no_more_notificationsboolean
notification_numbershort integer
notifications_enabledboolean
obsess_overboolean
passive_checks_enabledboolean
percent_state_changereal
retry_intervalreal
should_be_scheduledboolean
state_typeshort integer
check_commandstring
outputstring
perf_datastring

Instance​

PropertyTypeDescriptionVersion
enginestringName of the monitoring engine used on this instance.
idunsigned integerInstance ID.
namestringInstance name.
is_runningbooleanWhether or not this instance is running.
pidunsigned integerMonitoring engine PID.
program_endtimeTime at which the instance shut down.
program_starttimeTime at which the instance started.
versionstringVersion of the monitoring engine used on this instance.

Instance status​

PropertyTypeDescriptionVersion
active_host_checks_enabledbooleanWhether or not active host checks are globally enabled.
active_service_checks_enabledbooleanWhether or not active service checks are globally enabled.
check_hosts_freshnessbooleanWhether or not hosts freshness checking is globally enabled.
check_services_freshnessbooleanWhether or not services freshness checking is globally enabled.
event_handler_enabledbooleanWhether or not event handlers are globally enabled.
flap_detection_enabledbooleanWhether or not flap detection is globally enabled.
idunsigned integerInstance ID.
last_alivetimeLast time the instance was known alive.
last_command_checktimeLast time a check command was executed.
notifications_enabledbooleanWhether or not notifications are globally enabled.
obsess_over_hostsbooleanWhether or not the monitoring engine should obsess over hosts.
obsess_over_servicesbooleanWhether or not the monitoring engine should obsess over services.
passive_host_checks_enabledbooleanWhether or not passive host checks are globally enabled.
passive_service_checks_enabledbooleanWhether or not passive service checks are globally enabled.
global_host_event_handlerstringGlobal host event handler.
global_service_event_handlerstringGlobal service event handler.

Log entry​

PropertyTypeDescriptionVersion
c_timetimeLog time.
host_idunsigned integerHost ID. 0 if log entry does not refer to a specific host or service.
host_namestringHost name. Can be empty if log entry does not refer to a specific host or service.
instance_namestringInstance name.
log_typeshort integer0 for SOFT, 1 for HARD.
msg_typeshort integer0 for SERVICE ALERT (sent on service state change), 1 for HOST ALERT (sent on host state change(, 2 for SERVICE NOTIFICATION (notification sent out for a service), 3 for HOST NOTIFICATION (notification sent out for a host), 4 for Warning (Centreon Engine warning), 5 for EXTERNAL COMMAND (external command received), 6 for CURRENT SERVICE STATE (current state of monitored service, usually sent at configuration reload), 7 for CURRENT HOST STATE (current state of monitored host, usually sent at configuration reload), 8 for INITIAL SERVICE STATE (initial state of service, after retention processing, sent at process start), 9 for INITIAL HOST STATE (initial state of monitored host, after retention processing, sent at process start), 10 for ACKNOWLEDGE_SVC_PROBLEM external command (special case of EXTERNAL COMMAND for service acknowledgement), 11 for ACKNOWLEDGE_HOST_PROBLEM external command (special case of EXTERNAL COMMAND for host acknowledgement).
notification_cmdstringNotification command.
notification_contactstringNotification contact.
retryintegerCurrent check attempt.
service_descriptionstringService description. Empty if log entry does not refer to a specific service.
service_idunsigned integerService ID. 0 if log entry does not refer to a specific service.
statusshort integerHost / service status.
outputstringOutput.

Module​

Module events are generated when Centreon Broker modules get loaded or unloaded.

PropertyTypeDescriptionVersion
argsstringModule arguments.
enabledbooleanWhether or not this module is enabled.
filenamestringPath to the module file.
instance_idunsigned integerInstance ID.
loadedbooleanWhether or not this module is loaded.
should_be_loadedbooleanWhether or not this module should be (should have been) loaded.

Service​

PropertyTypeDescriptionVersion
acknowledgedboolean
acknowledged_typeshort integer
action_urlstring
active_checks_enabledboolean
check_freshnessboolean
check_intervalreal
check_periodstring
check_typeshort integer
current_check_attemptshort integer
current_stateshort integer
default_active_checks_enabledboolean
default_event_handler_enabledboolean
default_flap_detection_enabledboolean
default_notifications_enabledboolean
default_passive_checks_enabledboolean
dowtine_depthshort integer
display_namestring
enabledboolean
event_handlerstring
event_handler_enabledboolean
execution_timereal
first_notification_delayreal
flap_detection_enabledboolean
flap_detection_on_criticalboolean
flap_detection_on_okboolean
flap_detection_on_unknownboolean
flap_detection_on_warningboolean
freshness_thresholdreal
has_been_checkedboolean
high_flap_thresholdreal
host_idunsigned integer
host_namestring
icon_imagestring
icon_image_altstring
service_idunsigned integer
is_flappingboolean
is_volatileboolean
last_checktime
last_hard_stateshort integer
last_hard_state_changetime
last_notificationtime
last_state_changetime
last_time_criticaltime
last_time_oktime
last_time_unknowntime
last_time_warningtime
last_updatetime
latencyreal
low_flap_thresholdreal
max_check_attemptsshort integer
next_checktime
next_notificationtime
no_more_notificationsboolean
notesstring
notes_urlstring
notification_intervalreal
notification_numbershort integer
notification_periodstring
notifications_enabledboolean
notify_on_criticalboolean
notify_on_downtimeboolean
notify_on_flappingboolean
notify_on_recoveryboolean
notify_on_unknownboolean
notify_on_warningboolean
obsess_overboolean
passive_checks_enabledboolean
percent_state_changereal
retry_intervalreal
scheduled_downtime_depthshort integer
service_descriptionstring
should_be_scheduledboolean
stalk_on_criticalboolean
stalk_on_okboolean
stalk_on_unknownboolean
stalk_on_warningboolean
state_typeshort integer
check_commandstring
outputstring
perf_datastring
retain_nonstatus_informationboolean
retain_status_informationboolean

Service check​

PropertyTypeDescriptionVersion
active_checks_enabledbooleanTrue if active checks are enabled on the service.
check_typeshort
host_idunsigned integerHost ID.
next_checktimeTime at which the next check is scheduled.
service_idunsigned integerService ID.
command_linestringCheck command line.

Service dependency​

PropertyTypeDescriptionVersion
dependency_periodstring
dependent_host_idunsigned integer
dependent_service_idunsigned integer
enabledboolean
execution_failure_optionsstring
host_idunsigned integer
inherits_parentboolean
notification_failure_optionsstring
service_idunsigned integer

Service group​

PropertyTypeDescriptionVersion
idunsigned integer
namestringGroup name.
enabledenabledTrue if the group is enable, false if it is not (deletion).
poller_idunsigned integer

Service group member​

PropertyTypeDescriptionVersion
idunsigned integer
host_idunsigned integer
service_idunsigned integer
enabledenabledTrue if the group is enable, false if it is not (deletion).
group_namestringGroup name.
poller_idunsigned integer

Service status​

PropertyTypeDescriptionVersion
acknowledgedboolean
acknowledgement_typeshort integer
active_checks_enabledboolean
check_intervalreal
check_periodstring
check_typeshort integer
current_check_attemptshort integer
current_stateshort integer
downtime_depthshort integer
enabledboolean
event_handlerstring
event_handler_enabledboolean
execution_timereal
flap_detection_enabledboolean
has_been_checkedboolean
host_idunsigned integer
host_namestring
is_flappingboolean
last_checktime
last_hard_stateshort integer
last_hard_state_changetime
last_notificationtime
last_state_changetime
last_time_criticaltime
last_time_oktime
last_time_unknowntime
last_time_warningtime
last_updatetime
latencyreal
max_check_attemptsshort integer
modified_attributesunsigned integer
next_checktime
next_notificationtime
no_more_notificationsboolean
notification_numbershort integer
notifications_enabledboolean
obsess_overboolean
passive_checks_enabledboolean
percent_state_changereal
retry_intervalreal
service_descriptionstring
service_idunsigned integer
should_be_scheduledboolean
state_typeshort integer
check_commandstring
outputstring
perf_datastring

Instance configuration​

PropertyTypeDescriptionVersion
loadedbooleanTrue if the instance loaded successfully.
poller_idunsigned integerID of the poller which received a configuration update request (reload).

Responsive instance​

PropertyTypeDescriptionVersion
poller_idunsigned integerID of the poller which received a configuration update request (reload).
responsivebooleanA boolean telling if the poller with ID poller_id is responsive or not.

Pb Service​

This event is a Protobuf event so items are not serialized as in the previous events but using the Protobuf 3 serialization mechanism. When BBDO 3 version is used, no more Service messages should be sent, instead you should see these ones.

Such a message is sent to declare a new service or to declare a service change.

The protobuf message is the following:

enum ServiceType {
SERVICE = 0;
METASERVICE = 2;
BA = 3;
}

message Service {
uint64 host_id = 1;
uint64 service_id = 2;

enum AckType {
NONE = 0;
NORMAL = 1;
STICKY = 2;
}
bool acknowledged = 3;
AckType acknowledgement_type = 4;

bool active_checks = 5;
bool enabled = 6;
int32 scheduled_downtime_depth = 7;
string check_command = 8;
uint32 check_interval = 9;
string check_period = 10;

enum CheckType {
ACTIVE = 0;
PASSIVE = 1;
}
CheckType check_type = 11;
int32 check_attempt = 12;
enum State {
OK = 0;
WARNING = 1;
CRITICAL = 2;
UNKNOWN = 3;
PENDING = 4;
}
State state = 13;
bool event_handler_enabled = 14;
string event_handler = 15;
double execution_time = 16;
bool flap_detection = 17;
bool checked = 18;
bool flapping = 19;
int64 last_check = 20;
State last_hard_state = 21;
int64 last_hard_state_change = 22;
int64 last_notification = 23;
int32 notification_number = 24;
int64 last_state_change = 25;
int64 last_time_ok = 26;
int64 last_time_warning = 27;
int64 last_time_critical = 28;
int64 last_time_unknown = 29;
int64 last_update = 30;
double latency = 31;
uint32 max_check_attempts = 32;
int64 next_check = 33;
int64 next_notification = 34;
bool no_more_notifications = 35;
bool notify = 36;
string output = 37;
string long_output = 38;
bool passive_checks = 39;
double percent_state_change = 40;
string perfdata = 41;
double retry_interval = 42;
string host_name = 43;
string description = 44;
bool should_be_scheduled = 45;
bool obsess_over_service = 46;

enum StateType {
SOFT = 0;
HARD = 1;
}

StateType state_type = 47;
string action_url = 48;
bool check_freshness = 49;
bool default_active_checks = 50;
bool default_event_handler_enabled = 51;
bool default_flap_detection = 52;
bool default_notify = 53;
bool default_passive_checks = 54;
string display_name = 55;
double first_notification_delay = 56;
bool flap_detection_on_critical = 57;
bool flap_detection_on_ok = 58;
bool flap_detection_on_unknown = 59;
bool flap_detection_on_warning = 60;
double freshness_threshold = 61;
double high_flap_threshold = 62;
string icon_image = 63;
string icon_image_alt = 64;
bool is_volatile = 65;
double low_flap_threshold = 66;
string notes = 67;
string notes_url = 68;
double notification_interval = 69;
string notification_period = 70;
bool notify_on_critical = 71;
bool notify_on_downtime = 72;
bool notify_on_flapping = 73;
bool notify_on_recovery = 74;
bool notify_on_unknown = 75;
bool notify_on_warning = 76;
bool stalk_on_critical = 77;
bool stalk_on_ok = 78;
bool stalk_on_unknown = 79;
bool stalk_on_warning = 80;
bool retain_nonstatus_information = 81;
bool retain_status_information = 82;
uint64 severity_id = 83;
repeated TagInfo tags = 84;

ServiceType type = 85;

/* In case of metaservice and ba, they also have an internal id. We keep it
* here. */
uint64 internal_id = 86;
uint64 icon_id = 87;
}

Pb Adaptive service​

When BBDO 3 version is used, you can see this event sent when a service has changes in its configuration.

The protobuf message is the following:

message AdaptiveService {
uint64 host_id = 1;
uint64 service_id = 2;

optional bool notify = 3;
optional bool active_checks = 4;
optional bool should_be_scheduled = 5;
optional bool passive_checks = 6;
optional bool event_handler_enabled = 7;
optional bool flap_detection_enabled = 8;
optional bool obsess_over_service = 9;
optional string event_handler = 10;
optional string check_command = 11;
optional uint32 check_interval = 12;
optional uint32 retry_interval = 13;
optional uint32 max_check_attempts = 14;
optional bool check_freshness = 15;
optional string check_period = 16;
optional string notification_period = 17;
}

Pb Service Status​

When BBDO 3 version is used, this type of event is sent instead of Service Status. Its content is almost the same but the old one contains some configuration items you don't have here, A Pb Service Status is smaller than a Service Status. Missing items can be found in Pb Service.

The protobuf message is the following:

message ServiceStatus {
uint64 host_id = 1;
uint64 service_id = 2;

bool checked = 3;
enum CheckType {
ACTIVE = 0;
PASSIVE = 1;
}
CheckType check_type = 4;

enum State {
OK = 0;
WARNING = 1;
CRITICAL = 2;
UNKNOWN = 3;
PENDING = 4;
}
State state = 5;
enum StateType {
SOFT = 0;
HARD = 1;
}
StateType state_type = 6;
int64 last_state_change = 7;
State last_hard_state = 8;
int64 last_hard_state_change = 9;
int64 last_time_ok = 10;
int64 last_time_warning = 11;
int64 last_time_critical = 12;
int64 last_time_unknown = 13;

string output = 14;
string long_output = 15;
string perfdata = 16;

bool flapping = 17;
double percent_state_change = 18;
double latency = 19;
double execution_time = 20;
int64 last_check = 21;
int64 next_check = 22;
bool should_be_scheduled = 23;
int32 check_attempt = 24;

int32 notification_number = 25;
bool no_more_notifications = 26;
int64 last_notification = 27;
int64 next_notification = 28;

enum AckType {
NONE = 0;
NORMAL = 1;
STICKY = 2;
}
AckType acknowledgement_type = 29;
int32 scheduled_downtime_depth = 30;

ServiceType type = 31;

/* In case of metaservice and ba, they also have an internal id. We keep it
* here. */
uint64 internal_id = 32;
}

Pb Host​

When BBDO 3 version is used, this type of event is sent instead of Host. Its content is almost the same.

The protobuf message is the following:

message Host {
uint64 host_id = 1;

enum AckType {
NONE = 0;
NORMAL = 1;
STICKY = 2;
}
bool acknowledged = 2;
int32 acknowledgement_type = 3;

bool active_checks = 4;
bool enabled = 5;
int32 scheduled_downtime_depth = 6;
string check_command = 7;
int32 check_interval = 8;
string check_period = 9;

enum CheckType {
ACTIVE = 0;
PASSIVE = 1;
}
CheckType check_type = 10;
int32 check_attempt = 11;
enum State {
UP = 0;
DOWN = 1;
UNREACHABLE = 2;
}
State state = 12;
bool event_handler_enabled = 13;
string event_handler = 14;
double execution_time = 15;
bool flap_detection = 16;
bool checked = 17;
bool flapping = 18;
int64 last_check = 19;
State last_hard_state = 20;
int64 last_hard_state_change = 21;
int64 last_notification = 22;
int32 notification_number = 23;
int64 last_state_change = 24;
int64 last_time_down = 25;
int64 last_time_unreachable = 26;
int64 last_time_up = 27;
int64 last_update = 28;
double latency = 29;
int32 max_check_attempts = 30;
int64 next_check = 31;
int64 next_host_notification = 32;
bool no_more_notifications = 33;
bool notify = 34;
string output = 35;
bool passive_checks = 36;
double percent_state_change = 37;
string perfdata = 38;
double retry_interval = 39;
bool should_be_scheduled = 40;
bool obsess_over_host = 41;

enum StateType {
SOFT = 0;
HARD = 1;
}

StateType state_type = 42;
string action_url = 43;
string address = 44;
string alias = 45;
bool check_freshness = 46;
bool default_active_checks = 47;
bool default_event_handler_enabled = 48;
bool default_flap_detection = 49;
bool default_notify = 50;
bool default_passive_checks = 51;
string display_name = 52;
double first_notification_delay = 53;
bool flap_detection_on_down = 54;
bool flap_detection_on_unreachable = 55;
bool flap_detection_on_up = 56;
double freshness_threshold = 57;
double high_flap_threshold = 58;
string name = 59;
string icon_image = 60;
string icon_image_alt = 61;
int32 instance_id = 62;
double low_flap_threshold = 63;
string notes = 64;
string notes_url = 65;
double notification_interval = 66;
string notification_period = 67;
bool notify_on_down = 68;
bool notify_on_downtime = 69;
bool notify_on_flapping = 70;
bool notify_on_recovery = 71;
bool notify_on_unreachable = 72;
bool stalk_on_down = 73;
bool stalk_on_unreachable = 74;
bool stalk_on_up = 75;
string statusmap_image = 76;
bool retain_nonstatus_information = 77;
bool retain_status_information = 78;
string timezone = 79;
uint64 severity_id = 80;
repeated TagInfo tags = 81;
uint64 icon_id = 82;
}

Pb Adaptive host​

When BBDO 3 version is used, you can see this event sent when a host has changes in its configuration.

The protobuf message is the following:

message AdaptiveHost {
uint64 host_id = 1;

optional bool notify = 2;
optional bool active_checks = 3;
optional bool should_be_scheduled = 4;
optional bool passive_checks = 5;
optional bool event_handler_enabled = 6;
optional bool flap_detection = 7;
optional bool obsess_over_host = 8;
optional string event_handler = 9;
optional string check_command = 10;
optional uint32 check_interval = 11;
optional uint32 retry_interval = 12;
optional uint32 max_check_attempts = 13;
optional bool check_freshness = 14;
optional string check_period = 15;
optional string notification_period = 16;
}

Pb Host Status​

When BBDO 3 version is used, this type of event is sent instead of Host Status. Its content is almost the same but the old one contains some configuration items you don't have here, A Pb Host Status is smaller than a Host Status. Missing items can be found in Pb Host.

The protobuf message is the following:

message HostStatus {
uint64 host_id = 1;

bool checked = 2;
enum CheckType {
ACTIVE = 0;
PASSIVE = 1;
}
CheckType check_type = 3;

enum State {
UP = 0;
DOWN = 1;
UNREACHABLE = 2;
}
State state = 4;
enum StateType {
SOFT = 0;
HARD = 1;
}
StateType state_type = 5;
int64 last_state_change = 6;
State last_hard_state = 7;
int64 last_hard_state_change = 8;
int64 last_time_up = 9;
int64 last_time_down = 10;
int64 last_time_unreachable = 11;

string output = 12;
string long_output = 13;
string perfdata = 14;

bool flapping = 15;
double percent_state_change = 16;
double latency = 17;
double execution_time = 18;
int64 last_check = 19;
int64 next_check = 20;
bool should_be_scheduled = 21;
int32 check_attempt = 22;

int32 notification_number = 23;
bool no_more_notifications = 24;
int64 last_notification = 25;
int64 next_host_notification = 26;

enum AckType {
NONE = 0;
NORMAL = 1;
STICKY = 2;
}
AckType acknowledgement_type = 27;
int32 scheduled_downtime_depth = 28;
}

Pb Severity​

This event comes with BBDO 3. It contains the severity of a resource. The protobuf message is the following:

message Severity {
uint64 id = 1;
enum Action {
ADD = 0;
DELETE = 1;
MODIFY = 2;
}
Action action = 2;
uint32 level = 3;
uint64 icon_id = 4;
string name = 5;
enum Type {
SERVICE = 0;
HOST = 1;
}
Type type = 6;
uint64 poller_id = 7;
}

Pb Tag​

This event comes with BBDO 3. It is used to associate a tag to a resource. There are four types of tag, SERVICEGROUP, HOSTGROUP, SERVICECATEGORY, HOSTCATEGORY. A tag is not associated with a poller, but we must know for internal handling which poller sent the tag, that is why there is a poller_id item in the message.

The protobuf message is the following:

enum TagType {
SERVICEGROUP = 0;
HOSTGROUP = 1;
SERVICECATEGORY = 2;
HOSTCATEGORY = 3;
}

message Tag {
uint64 id = 1;
enum Action {
ADD = 0;
DELETE = 1;
MODIFY = 2;
}

Action action = 2;
TagType type = 3;
string name = 4;
int64 poller_id = 5;
}

Storage​

Metric​

This event is generated by a Storage endpoint to notify that a RRD metric graph should be updated.

PropertyTypeDescriptionVersion
ctimetimeTime at which the metric value was generated.
intervalunsigned integerNormal service check interval in seconds.
metric_idunsigned integerMetric ID (from the metrics table).
namestringMetric name.
rrd_lenintegerRRD retention length in seconds.
valuerealMetric value.
value_typeshort integerMetric type (1 =3D counter, 2 =3D derive, 3 =3D absolute, other =3D gauge).
is_for_rebuildbooleanSet to true when a graph is being rebuild (see the rebuild event).
host_idunsigned integerThe id of the host this metric is attached to.Since 3.0.0
service_idunsigned integerThe id of the service this metric is attached to.Since 3.0.0

Rebuild​

Rebuild events are generated when a Storage endpoint detects that some graph should be rebuild. It first sends a rebuild start event (end =3D false), then metric values (metric event with is_for_rebuild set to true) and finally a rebuild end event (end =3D true).

PropertyTypeDescriptionVersion
endbooleanEnd flag. Set to true if rebuild is starting, false if it is ending.
idunsigned integerID of metric to rebuild if is_index is false, or ID of index to rebuild (status graph) if is_index is true.
is_indexbooleanIndex flag. Rebuild index (status) if true, rebuild metric if false.

Remove graph​

A Storage endpoint generates a remove graph event when some graph must be deleted.

PropertyTypeDescriptionVersion
idunsigned integerIndex ID (is_index =3D true) or metric ID (is_index =3D false) to remove.
is_indexbooleanIndex flag. If true, a index (status) graph will be deleted. If false, a metric graph will be deleted.

Status​

PropertyTypeDescriptionVersion
ctimetimeTime at which the status was generated.
index_idunsigned integerIndex ID.
intervalunsigned integerNormal service check interval in seconds.
rrd_lentimeRRD retention in seconds.
stateshort integerService state.
is_for_rebuildbooleanSet to true when a graph is being rebuild (see the rebuild event).

Metric mapping​

PropertyTypeDescriptionVersion
index_idunsigned integerIndex ID.
metric_dunsigned integerIndex ID.

Index mapping​

PropertyTypeDescriptionVersion
index_idunsigned integerIndex ID.
host_idunsigned integerIndex ID.
service_idunsigned integerIndex ID.

Pb Rebuild Message​

This event comes with BBDO 3. When some graphs have to be rebuilt. Messages handling these rebuilds are of that type. They replace the old BBDO rebuild message.

There are three states for this message:

  • START: here is the first state, this message initializes which metrics have to be rebuilt.
  • DATA: once the START state has been sent, one or more messages with DATA state may be sent to the RRD broker.
  • END: When all the rebuild events have been sent, this one is sent to close the rebuilds. And the RRD broker falls back in a nominal state.

The protobuf message is the following:

message Point {
int64 ctime = 1;
double value = 2;
}

message Timeserie {
repeated Point pts = 1;
int32 data_source_type = 2;
uint32 check_interval = 3;
uint32 rrd_retention = 4;
}

message RebuildMessage {
enum State {
START = 0;
DATA = 1;
END = 2;
}
State state = 1;
/* Only used on DATA state */
map<uint64, Timeserie> timeserie = 2;

/* Only used on START/END state */
repeated uint64 metric_id = 3;
}

Pb Remove Graph Message​

This event comes with BBDO 3. When we want to remove graph files, we can use the centengine gRPC API and this call makes cbd to generate a Pb Remove Graph Message. Two possibilities are mixed in this event. We can remove graphes matching some index data or graphs matching some metric data. It is also possible to mix the two kinds.

The protobuf message is the following:

message RemoveGraphMessage {
repeated uint64 index_ids = 1;
repeated uint64 metric_ids = 2;
}

BBDO​

Version response​

PropertyTypeDescriptionVersion
bbdo_majorshort integerBBDO protocol major used by the peer sending this version_response packet. The sole current protocol version is 1.0.0.
bbdo_minorshort integerBBDO protocol minor used by the peer sending this version_response packet.
bbdo_patchshort integerBBDO protocol patch used by the peer sending this version_response packet.
extensionsstringSpace-separated string of extensions supported by the peer sending this version_response packet.

Ack​

PropertyTypeDescriptionVersion
acknowledged eventsunsigned integerNumber of acknowledged events. Only used by "smart" clients (i.e able to acknowledge events). Not to be used by dumb clients.

BAM​

BA status event​

This event is sent when a BA's status changed.

PropertyTypeDescriptionVersion
ba_idunsigned integerThe id of the BA.Since 2.8.0 (BBDO 1.2.0).
in_downtimebooleanTrue of the BA is in downtime.Since 2.8.0 (BBDO 1.2.0).
last_state_changetimeThe time of the last state change of the BA.Since 2.8.0 (BBDO 1.2.0).
level_acknowledgementrealThe acknowledgment level of the BA.Since 2.8.0 (BBDO 1.2.0).
level_downtimerealThe downtime level of the BA.Since 2.8.0 (BBDO 1.2.0).
level_nominalrealThe nominal level of the BA.Since 2.8.0 (BBDO 1.2.0).
stateshort integerThe state of the BA.Since 2.8.0 (BBDO 1.2.0).
state_changedbooleanTrue if the state of the BA just changed.Since 2.8.0 (BBDO 1.2.0).

KPI status event​

This event is sent when a KPI's status changed.

PropertyTypeDescriptionVersion
kpi_idunsigned integerThe id of the KPI.Since 2.8.0 (BBDO 1.2.0).
in_downtimeboolTrue if the KPI is in downtime.
level_acknowledgement_hardrealThe hard acknowledgement level of the KPI.Since 2.8.0 (BBDO 1.2.0).
level_acknowledgement_softrealThe soft acknowledgement level of the KPI.Since 2.8.0 (BBDO 1.2.0).
level_downtime_hardrealThe hard downtime level of the KPI.Since 2.8.0 (BBDO 1.2.0).
level_downtime_softrealThe soft downtime level of the KPI.Since 2.8.0 (BBDO 1.2.0).
level_nominal_hardrealThe hard nominal level of the KPI.Since 2.8.0 (BBDO 1.2.0).
level_nominal_softrealThe soft nominal level of the KPI.Since 2.8.0 (BBDO 1.2.0).
state_hardshort integerThe hard state of the KPI.Since 2.8.0 (BBDO 1.2.0).
state_softshort integerThe soft state of the KPI.Since 2.8.0 (BBDO 1.2.0).
last_state_changetimeThe time of the last state change of the KPI.Since 2.8.0 (BBDO 1.2.0).
last_impactrealThe last impact of the KPI.Since 2.8.0 (BBDO 1.2.0).
validboolTrue if the KPi is valid.

Meta service status event​

This event is sent when a meta service's status changed.

PropertyTypeDescriptionVersion
meta_service_idunsigned integerThe id of the meta service.Since 2.8.0 (BBDO 1.2.0).
valuerealThe value of the meta service.Since 2.8.0 (BBDO 1.2.0).
state_changedbooleanTrue if the state just changed.Since 2.8.0 (BBDO 1.2.0).

BA-event event​

This event is sent when a new BA event is opened, or an old one is closed.

PropertyTypeDescriptionVersion
ba_idunsigned integerThe id of the BA.Since 2.8.0 (BBDO 1.2.0).
first_levelrealThe first level of the BA event.Since 2.8.0 (BBDO 1.2.0).
end_timetimeThe end_time of the event. 0 or (time)-1 for an opened event.Since 2.8.0 (BBDO 1.2.0).
in_downtimebooleanTrue if BA was in downtime during the BA event.Since 2.8.0 (BBDO 1.2.0).
start_timetimeThe start_time of the event.Since 2.8.0 (BBDO 1.2.0).
statusshort integerThe status of the BA during the event.Since 2.8.0 (BBDO 1.2.0).

KPI-event event​

This event is sent when a new KPI event is opened, or an old one is closed.

PropertyTypeDescriptionVersion
kpi_idunsigned integerThe id of the KPI.Since 2.8.0 (BBDO 1.2.0).
end_timetimeThe end_time of the event. 0 or (time)-1 for an opened event.Since 2.8.0 (BBDO 1.2.0).
impact_levelintegerThe level of the impact.Since 2.8.0 (BBDO 1.2.0).
in_downtimebooleanTrue if BA was in downtime during the BA event.Since 2.8.0 (BBDO 1.2.0).
first_outputstringThe first output of the KPI during the event.Since 2.8.0 (BBDO 1.2.0).
perfdatastringThe first perfdata of the KPI during the event.Since 2.8.0 (BBDO 1.2.0).
start_timetimeThe start_time of the event.Since 2.8.0 (BBDO 1.2.0).
statusshort integerThe status of the BA during the event.Since 2.8.0 (BBDO 1.2.0).

BA duration event event​

This event is sent when a new BA duration event is computed by BAM broker.

PropertyTypeDescriptionVersion
ba_idunsigned integerThe id of the BA.Since 2.8.0 (BBDO 1.2.0).
real_start_timetimeThe first level of the BA event.Since 2.8.0 (BBDO 1.2.0).
end_timetimeThe end_time of the event, in the given timeperiod.Since 2.8.0 (BBDO 1.2.0).
start_timetimeThe start_time of the event, in the given timeperiod.Since 2.8.0 (BBDO 1.2.0).
durationunsigned integerend_time - start_time.Since 2.8.0 (BBDO 1.2.0).
sla_durationunsigned integerThe duration of the event in the given timperiod.Since 2.8.0 (BBDO 1.2.0).
timeperiod_is_defaultbooleanTrue if the timeperiod if the default for this BA.Since 2.8.0 (BBDO 1.2.0).

Dimension BA​

This event is part of the dimension (i.e configuration) dump occuring at startup and after each BAM configuration reload.

PropertyTypeDescriptionVersion
ba_idunsigned integerThe id of the BA.Since 2.8.0 (BBDO 1.2.0).
ba_namestringThe name of the BA.Since 2.8.0 (BBDO 1.2.0).
ba_descriptionstringThe description of the BA.Since 2.8.0 (BBDO 1.2.0).
sla_month_percent_critrealSince 2.8.0 (BBDO 1.2.0).
sla_month_percent_warnrealSince 2.8.0 (BBDO 1.2.0).
sla_month_duration_critunsigned integerSince 2.8.0 (BBDO 1.2.0).
sla_month_duration_warnunsigned integerSince 2.8.0 (BBDO 1.2.0).

Dimension KPI​

This event is part of the dimension (i.e configuration) dump occuring at startup and after each BAM configuration reload.

PropertyTypeDescriptionVersion
kpi_idunsigned integerThe id of the KPI.Since 2.8.0 (BBDO 1.2.0).
ba_idunsigned integerThe id of the parent BA of this KPI.Since 2.8.0 (BBDO 1.2.0).
ba_namestringThe name of the parent BA of this KPI.Since 2.8.0 (BBDO 1.2.0).
host_idunsigned integerThe id of the host associated with this KPI for service KPI.Since 2.8.0 (BBDO 1.2.0).
host_namestringThe name of the host associated with this KPI for service KPI.Since 2.8.0 (BBDO 1.2.0)
service_idunsigned integerThe id of the service associated with this KPI for service KPI.Since 2.8.0 (BBDO 1.2.0).
service_descriptionstringThe description of the service associated with this KPI for service KPI.Since 2.8.0 (BBDO 1.2.0).
kpi_ba_idunsigned integerThe id of the BA associated with this KPI for BA KPI.Since 2.8.0 (BBDO 1.2.0).
kpi_ba_namestringThe name of the BA associated with this KPI for BA KPI.Since 2.8.0 (BBDO 1.2.0).
meta_service_idunsigned intThe id of the meta-service associated with this KPI for meta-service KPI.Since 2.8.0 (BBDO 1.2.0).
meta_service_namestringThe name of the meta-service associated with this KPI for meta-service KPI.Since 2.8.0 (BBDO 1.2.0).
boolean_idunsigned intThe id of the boolean expression associated with this KPI for boolean KPI.Since 2.8.0 (BBDO 1.2.0).
boolean_namestringThe name of the boolean expression associated with this KPI for boolean KPI.Since 2.8.0 (BBDO 1.2.0).
impact_warningrealThe impact of a warning state for this KPI.Since 2.8.0 (BBDO 1.2.0).
impact_criticalrealThe impact of a critical state for this KPI.Since 2.8.0 (BBDO 1.2.0).
impact_unknownrealThe impact of a unknown state for this KPI.Since 2.8.0 (BBDO 1.2.0).

Dimension BA BV relation​

This event is part of the dimension (i.e configuration) dump occuring at startup and after each BAM configuration reload.

PropertyTypeDescriptionVersion
ba_idunsigned integerThe id of the BA.Since 2.8.0 (BBDO 1.2.0).
bv_idunsigned integerThe id of the BV.Since 2.8.0 (BBDO 1.2.0).

Dimension BV​

This event is part of the dimension (i.e configuration) dump occuring at startup and after each BAM configuration reload.

PropertyTypeDescriptionVersion
bv_idunsigned integerThe id of the BV.Since 2.8.0 (BBDO 1.2.0).
bv_namestringThe name of the BV.Since 2.8.0 (BBDO 1.2.0).
bv_descriptionstringThe description of the BV.Since 2.8.0 (BBDO 1.2.0).

Dimension table signal​

This event is part of the dimension (i.e configuration) dump occuring at startup and after each BAM configuration reload.

This signal is sent before the dump of all the dimensions, and again at the end of the dump.

PropertyTypeDescriptionVersion
update_startedbooleanTrue if this is the start of the dump, false if it's the end.Since 2.8.0 (BBD0 1.2.0).

Rebuild signal​

This event is sent when a rebuild of the event durations and availabilities is asked to the BAM broker endpoint.

PropertyTypeDescriptionVersion
bas_to_rebuildstringA string containing the id of all the BAs to rebuild, separated by a comma and a space (i.e "1, 5, 8, 12").Since 2.8.0 (BBDO 1.2.0).

Dimension timeperiod​

This event is part of the dimension (i.e configuration) dump occuring at startup and after each BAM configuration reload.

PropertyTypeDescriptionVersion
tp_idunsigned integerThe id of the timeperiod.Since 2.8.0 (BBDO 1.2.0).
namestringThe name of the timeperiod.Since 2.8.0 (BBDO 1.2.0).
mondaystringThe timeperiod rule for this day.Since 2.8.0 (BBDO 1.2.0).
tuesdaystringThe timeperiod rule for this day.Since 2.8.0 (BBDO 1.2.0).
wednesdaystringThe timeperiod rule for this day.Since 2.8.0 (BBDO 1.2.0).
thursdaystringThe timeperiod rule for this day.Since 2.8.0 (BBDO 1.2.0).
fridaystringThe timeperiod rule for this day.Since 2.8.0 (BBDO 1.2.0).
saturdaystringThe timeperiod rule for this day.Since 2.8.0 (BBDO 1.2.0).
sundaystringThe timeperiod rule for this day.Since 2.8.0 (BBDO 1.2.0).

Dimension BA timeperiod relation​

This event is part of the dimension (i.e configuration) dump occuring at startup and after each BAM configuration reload.

PropertyTypeDescriptionVersion
ba_idunsigned integerThe id of the BA.Since 2.8.0 (BBDO 1.2.0).
timeperiod_idunsigned integerThe id of the timeperiod.Since 2.8.0 (BBDO 1.2.0).
is_defaultbooleanTrue if the timeperiod is the default one for this BA.Since 2.8.0 (BBDO 1.2.0).

Dimension timeperiod exception​

This event is part of the dimension (i.e configuration) dump occuring at startup and after each BAM configuration reload.

PropertyTypeDescriptionVersion
timeperiod_idunsigned integerThe id of the timeperiod having this exception.Since 2.8.0
daterangestringA string containing the date of the range.Since 2.8.0
timerangestringA string containing the time of the range.Since 2.8.0 (BBDO 1.2.0).

Dimension timeperiod exclusion​

This event is part of the dimension (i.e configuration) dump occuring at startup and after each BAM configuration reload.

PropertyTypeDescriptionVersion
timeperiod_idunsigned integerThe id of the timeperiod having this exclusion.Since 2.8.0 (BBDO 1.2.0).
excluded_timeperiod_idunsigned integerThe id of the excluded timeperiod.Since 2.8.0 (BBDO 1.2.0).

Inherited downtime​

PropertyTypeDescriptionVersion
bad_idunsigned integerThe id of the BA in downtime.
in_downtimebooleanTrue if the BA is in downtime.

Extcmd​

Command request​

PropertyTypeDescriptionVersion
commandstringThe command request.
endpstringThe endpoint this command is destined to.
uuidstringThe uuid of this request.
with_partial_resultbooleanTrue if the command should be answered with partial result.

Command result​

PropertyTypeDescriptionVersion
codeintegerThe return code of this command.
uuidstringThe uuid of the request this command is the result of.
msgstringThe string message of the command result.