def check_plugin(
*,
name: str,
sections: Optional[List[str]] = None,
service_name: str,
discovery_function: DiscoveryFunction,
discovery_default_parameters: Optional[Dict[str, Any]] = None,
discovery_ruleset_name: Optional[str] = None,
discovery_ruleset_type: DiscoveryRuleSetType = "merged",
check_function: CheckFunction,
check_default_parameters: Optional[Dict[str, Any]] = None,
check_ruleset_name: Optional[str] = None,
cluster_check_function: Optional[Callable] = None,
) -> None:
"""Register a check plugin to checkmk.
:param name: The name of the check plugin. It must be unique. And contain only the characters
A-Z, a-z, 0-9 and the underscore.
:param sections: An optional list of section names that this plugin subscribes to. The
corresponding sections are passed to the discovery and check function. The
functions arguments must be called 'section_<name1>, section_<name2>' ect.
Default: [<name>]
:param service_name: The template for the service. The check function must accept 'item' as
first argument if and only if "%s" is present in the value of
"service_name".
:param discovery_function: The discovery_function. Arguments must be 'params' (if discovery
parameters are defined) and 'section_<name1>, section_<name2>' ect.
corresponding to the `sections`.
:param discovery_parameters: Default parameters for the discovery function. Must match the
ValueSpec of the corresponding WATO ruleset.
:param discovery_ruleset_name: The name of the discovery ruleset.
:param check_function: The check_function. Arguments must be 'item' (if the service has an item)
'params' (if check parameters are defined) and 'section_<name1>,
section_<name2>' ect. corresponding to the `sections`.
:param check_parameters: Default parameters for the check function. Must match the
ValueSpec of the corresponding WATO ruleset.
:param check_ruleset_name: The name of the check ruleset.
"""
plugin = create_check_plugin(
name=name,
sections=sections,
service_name=service_name,
discovery_function=discovery_function,
discovery_default_parameters=discovery_default_parameters,
discovery_ruleset_name=discovery_ruleset_name,
discovery_ruleset_type=discovery_ruleset_type,
check_function=check_function,
check_default_parameters=check_default_parameters,
check_ruleset_name=check_ruleset_name,
cluster_check_function=cluster_check_function,
module=get_validated_plugin_module_name(),
)
if is_registered_check_plugin(plugin.name):
raise ValueError("duplicate check plugin definition: %s" % plugin.name)
add_check_plugin(plugin)
if plugin.discovery_ruleset_name is not None:
add_discovery_ruleset(plugin.discovery_ruleset_name)
def check_plugin(
*,
name: str,
sections: Optional[List[str]] = None,
service_name: str,
discovery_function: DiscoveryFunction,
discovery_default_parameters: Optional[Dict[str, Any]] = None,
discovery_ruleset_name: Optional[str] = None,
discovery_ruleset_type: DiscoveryRuleSetType = "merged",
check_function: CheckFunction,
check_default_parameters: Optional[Dict[str, Any]] = None,
check_ruleset_name: Optional[str] = None,
cluster_check_function: Optional[Callable] = None,
) -> None:
"""Register a check plugin to checkmk.
Args:
name: The unique name of the check plugin. It must only contain the
characters 'A-Z', 'a-z', '0-9' and the underscore.
sections: An optional list of section names that this plugin subscribes to.
They correspond to the 'parsed_section_name' specified in
:meth:`agent_section` and :meth:`snmp_section`.
The corresponding sections are passed to the discovery and check
function. The functions arguments must be called 'section_<name1>,
section_<name2>' ect. Defaults to a list containing as only element
a name equal to the name of the check plugin.
service_name: The template for the service name. The check function must accept
'item' as first argument if and only if "%s" is present in the value
of "service_name".
discovery_function: The discovery_function. Arguments must be 'params' (if discovery
parameters are defined) and 'section_<name1>, section_<name2>' ect.
corresponding to the `sections`.
It is expected to be a generator of :class:`Service` instances.
discovery_default_parameters: Default parameters for the discovery function. Must match the
ValueSpec of the corresponding WATO ruleset, if it exists.
discovery_ruleset_name: The name of the discovery ruleset.
check_function: The check_function. Arguments must be 'item' (if the service has an
item), 'params' (if check default parameters are defined) and
'section_<name1>, section_<name2>' ect. corresponding to the
`sections`.
check_default_parameters: Default parameters for the check function.
Must match the ValueSpec of the corresponding WATO ruleset, if it
exists.
check_ruleset_name: The name of the check ruleset.
cluster_check_function: The cluster check function. If this function is not specified, the
corresponding services will not be available for clusters.
The arguments are the same as the ones for the check function,
except that the sections are dicts (node name -> node section).
"""
plugin = create_check_plugin(
name=name,
sections=sections,
service_name=service_name,
discovery_function=discovery_function,
discovery_default_parameters=discovery_default_parameters,
discovery_ruleset_name=discovery_ruleset_name,
discovery_ruleset_type=discovery_ruleset_type,
check_function=check_function,
check_default_parameters=check_default_parameters,
check_ruleset_name=check_ruleset_name,
cluster_check_function=cluster_check_function,
module=get_validated_plugin_module_name(),
)
if is_registered_check_plugin(plugin.name):
raise ValueError("duplicate check plugin definition: %s" % plugin.name)
add_check_plugin(plugin)
if plugin.discovery_ruleset_name is not None:
add_discovery_ruleset(plugin.discovery_ruleset_name)
