Modernize graylog_failures

Migrate the check to the agent_based.v2 API with check_levels and TypedDict
parameters, and migrate the check parameters from the legacy GUI valuespec to a
cmk.rulesets.v1 form spec living in the plugin package.

CMK-34762

Change-Id: Ic0ffcf9f9e3b43ca29dd09c16a06d6841400ed60

Author: NotANormalNerd

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

@@ -6,16 +6,18 @@
 # mypy: disable-error-code="exhaustive-match"
 
 import json
-from collections.abc import Collection, Iterable, Mapping, Sequence
+from collections.abc import Collection, Iterable, Sequence
+from typing import TypedDict
 
 from pydantic import BaseModel, Field
 
-from cmk.agent_based.v1 import check_levels as check_levels_v1
 from cmk.agent_based.v2 import (
     AgentSection,
+    check_levels,
     CheckPlugin,
     CheckResult,
     DiscoveryResult,
+    LevelsT,
     render,
     Result,
     Service,
@@ -25,6 +27,11 @@
 from cmk.plugins.graylog.lib import deserialize_and_merge_json
 
 
+class FailuresParams(TypedDict):
+    failures: LevelsT[int]
+    failures_last: LevelsT[int]
+
+
 class FailureMessage(BaseModel):
     type: str | None
     reason: str | None
@@ -121,15 +128,15 @@ def _failure_results(failures: Collection[Failure]) -> CheckResult:
 
 
 def check(
-    params: Mapping[str, tuple[int, int] | None],
+    params: FailuresParams,
     section: Section,
 ) -> CheckResult:
     if section.failures is None or section.total is None:
         return
 
-    yield from check_levels_v1(
+    yield from check_levels(
         value=section.total,
-        levels_upper=params.get("failures"),
+        levels_upper=params["failures"],
         metric_name="failures",
         render_func=str,
         label="Total number of failures",
@@ -138,9 +145,9 @@ def check(
     if section.count is None:
         return
 
-    yield from check_levels_v1(
+    yield from check_levels(
         value=section.count,
-        levels_upper=params.get("failures_last"),
+        levels_upper=params["failures_last"],
         metric_name=None,
         render_func=str,
         label=f"Failures in last {render.timespan(section.ds_param_since)}",
@@ -157,6 +164,9 @@ def check(
     service_name="Graylog Index Failures",
     discovery_function=discover,
     check_function=check,
-    check_default_parameters={},
+    check_default_parameters={
+        "failures": ("no_levels", None),
+        "failures_last": ("no_levels", None),
+    },
     check_ruleset_name="graylog_failures",
 )

packages/cmk-plugins/cmk/plugins/graylog/agent_based/graylog_failures.py

@@ -0,0 +1,54 @@
+#!/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.rulesets.v1 import Help, Title
+from cmk.rulesets.v1.form_specs import (
+    DictElement,
+    Dictionary,
+    InputHint,
+    Integer,
+    LevelDirection,
+    migrate_to_integer_simple_levels,
+    SimpleLevels,
+)
+from cmk.rulesets.v1.rule_specs import CheckParameters, HostCondition, Topic
+
+
+def _parameter_valuespec_graylog_failures() -> Dictionary:
+    return Dictionary(
+        elements={
+            "failures": DictElement(
+                parameter_form=SimpleLevels[int](
+                    title=Title("Total index failure count upper levels"),
+                    level_direction=LevelDirection.UPPER,
+                    form_spec_template=Integer(),
+                    prefill_fixed_levels=InputHint((0, 0)),
+                    migrate=migrate_to_integer_simple_levels,
+                ),
+            ),
+            "failures_last": DictElement(
+                parameter_form=SimpleLevels[int](
+                    title=Title("Index failure in the defined time range upper levels"),
+                    help_text=Help(
+                        "Here, you can set levels on failures in the time range "
+                        "specified in the data source (default: 30 min)."
+                    ),
+                    level_direction=LevelDirection.UPPER,
+                    form_spec_template=Integer(),
+                    prefill_fixed_levels=InputHint((0, 0)),
+                    migrate=migrate_to_integer_simple_levels,
+                ),
+            ),
+        },
+    )
+
+
+rule_spec_graylog_failures = CheckParameters(
+    name="graylog_failures",
+    title=Title("Graylog index failures"),
+    topic=Topic.APPLICATIONS,
+    parameter_form=_parameter_valuespec_graylog_failures,
+    condition=HostCondition(),
+)

packages/cmk-plugins/cmk/plugins/graylog/rulesets/graylog_failures.py

@@ -3,8 +3,6 @@
 # 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 collections.abc import Mapping
-
 import pytest
 
 from cmk.agent_based.v2 import (
@@ -92,7 +90,7 @@ def test_discover(
     [
         pytest.param(
             _STRING_TABLE_ZERO_FAILURES,
-            {},
+            {"failures": ("no_levels", None), "failures_last": ("no_levels", None)},
             [
                 Result(state=State.OK, summary="Total number of failures: 198508"),
                 Metric("failures", 198508.0),
@@ -102,7 +100,7 @@ def test_discover(
         ),
         pytest.param(
             _STRING_TABLE_MSG_DICT,
-            {},
+            {"failures": ("no_levels", None), "failures_last": ("no_levels", None)},
             [
                 Result(state=State.OK, summary="Total number of failures: 198508"),
                 Metric("failures", 198508.0),
@@ -121,8 +119,8 @@ def test_discover(
         pytest.param(
             _STRING_TABLE_MSG_DICT,
             {
-                "failures": (5000, 2000),
-                "failures_last": (1, 10),
+                "failures": ("fixed", (5000, 2000)),
+                "failures_last": ("fixed", (1, 10)),
             },
             [
                 Result(
@@ -147,7 +145,7 @@ def test_discover(
         ),
         pytest.param(
             _STRING_TABLE_MSG_STR,
-            {},
+            {"failures": ("no_levels", None), "failures_last": ("no_levels", None)},
             [
                 Result(state=State.OK, summary="Total number of failures: 131346"),
                 Metric("failures", 131346.0),
@@ -167,7 +165,7 @@ def test_discover(
 )
 def test_check(
     string_table: StringTable,
-    params: Mapping[str, tuple[int, int] | None],
+    params: graylog_failures.FailuresParams,
     expected_result: CheckResult,
 ) -> None:
     section = graylog_failures.parse(string_table)