def test_get_section_content(hostname, host_entries, cluster_node_keys,
expected_result):
parsed_sections_broker = ParsedSectionsBroker()
for nodename, node_section_content in host_entries:
parsed_sections_broker.setdefault(
HostKey(nodename, "127.0.0.1", SourceType.HOST),
AgentHostSections(
sections={
SectionName("section_plugin_name"): node_section_content
}),
)
mhs = MultiHostSections(parsed_sections_broker)
section_content = mhs.get_section_content(
HostKey(hostname, "127.0.0.1", SourceType.HOST),
check_api_utils.HOST_ONLY,
"section_plugin_name",
False,
cluster_node_keys=cluster_node_keys,
check_legacy_info=
{}, # only for parse_function lookup, not needed in this test
)
assert expected_result == section_content
section_content = mhs.get_section_content(
HostKey(hostname, "127.0.0.1", SourceType.HOST),
check_api_utils.HOST_PRECEDENCE,
"section_plugin_name",
False,
cluster_node_keys=cluster_node_keys,
check_legacy_info=
{}, # only for parse_function lookup, not needed in this test
)
assert expected_result == section_content
section_content = mhs.get_section_content(
HostKey(hostname, "127.0.0.1", SourceType.MANAGEMENT),
check_api_utils.MGMT_ONLY,
"section_plugin_name",
False,
cluster_node_keys=None if cluster_node_keys is None else [
HostKey(hn, ip, SourceType.MANAGEMENT)
for (hn, ip, _st) in cluster_node_keys
],
check_legacy_info=
{}, # only for parse_function lookup, not needed in this test
)
assert section_content is None
def execute_check(
parsed_sections_broker: ParsedSectionsBroker,
host_config: config.HostConfig,
ipaddress: Optional[HostAddress],
service: Service,
*,
submit_to_core: bool,
show_perfdata: bool,
) -> bool:
plugin = agent_based_register.get_check_plugin(service.check_plugin_name)
# check if we must use legacy mode. remove this block entirely one day
if (plugin is not None and host_config.is_cluster
and plugin.cluster_check_function.__name__
== "cluster_legacy_mode_from_hell"):
with _service_context(service):
return _execute_check_legacy_mode(
MultiHostSections(parsed_sections_broker),
host_config.hostname,
ipaddress,
service,
submit_to_core=submit_to_core,
show_perfdata=show_perfdata,
)
submit, data_received, result = get_aggregated_result(
parsed_sections_broker,
host_config,
ipaddress,
service,
plugin,
lambda: determine_check_params(service.parameters),
)
if submit:
_submit_check_result(
host_config.hostname,
service.description,
result,
parsed_sections_broker.get_cache_info(plugin.sections)
if plugin else None,
submit_to_core=submit_to_core,
show_perfdata=show_perfdata,
)
elif data_received:
console.verbose("%-20s PEND - %s\n", ensure_str(service.description),
result[1])
return data_received
def execute_check(
parsed_sections_broker: ParsedSectionsBroker,
host_config: config.HostConfig,
ipaddress: Optional[HostAddress],
service: Service,
*,
dry_run: bool,
show_perfdata: bool,
) -> bool:
plugin = agent_based_register.get_check_plugin(service.check_plugin_name)
# check if we must use legacy mode. remove this block entirely one day
if (plugin is not None and host_config.is_cluster and
plugin.cluster_check_function.__name__ == "cluster_legacy_mode_from_hell"):
with _service_context(service):
submittable = _legacy_mode.get_aggregated_result(
MultiHostSections(parsed_sections_broker),
host_config.hostname,
ipaddress,
service,
used_params=( #
time_resolved_check_parameters(service.parameters) #
if isinstance(service.parameters, cmk.base.config.TimespecificParamList) else
service.parameters),
)
else: # This is the new, shiny, 'normal' case.
submittable = get_aggregated_result(
parsed_sections_broker,
host_config,
ipaddress,
service,
plugin,
lambda: _final_read_only_check_parameters(service.parameters),
)
if submittable.submit:
_submit_to_core.check_result(
host_name=host_config.hostname,
service_name=service.description,
result=submittable.result,
cache_info=submittable.cache_info,
dry_run=dry_run,
show_perfdata=show_perfdata,
)
else:
console.verbose(f"{service.description:20} PEND - {submittable.result[1]}\n")
return submittable.data_received
def _execute_check_legacy_mode(
multi_host_sections: MultiHostSections,
hostname: HostName,
ipaddress: Optional[HostAddress],
service: Service,
*,
submit_to_core: bool,
show_perfdata: bool,
) -> bool:
legacy_check_plugin_name = config.legacy_check_plugin_names.get(
service.check_plugin_name)
if legacy_check_plugin_name is None:
_submit_check_result(
hostname,
service.description,
CHECK_NOT_IMPLEMENTED,
None,
submit_to_core=submit_to_core,
show_perfdata=show_perfdata,
)
return True
check_function = config.check_info[legacy_check_plugin_name].get(
"check_function")
if check_function is None:
_submit_check_result(
hostname,
service.description,
CHECK_NOT_IMPLEMENTED,
None,
submit_to_core=submit_to_core,
show_perfdata=show_perfdata,
)
return True
section_name = legacy_check_plugin_name.split('.')[0]
section_content = None
mgmt_board_info = config.get_management_board_precedence(
section_name, config.check_info)
source_type = SourceType.MANAGEMENT if mgmt_board_info == LEGACY_MGMT_ONLY else SourceType.HOST
try:
section_content = multi_host_sections.get_section_content(
HostKey(hostname, ipaddress, source_type),
mgmt_board_info,
section_name,
for_discovery=False,
cluster_node_keys=config.get_config_cache().
get_clustered_service_node_keys(
hostname,
source_type,
service.description,
ip_lookup.lookup_ip_address,
),
check_legacy_info=config.check_info,
)
if section_content is None: # No data for this check type
return False
# Call the actual check function
item_state.reset_wrapped_counters()
used_params = legacy_determine_check_params(service.parameters)
raw_result = check_function(service.item, used_params, section_content)
result = sanitize_check_result(raw_result)
item_state.raise_counter_wrap()
except item_state.MKCounterWrapped as e:
# handle check implementations that do not yet support the
# handling of wrapped counters via exception on their own.
# Do not submit any check result in that case:
console.verbose("%-20s PEND - Cannot compute check result: %s\n",
ensure_str(service.description), e)
# Don't submit to core - we're done.
return True
except MKTimeout:
raise
except Exception:
if cmk.utils.debug.enabled():
raise
result = 3, cmk.base.crash_reporting.create_check_crash_dump(
hostname,
service.check_plugin_name,
{
"item": service.item,
"params": used_params,
"section_content": section_content
},
is_manual_check(hostname, service.id()),
service.description,
), []
_submit_check_result(
hostname,
service.description,
result,
multi_host_sections.legacy_determine_cache_info(
SectionName(section_name)),
submit_to_core=submit_to_core,
show_perfdata=show_perfdata,
)
return True
def get_aggregated_result(
multi_host_sections: MultiHostSections,
hostname: HostName,
ipaddress: Optional[HostAddress],
service: Service,
*,
used_params: LegacyCheckParameters,
) -> AggregatedResult:
legacy_check_plugin_name = config.legacy_check_plugin_names.get(service.check_plugin_name)
if legacy_check_plugin_name is None:
return AggregatedResult(
submit=True,
data_received=True,
result=CHECK_NOT_IMPLEMENTED,
cache_info=None,
)
check_function = config.check_info[legacy_check_plugin_name].get("check_function")
if check_function is None:
return AggregatedResult(
submit=True,
data_received=True,
result=CHECK_NOT_IMPLEMENTED,
cache_info=None,
)
section_name = legacy_check_plugin_name.split('.')[0]
section_content = None
mgmt_board_info = config.get_management_board_precedence(section_name, config.check_info)
source_type = SourceType.MANAGEMENT if mgmt_board_info == LEGACY_MGMT_ONLY else SourceType.HOST
try:
section_content = multi_host_sections.get_section_content(
HostKey(hostname, ipaddress, source_type),
mgmt_board_info,
section_name,
for_discovery=False,
cluster_node_keys=config.get_config_cache().get_clustered_service_node_keys(
hostname,
source_type,
service.description,
ip_lookup.lookup_ip_address,
),
check_legacy_info=config.check_info,
)
if section_content is None: # No data for this check type
return AggregatedResult(
submit=False,
data_received=False,
result=RECEIVED_NO_DATA,
cache_info=None,
)
# Call the actual check function
item_state.reset_wrapped_counters()
raw_result = check_function(service.item, used_params, section_content)
result = _sanitize_check_result(raw_result)
item_state.raise_counter_wrap()
except item_state.MKCounterWrapped as exc:
# handle check implementations that do not yet support the
# handling of wrapped counters via exception on their own.
# Do not submit any check result in that case:
return AggregatedResult(
submit=False,
data_received=True,
result=(0, f"Cannot compute check result: {exc}\n", []),
cache_info=None,
)
except MKTimeout:
raise
except Exception:
if cmk.utils.debug.enabled():
raise
result = 3, cmk.base.crash_reporting.create_check_crash_dump(
host_name=hostname,
service_name=service.description,
plugin_name=service.check_plugin_name,
plugin_kwargs={
"item": service.item,
"params": used_params,
"section_content": section_content
},
is_manual=service.id() in check_table.get_check_table(hostname, skip_autochecks=True),
), []
return AggregatedResult(
submit=True,
data_received=True,
result=result,
cache_info=multi_host_sections.legacy_determine_cache_info(SectionName(section_name)),
)