Skip to content

Commit

Permalink
Update description of *PROBLEMID and *NOTIFICATIONID macros which are…
Browse files Browse the repository at this point in the history
… now UUIDv4 strings instead of integer counter values

naemon/naemon-core#447

Signed-off-by: nook24 <info@nook24.eu>
  • Loading branch information
nook24 committed Feb 5, 2024
1 parent af34cc2 commit 79e717b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions documentation/usersguide/macrolist.md
Original file line number Diff line number Diff line change
Expand Up @@ -888,11 +888,11 @@ macros consist of all uppercase characters and are enclosed in <b>$</b> characte
</tr>
<tr>
<td class="MacroName"><a name="hostproblemid">$HOSTPROBLEMID$</a></td>
<td class="MacroDescription">A globally unique number associated with the host's current problem state. Every time a host (or service) transitions from an UP or OK state to a problem state, a global problem ID number is incremented by one (1). This macro will be non-zero if the host is currently a non-UP state. State transitions between non-UP states (e.g. DOWN to UNREACHABLE) do not cause this problem id to increase. If the host is currently in an UP state, this macro will be set to zero (0). Combined with event handlers, this macro could be used to automatically open trouble tickets when hosts first enter a problem state.</td>
<td class="MacroDescription">A globally unique UUIDv4 (e.g. 29304481-91eb-4a2f-8b6d-8858b4548741) associated with the host's current problem state. Every time a host (or service) transitions from an UP or OK state to a problem state, a global problem UUID is generated. This macro will be a UUID string if the host is currently a non-UP state. State transitions between non-UP states (e.g. DOWN to UNREACHABLE) do not cause this problem id to change. If the host is currently in an UP state, this macro will be set to an empty string. Combined with event handlers, this macro could be used to automatically open trouble tickets when hosts first enter a problem state.</td>
</tr>
<tr>
<td class="MacroName"><a name="lasthostproblemid">$LASTHOSTPROBLEMID$</a></td>
<td class="MacroDescription">The previous (globally unique) problem number that was given to the host. Combined with event handlers, this macro could be used for automatically closing trouble tickets, etc. when a host recovers to an UP state.</td>
<td class="MacroDescription">The previous (globally unique) problem UUID that was given to the host. Combined with event handlers, this macro could be used for automatically closing trouble tickets, etc. when a host recovers to an UP state.</td>
</tr>
<tr>
<td class="MacroName"><a name="hostlatency">$HOSTLATENCY$</a></td>
Expand Down Expand Up @@ -1088,11 +1088,11 @@ macros consist of all uppercase characters and are enclosed in <b>$</b> characte
</tr>
<tr>
<td class="MacroName"><a name="serviceproblemid">$SERVICEPROBLEMID$</a></td>
<td class="MacroDescription">A globally unique number associated with the service's current problem state. Every time a service (or host) transitions from an OK or UP state to a problem state, a global problem ID number is incremented by one (1). This macro will be non-zero if the service is currently a non-OK state. State transitions between non-OK states (e.g. WARNING to CRITICAL) do not cause this problem id to increase. If the service is currently in an OK state, this macro will be set to zero (0). Combined with event handlers, this macro could be used to automatically open trouble tickets when services first enter a problem state.</td>
<td class="MacroDescription">A globally unique UUIDv4 (e.g. 39dbb346-f483-49fe-8211-feec8edf90ea) associated with the service's current problem state. Every time a service (or host) transitions from an OK or UP state to a problem state, a global problem UUID is generated. This macro will be a UUID if the service is currently a non-OK state. State transitions between non-OK states (e.g. WARNING to CRITICAL) do not cause this problem id to change. If the service is currently in an OK state, this macro will be set to an empty string. Combined with event handlers, this macro could be used to automatically open trouble tickets when services first enter a problem state.</td>
</tr>
<tr>
<td class="MacroName"><a name="lastserviceproblemid">$LASTSERVICEPROBLEMID$</a></td>
<td class="MacroDescription">The previous (globally unique) problem number that was given to the service. Combined with event handlers, this macro could be used for automatically closing trouble tickets, etc. when a service recovers to an OK state.</td>
<td class="MacroDescription">The previous (globally unique) problem UUID that was given to the service. Combined with event handlers, this macro could be used for automatically closing trouble tickets, etc. when a service recovers to an OK state.</td>
</tr>
<tr>
<td class="MacroName"><a name="servicelatency">$SERVICELATENCY$</a></td>
Expand Down Expand Up @@ -1368,15 +1368,15 @@ macros consist of all uppercase characters and are enclosed in <b>$</b> characte
</tr>
<tr>
<td class="MacroName"><a name="hostnotificationid">$HOSTNOTIFICATIONID$</a></td>
<td class="MacroDescription">A unique number identifying a host notification. Notification ID numbers are unique across both hosts and service notifications, so you could potentially use this unique number as a primary key in a notification database. Notification ID numbers should remain unique across restarts of the Naemon process, so long as you have state retention enabled. The notification ID number is incremented by one (1) each time a new host notification is sent out, and regardless of how many contacts are notified.</td>
<td class="MacroDescription">A unique UUIDv4 (e.g. 3a07d4f2-575e-413b-8166-9ccdd22d418a) identifying a host notification. Notification UUID strings are unique across both hosts and service notifications, so you could potentially use this unique string as a primary key in a notification database. Notification UUIDs should remain unique across restarts of the Naemon process, so long as you have state retention enabled. The notification UUID is generated each time a new host notification is sent out, and the same regardless of how many contacts are notified.</td>
</tr>
<tr>
<td class="MacroName"><a name="servicenotificationnumber">$SERVICENOTIFICATIONNUMBER$</a></td>
<td class="MacroDescription">The current notification number for the service. The notification number increases by one (1) each time a new notification is sent out for the service (except for acknowledgements). The notification number is reset to 0 when the service recovers (<i>after</i> the recovery notification has gone out). acknowledgements do not cause the notification number to increase, nor do notifications dealing with flap detection or scheduled downtime.</td>
</tr>
<tr>
<td class="MacroName"><a name="servicenotificationid">$SERVICENOTIFICATIONID$</a></td>
<td class="MacroDescription">A unique number identifying a service notification. Notification ID numbers are unique across both hosts and service notifications, so you could potentially use this unique number as a primary key in a notification database. Notification ID numbers should remain unique across restarts of the Naemon process, so long as you have state retention enabled. The notification ID number is incremented by one (1) each time a new service notification is sent out, and regardless of how many contacts are notified.</td>
<td class="MacroDescription">A unique UUIDv4 (e.g. cebd5487-538f-4f5b-87cc-8e18b4e2170c) identifying a service notification. Notification UUID strings are unique across both hosts and service notifications, so you could potentially use this unique string as a primary key in a notification database. Notification UUIDs should remain unique across restarts of the Naemon process, so long as you have state retention enabled. The notification UUID is generated each time a new service notification is sent out, and the same regardless of how many contacts are notified.</td>
</tr>
<tr><td colspan='2'><br></td></tr>
<tr>
Expand Down

0 comments on commit 79e717b

Please sign in to comment.