added perf-o-meter / graph

CLiX-1 · CLiX-1 · commit b0cab3c7ab27 · 2025-05-11T14:13:38.000+02:00
diff --git a/entra/agent_based/ms_entra_app_creds.py b/entra/agent_based/ms_entra_app_creds.py
@@ -79,6 +79,7 @@
     CheckPlugin,
     CheckResult,
     DiscoveryResult,
+    Metric,
     render,
     Result,
     Service,
@@ -203,14 +204,15 @@ def check_ms_entra_app_creds(item: str, params: Mapping[str, Any], section: Sect
             else ""
         )
 
-        params_cred_expiration_levels = params.get("cred_expiration")
+        params_cred_expiration_levels = params["cred_expiration"]
 
         # For state calculation, check_levels is used.
         # It will take the expiration time of the credential with the earliest expiration time.
         if cred_expiration_timespan > 0:
             yield from check_levels(
                 cred_expiration_timespan,
                 levels_lower=(params_cred_expiration_levels),
+                metric_name="ms_entra_app_creds_remaining_validity",
                 label="Remaining",
                 render_func=render.timespan,
             )
@@ -222,6 +224,13 @@ def check_ms_entra_app_creds(item: str, params: Mapping[str, Any], section: Sect
                 render_func=lambda x: f"{render.timespan(abs(x))} ago",
             )
 
+            # To prevent a negative value for the metric.
+            yield Metric(
+                name="ms_entra_app_creds_remaining_validity",
+                value=0.0,
+                levels=params_cred_expiration_levels[1],
+            )
+
     else:
         result_summary = "All application credentials are excluded"
 
diff --git a/entra/agent_based/ms_entra_ca_vpn_cert.py b/entra/agent_based/ms_entra_ca_vpn_cert.py
@@ -55,6 +55,7 @@
     CheckPlugin,
     CheckResult,
     DiscoveryResult,
+    Metric,
     render,
     Result,
     Service,
@@ -164,14 +165,15 @@ def check_ms_entra_ca_vpn_cert(params: Mapping[str, Any], section: Section) -> C
     # Calculate the timespan until the earliest certificate expires or has expired.
     cert_expiration_timespan = cert_earliest_expiration_timestamp - datetime.now().timestamp()
 
-    params_cert_expiration_levels = params.get("cert_expiration")
+    params_cert_expiration_levels = params["cert_expiration"]
 
     # For state calculation, check_levels is used.
     # It will take the expiration time of the certificate with the earliest expiration time.
     if cert_expiration_timespan > 0:
         yield from check_levels(
             cert_expiration_timespan,
             levels_lower=(params_cert_expiration_levels),
+            metric_name="ms_entra_ca_vpn_cert_remaining_validity",
             label="Remaining",
             render_func=render.timespan,
         )
@@ -183,6 +185,13 @@ def check_ms_entra_ca_vpn_cert(params: Mapping[str, Any], section: Section) -> C
             render_func=lambda x: f"{render.timespan(abs(x))} ago",
         )
 
