icinga

Icinga module.

exception spicerack.icinga.IcingaError

Bases: spicerack.exceptions.SpicerackError

Custom exception class for errors of this module.

exception spicerack.icinga.IcingaStatusNotFoundError(hostnames: Sequence[str])

Bases: spicerack.icinga.IcingaError

Custom exception class for a host missing from the Icinga status.

Initializes an IcingaStatusNotFoundError instance.

Parameters

hostnames (sequence) -- The hostnames not found in the Icinga status.

exception spicerack.icinga.IcingaStatusParseError

Bases: spicerack.icinga.IcingaError

Custom exception class for errors while parsing the Icinga status.

class spicerack.icinga.CommandFile(icinga_host: spicerack.remote.RemoteHosts, *, config_file: str = '/etc/icinga/icinga.cfg')

Bases: str

String class to represent an Icinga command file path with cache capabilities.

Get the Icinga host command file where to write the commands and cache it.

Parameters

• icinga_host (spicerack.remote.RemoteHosts) -- the Icinga host instance.

• config_file (str, optional) -- the Icinga configuration file to check for the command file directive.

Returns

the Icinga command file path on the Icinga host.

Return type

str

Raises

spicerack.icinga.IcingaError -- if unable to get the command file path.

class spicerack.icinga.HostStatus(*, name: str, state: str, optimal: bool, downtimed: bool, notifications_enabled: bool, failed_services: Optional[Sequence[Mapping]] = None, services: Optional[Sequence[Mapping]] = None)

Bases: object

Represent the status of all Icinga checks for a single host.

Initialize the instance.

Either services or failed_services may be present, depending on the flags passed to icinga-status.

Parameters

• name (str) -- the hostname.

• state (str) -- the Icinga state for the host, one of UP, DOWN, UNREACHABLE``.

• optimal (bool) -- whether the host is in optimal state (all green).

• downtimed (bool) -- whether the host is currently downtimed.

• notifications_enabled -- (bool): whether the host has notifications enabled.

• failed_services (list, optional) -- a list of dictionaries representing the failed services.

• services (list, optional) -- a list of dictionaries giving detailed service status.

STATE_UP = 'UP'

the Icinga value for a host that is up and running. The other values for the Icinga host state are DOWN and UNREACHABLE.

Type

str

property failed_services: List[str]

Return the list of service names that are failing.

Returns

a list of strings with the check names.

Return type

list

class spicerack.icinga.HostsStatus

Bases: dict

Represent the status of all Icinga checks for a set of hosts.

property failed_hosts: List[str]

Return the list of hostnames that are not up and running. They can either be down or unreachable.

Returns

the list of strings with the hostnames.

Return type

list

property failed_services: Dict[str, List[str]]

Return the list of service names that are failing for each host that has at least one.

Returns

a dict with hostnames as keys and list of failing service name strings as values.

Return type

dict

property non_optimal_hosts: List[str]

Return the list of hostnames that are not in an optimal state.

They can either not being up and running or have at least one failed service.

Returns

a list of strings with the hostnames.

Return type

list

property optimal: bool

Returns True if all the hosts are optimal, False otherwise.

Returns

whether all hosts are optimal.

Return type

bool

class spicerack.icinga.IcingaHosts(icinga_host: spicerack.remote.RemoteHosts, target_hosts: spicerack.typing.TypeHosts, *, verbatim_hosts: bool = False)

Bases: object

Class to manage the Icinga checks of a given set of hosts.

Initialize the instance.

Parameters

• icinga_host (spicerack.remote.RemoteHosts) -- the RemoteHosts instance for the Icinga server.

• target_hosts (spicerack.typing.TypeHosts) -- the target hosts either as a NodeSet instance or a sequence of strings.

• verbatim_hosts (bool, optional) -- if True use the hosts passed verbatim as is, if instead False, the default, consider the given target hosts as FQDNs and extract their hostnames to be used in Icinga.

downtime(reason: spicerack.administrative.Reason, *, duration: datetime.timedelta = datetime.timedelta(seconds=14400)) → None

Downtime hosts on the Icinga server for the given time with a message.

Parameters

• reason (spicerack.administrative.Reason) -- the reason to set for the downtime on the Icinga server.

• duration (datetime.timedelta, optional) -- the length of the downtime period.

