Cisco ESA: Implement memory service

CMK-20862

Change-Id: I9d22e9ad37497dfc5c5c223c4e1aa7133fb7dd03

Author: szymonlip

cmk/base/legacy_checks/tplink_mem.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+# Copyright (C) 2025 Checkmk GmbH - License: GNU General Public License v2
+# This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
+# conditions defined in the file COPYING, which is part of this source code package.
+
+from cmk.agent_based.v2 import (
+    SimpleSNMPSection,
+    SNMPTree,
+    StringTable,
+)
+from cmk.plugins.cisco_sma.agent_based.detect import DETECT_CISCO_SMA_SNMP
+
+
+def _parse_memory_percentage_used(string_table: StringTable) -> float | None:
+    if not string_table or not string_table[0]:
+        return None
+
+    return float(string_table[0][0])
+
+
+snmp_section_memory_utilization = SimpleSNMPSection(
+    parsed_section_name="memory_utilization",
+    name="cisco_sma_memory_utilization",
+    detect=DETECT_CISCO_SMA_SNMP,
+    fetch=SNMPTree(
+        base=".1.3.6.1.4.1.15497.1.1.1",
+        oids=["1.0"],
+    ),
+    parse_function=_parse_memory_percentage_used,
+    supersedes=["hr_mem"],
+)

cmk/gui/plugins/wato/check_parameters/memory_percentage_used.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python3
+# Copyright (C) 2025 Checkmk GmbH - License: GNU General Public License v2
+# This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
+# conditions defined in the file COPYING, which is part of this source code package.
+from typing import TypedDict
+
+from cmk.agent_based.v2 import (
+    check_levels,
+    CheckPlugin,
+    CheckResult,
+    DiscoveryResult,
+    render,
+    Service,
+)
+from cmk.rulesets.v1.form_specs import SimpleLevelsConfigModel
+
+
+class Params(TypedDict):
+    levels: SimpleLevelsConfigModel[float]
+
+
+def _check_memory_utilization(params: Params, section: float) -> CheckResult:
+    yield from check_levels(
+        section,
+        label="Utilization",
+        metric_name="mem_used_percent",
+        render_func=render.percent,
+        levels_upper=params["levels"],
+    )
+
+
+def _discover_memory_utilization(section: float) -> DiscoveryResult:
+    yield Service()
+
+
+check_plugin_memory_utilization = CheckPlugin(
+    name="memory_utilization",
+    service_name="Memory",
+    discovery_function=_discover_memory_utilization,
+    check_function=_check_memory_utilization,
+    check_ruleset_name="memory_percentage_used",
+    check_default_parameters=Params(levels=("fixed", (70.0, 80.0))),
+)

cmk/plugins/cisco_sma/agent_based/memory_utilization.py

@@ -0,0 +1,11 @@
+title: Memory utilization
+agents: snmp
+catalog: os/storage
+license: GPLv2
+distribution: check_mk
+description:
+ This check monitors the memory utilization.
+
+ Warning and critical levels are configurable.
+discovery:
+ One service is created.

cmk/plugins/collection/agent_based/memory_utilization.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+# Copyright (C) 2025 Checkmk GmbH - License: GNU General Public License v2
+# This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
+# conditions defined in the file COPYING, which is part of this source code package.
+
+from cmk.rulesets.v1 import Title
+from cmk.rulesets.v1.form_specs import (
+    DefaultValue,
+    DictElement,
+    Dictionary,
+    InputHint,
+    LevelDirection,
+    LevelsType,
+    migrate_to_float_simple_levels,
+    Percentage,
+    SimpleLevels,
+    SimpleLevelsConfigModel,
+)
+from cmk.rulesets.v1.rule_specs import CheckParameters, HostCondition, Topic
+
+
+def _parameter_form_memory_utilization() -> Dictionary:
+    return Dictionary(
+        elements={
+            "levels": DictElement[SimpleLevelsConfigModel[float]](
+                required=True,
+                parameter_form=SimpleLevels(
+                    title=Title("Upper thresholds"),
+                    level_direction=LevelDirection.UPPER,
+                    form_spec_template=Percentage(),
+                    prefill_levels_type=DefaultValue(LevelsType.FIXED),
+                    prefill_fixed_levels=InputHint((70.0, 80.0)),
+                    migrate=migrate_to_float_simple_levels,
+                ),
+            ),
+        }
+    )
+
+
+rule_spec_memory_utilization_percentage = CheckParameters(
+    name="memory_percentage_used",
+    topic=Topic.OPERATING_SYSTEM,
+    parameter_form=_parameter_form_memory_utilization,
+    title=Title("Memory utilization"),
+    condition=HostCondition(),
+)