+        # To prevent a negative value for the metric.
+        yield Metric(
+            name="ms_entra_ca_vpn_cert_remaining_validity",
+            value=0.0,
+            levels=params_cert_expiration_levels[1],
+        )
+
     # To display custom summary and details we need to yield Result.
     # The real state is calculated using the worst state of Result and check_levels.
     yield Result(
diff --git a/entra/agent_based/ms_entra_saml_certs.py b/entra/agent_based/ms_entra_saml_certs.py
@@ -58,6 +58,7 @@
     CheckPlugin,
     CheckResult,
     DiscoveryResult,
+    Metric,
     render,
     Result,
     Service,
@@ -125,7 +126,7 @@ def check_ms_entra_saml_certs(
     if not app:
         return
 
-    params_levels_cert_expiration = params.get("cert_expiration")
+    params_levels_cert_expiration = params["cert_expiration"]
 
     if app.cert_expiration:
         # Cert expiration time and timespan calculation
@@ -152,6 +153,7 @@ def check_ms_entra_saml_certs(
         yield from check_levels(
             cert_expiration_timespan,
             levels_lower=(params_levels_cert_expiration),
+            metric_name="ms_entra_saml_certs_remaining_validity",
             label="Remaining",
             render_func=render.timespan,
         )
@@ -163,6 +165,13 @@ def check_ms_entra_saml_certs(
             render_func=lambda x: "%s ago" % render.timespan(abs(x)),
         )
 
+        # To prevent a negative value for the metric.
+        yield Metric(
+            name="ms_entra_saml_certs_remaining_validity",
+            value=0.0,
+            levels=params_levels_cert_expiration[1],
+        )
+
     # To display custom summary and details we need to yield Result.
     # The real state is calculated using the worst state of Result and check_levels.
     yield Result(
diff --git a/entra/agent_based/ms_entra_sync.py b/entra/agent_based/ms_entra_sync.py
@@ -86,6 +86,7 @@ def check_ms_entra_sync(params: Mapping[str, Any], section: Section) -> CheckRes
     yield from check_levels(
         sync_last_timespan,
         levels_upper=(params["sync_period"]),
+        metric_name="ms_entra_sync_elapsed_time",
         label="Last sync",
         render_func=lambda x: f"{render.timespan(abs(x))} ago",
     )
diff --git a/entra/graphing/ms_entra.py b/entra/graphing/ms_entra.py
@@ -0,0 +1,96 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8; py-indent-offset: 4; max-line-length: 100 -*-
+
+# Copyright (C) 2025  Christopher Pommer <cp.software@outlook.de>
+
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+
+####################################################################################################
+# The graph parameters are part of the Microsoft Entra special agent (ms_entra)
+
+from cmk.graphing.v1 import Title
+from cmk.graphing.v1.metrics import (
+    Color,
+    Unit,
+    Metric,
+    TimeNotation,
+)
+from cmk.graphing.v1.perfometers import Closed, FocusRange, Open, Perfometer
+
+UNIT_TIME = Unit(TimeNotation())
+
+# Microsoft Entra App Credentials
+
+metric_ms_entra_app_creds_remaining_validity = Metric(
+    name="ms_entra_app_creds_remaining_validity",
+    title=Title("Remaining credential validity time"),
+    unit=UNIT_TIME,
+    color=Color.YELLOW,
+)
+
+perfometer_ms_entra_app_creds_remaining_validity = Perfometer(
+    name="ms_entra_app_creds_remaining_validity",
+    focus_range=FocusRange(Closed(0), Open(15552000)),
+    segments=["ms_entra_app_creds_remaining_validity"],
+)
+
+
+# Microsoft Entra CA VPN Certificate
+
+metric_ms_entra_ca_vpn_cert_remaining_validity = Metric(
+    name="ms_entra_ca_vpn_cert_remaining_validity",
+    title=Title("Remaining certificate validity time"),
+    unit=UNIT_TIME,
+    color=Color.YELLOW,
+)
+
+perfometer_ms_entra_ca_vpn_cert_remaining_validity = Perfometer(
+    name="ms_entra_ca_vpn_cert_remaining_validity",
+    focus_range=FocusRange(Closed(0), Open(15552000)),
+    segments=["ms_entra_ca_vpn_cert_remaining_validity"],
+)
+
+
+# Microsoft Entra SAML Certificate
+
+metric_ms_entra_saml_certs_remaining_validity = Metric(
+    name="ms_entra_saml_certs_remaining_validity",
+    title=Title("Remaining certificate validity time"),
+    unit=UNIT_TIME,
+    color=Color.YELLOW,
+)
+
+perfometer_ms_entra_saml_certs_remaining_validity = Perfometer(
+    name="ms_entra_saml_certs_remaining_validity",
+    focus_range=FocusRange(Closed(0), Open(15552000)),
+    segments=["ms_entra_saml_certs_remaining_validity"],
+)
+
+
+# Microsoft Entra Sync
+
+metric_ms_entra_sync_elapsed_time = Metric(
+    name="ms_entra_sync_elapsed_time",
+    title=Title("Elapsed time since last sync"),
+    unit=UNIT_TIME,
+    color=Color.DARK_YELLOW,
+)
+
+perfometer_ms_entra_sync_elapsed_time = Perfometer(
+    name="ms_entra_sync_elapsed_time",
+    focus_range=FocusRange(Closed(0), Open(3600)),
+    segments=["ms_entra_sync_elapsed_time"],
+)

Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,7 @@ def check_ms_entra_sync(params: Mapping[str, Any], section: Section) -> CheckRes`
`86`	`86`	`yield from check_levels(`
`87`	`87`	`sync_last_timespan,`
`88`	`88`	`levels_upper=(params["sync_period"]),`
	`89`	`+ metric_name="ms_entra_sync_elapsed_time",`
`89`	`90`	`label="Last sync",`
`90`	`91`	`render_func=lambda x: f"{render.timespan(abs(x))} ago",`
`91`	`92`	`)`