downtime_services(service_re: str, reason: spicerack.administrative.Reason, *, duration: datetime.timedelta = datetime.timedelta(seconds=14400)) → None

Downtime services on the Icinga server for the given time with a message.

If there are multiple target_hosts, the set of matching services may vary from host to host (e.g. because a hostname, DB section, or other unique fact is included in the service name) and downtime_services will downtime each service on the correct target_host. If some hosts happen to have no matching services, they will be safely skipped. But if no hosts have matching services, IcingaError is raised (because the regex is probably wrong).

Parameters

• service_re (str) -- the regular expression matching service names to downtime.

• reason (spicerack.administrative.Reason) -- the reason to set for the downtime on the Icinga server.

• duration (datetime.timedelta, optional) -- the length of the downtime period.

Raises

• re.error -- if service_re is an invalid regular expression.

• IcingaError -- if no services on any target host match the regular expression.

downtimed(reason: spicerack.administrative.Reason, *, duration: datetime.timedelta = datetime.timedelta(seconds=14400), remove_on_error: bool = False) → Iterator[None]

Context manager to perform actions while the hosts are downtimed on Icinga.

Parameters

• reason (spicerack.administrative.Reason) -- the reason to set for the downtime on the Icinga server.

• duration (datetime.timedelta, optional) -- the length of the downtime period.

• remove_on_error -- should the downtime be removed even if an exception was raised.

Yields

None -- it just yields control to the caller once Icinga has been downtimed and deletes the downtime once getting back the control.

get_status(service_re: str = '') → spicerack.icinga.HostsStatus

Get the current status of the given hosts from Icinga.

Parameters

service_re (str) -- if non-empty, the regular expression matching service names

Returns

the instance that represents the status for the given hosts.

Return type

spicerack.icinga.HostsStatus

Raises

• IcingaError -- if unable to get the status.

• IcingaStatusParseError -- when failing to parse the status.

• IcingaStatusNotFoundError -- if a host is not found in the Icinga status.

• re.error -- if service_re is an invalid regular expression.

recheck_all_services() → None

Force recheck of all services associated with a set of hosts.

recheck_failed_services() → None

Force recheck of all failed associated with a set of hosts.

remove_downtime() → None

Remove a downtime from a set of hosts.

remove_service_downtimes(service_re: str) → None

Remove downtimes for services from a set of hosts.

If there are multiple target_hosts, this method has the same behavior as downtime_services. If any matching service is not downtimed, it's silently skipped. (If one or more services exist matching the regex, but none of them is downtimed, this method does nothing.)

Parameters

service_re (str) -- the regular expression matching service names to un-downtime.

Raises

• re.error -- if service_re is an invalid regular expression.

• IcingaError -- if no services on any target host match the regular expression.

run_icinga_command(command: str, *args: str) → None

Execute an Icinga command on the Icinga server for all the current hosts.

This lower level API is meant to be used when the higher level API exposed in this class does not cover a given use case. The arguments passed to the underlying Icinga command will be the hostname plus all the arguments passed to this method. Hence it can be used only with Icinga commands that require a hostname. See the link below for more details on the available Icinga commands and their arguments.

Parameters

• command (str) -- the Icinga command to execute.

• *args (str) -- optional positional arguments to pass to the command.

See also

https://icinga.com/docs/icinga1/latest/en/extcommands2.html

services_downtimed(service_re: str, reason: spicerack.administrative.Reason, *, duration: datetime.timedelta = datetime.timedelta(seconds=14400), remove_on_error: bool = False) → Iterator[None]

Context manager to perform actions while services are downtimed on Icinga.

Parameters

• service_re (str) -- the regular expression matching service names to downtime.

• reason (spicerack.administrative.Reason) -- the reason to set for the downtime on the Icinga server.

• duration (datetime.timedelta, optional) -- the length of the downtime period.

• remove_on_error (bool, optional) -- should the downtime be removed even if an exception was raised.

Yields

None -- it just yields control to the caller once Icinga has been downtimed and deletes the downtime once getting back the control.

wait_for_optimal() → None

Waits for an icinga optimal status, else raises an exception.

This function will first instruct icinga to recheck all failed services and then wait until all services are in an optimal status. If an optimal status is not reached in 6 minutes then we raise IcingaError

Raises

IcingaError -- if the status is not optimal.