cmk/plugins/collection/checkman/memory_utilization

@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+# Copyright (C) 2019 Checkmk GmbH - License: GNU General Public License v2
+# This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
+# conditions defined in the file COPYING, which is part of this source code package.
+
+
+from cmk.agent_based.v2 import (
+    SimpleSNMPSection,
+    SNMPTree,
+    StringTable,
+)
+from cmk.plugins.lib.tplink import DETECT_TPLINK
+
+
+def _parse_memory_percentage_used(string_table: StringTable) -> float | None:
+    if not string_table or not string_table[0]:
+        return None
+
+    utilization_of_units = [float(line[0]) for line in string_table]
+    return sum(utilization_of_units) / len(utilization_of_units)
+
+
+snmp_section_memory_utilization = SimpleSNMPSection(
+    parsed_section_name="memory_utilization",
+    name="tplink_memory_utilization",
+    detect=DETECT_TPLINK,
+    fetch=SNMPTree(
+        base=".1.3.6.1.4.1.11863.6.4.1.2.1.1",
+        oids=["2"],
+    ),
+    parse_function=_parse_memory_percentage_used,
+)

cmk/plugins/collection/checkman/tplink_mem

@@ -8,7 +8,9 @@
 from cmk.checkengine.checking import CheckPluginName
 
 # Please keep this functionality even if we currently don't have any replaced check plugins!
-_REPLACED_CHECK_PLUGINS: dict[CheckPluginName, CheckPluginName] = {}
+_REPLACED_CHECK_PLUGINS: dict[CheckPluginName, CheckPluginName] = {
+    CheckPluginName("tplink_mem"): CheckPluginName("memory_utilization")
+}
 
 ALL_REPLACED_CHECK_PLUGINS: Mapping[CheckPluginName, CheckPluginName] = {
     **_REPLACED_CHECK_PLUGINS,

cmk/plugins/collection/rulesets/memory_percentage_used.py

@@ -1103,7 +1103,6 @@ def test_no_new_or_vanished_legacy_checks(fix_plugin_legacy: FixPluginLegacy) ->
         "tinkerforge_humidity",
         "tinkerforge_motion",
         "tplink_cpu",
-        "tplink_mem",
         "tplink_poe_summary",
         "tsm_drives",
         "tsm_paths",

cmk/plugins/tplink/agent_based/tplink_mem.py

@@ -149,7 +149,7 @@ def test_openapi_create_rule_regression(clients: ClientRegistry) -> None:
 
 
 def test_openapi_value_raw_is_unaltered(clients: ClientRegistry) -> None:
-    value_raw = "{'levels': (10.0, 5.0)}"
+    value_raw = "{'levels': ('fixed', (10.0, 5.0))}"
     resp = clients.Rule.create(
         ruleset=RuleGroup.CheckgroupParameters("memory_percentage_used"),
         value_raw=value_raw,

cmk/update_config/plugins/lib/replaced_check_plugins.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python3
+# Copyright (C) 2024 Checkmk GmbH - License: GNU General Public License v2
+# This file is part of Checkmk (https://checkmk.com). It is subject to the terms and
+# conditions defined in the file COPYING, which is part of this source code package.
+
+
+import pytest
+
+from cmk.agent_based.v2 import StringTable
+from cmk.plugins.cisco_sma.agent_based.memory_utilization import _parse_memory_percentage_used
+
+
+@pytest.mark.parametrize(
+    "string_table, expected",
+    (
+        ([[]], None),
+        ([["2"]], 2.0),
+    ),
+)
+def test_parse_memory_percentage_used(string_table: StringTable, expected: None | float) -> None:
+    assert _parse_memory_percentage_used(string_table) == expected