datadog-checks-base 37.17.1__py2.py3-none-any.whl → 37.18.0__py2.py3-none-any.whl

datadog_checks/base/__about__.py

@@ -1,4 +1,4 @@
 # (C) Datadog, Inc. 2018-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
-__version__ = "37.17.1"
+__version__ = "37.18.0"

datadog_checks/base/utils/db/health.py

@@ -0,0 +1,82 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+# This is the base implementation of the Agent Health reporting system.
+# It provides a structure for health events and codes that can be extended by specific checks.
+
+from __future__ import annotations
+
+import time
+from typing import TYPE_CHECKING
+
+from datadog_checks.base.utils.serialization import json
+
+if TYPE_CHECKING:
+    from datadog_checks.base import AgentCheck
+
+try:
+    import datadog_agent
+except ImportError:
+    from datadog_checks.base.stubs import datadog_agent
+
+
+from enum import Enum
+
+
+class HealthEvent(Enum):
+    """
+    Enum representing the health events.
+    """
+
+    INITIALIZATION = 'initialization'
+
+
+class HealthStatus(Enum):
+    """
+    Enum representing the health statuses for a given event.
+    """
+
+    OK = 'ok'
+    WARNING = 'warning'
+    ERROR = 'error'
+
+
+class Health:
+    def __init__(self, check: AgentCheck):
+        """
+        Initialize the HealthCheck instance.
+
+        :param check: AgentCheck
+            The check instance that will be used to submit health events.
+        """
+        self.check = check
+
+    def submit_health_event(self, name: HealthEvent, status: HealthStatus, tags: list[str] = None, **kwargs):
+        """
+        Submit a health event to the aggregator.
+
+        :param name: HealthEvent
+            The name of the health event.
+        :param status: HealthStatus
+            The health status to submit.
+        :param tags: list of str
+            Tags to associate with the health event.
+        :param kwargs: Additional keyword arguments to include in the event under `data`.
+        """
+        self.check.event_platform_event(
+            json.dumps(
+                {
+                    'timestamp': time.time() * 1000,
+                    'version': 1,
+                    'check_id': self.check.check_id,
+                    'category': self.check.__NAMESPACE__ or self.check.__class__.__name__.lower(),
+                    'name': name,
+                    'status': status,
+                    'tags': tags or [],
+                    'ddagentversion': datadog_agent.get_version(),
+                    'ddagenthostname': datadog_agent.get_hostname(),
+                    'data': {**kwargs},
+                }
+            ),
+            "dbm-health",
+        )

{datadog_checks_base-37.17.1.dist-info → datadog_checks_base-37.18.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datadog-checks-base
-Version: 37.17.1
+Version: 37.18.0
 Summary: The Datadog Check Toolkit
 Project-URL: Source, https://github.com/DataDog/integrations-core
 Author-email: Datadog <packages@datadoghq.com>

{datadog_checks_base-37.17.1.dist-info → datadog_checks_base-37.18.0.dist-info}/RECORD

@@ -3,7 +3,7 @@ datadog_checks/config.py,sha256=PrAXGdlLnoV2VMQff_noSaSJJ0wg4BAiGnw7jCQLSik,196
 datadog_checks/errors.py,sha256=eFwmnrX-batIgbu-iJyseqAPNO_4rk1UuaKK89evLhg,155
 datadog_checks/log.py,sha256=orvOgMKGNEsqSTLalCAQpWP-ouorpG1A7Gn-j2mRD80,301
 datadog_checks/py.typed,sha256=la67KBlbjXN-_-DfGNcdOcjYumVpKG_Tkw-8n5dnGB4,8
-datadog_checks/base/__about__.py,sha256=ndrpWsGPmh3Ena0lvyhHt05KvneXC4n0Mc4AF8AClU0,139
+datadog_checks/base/__about__.py,sha256=d8C_Jbdb_6t4htu9xHzfa7q7A7J7mafa2rOZW7HXkNg,139
 datadog_checks/base/__init__.py,sha256=yWegSLE-TZWIGSvAiJj9PSrUxzlOo_UVJLt2zORZ8Ek,363
 datadog_checks/base/__init__.pyi,sha256=eH8XhrtvnD6uE6FWfEyCmKwOaaLJxNolS08D6IRHZuU,995
 datadog_checks/base/agent.py,sha256=nX9x_BYYizRKGNYfXq5z7S0FZ9xcX_wd2tuxpGe3_8k,350
@@ -138,6 +138,7 @@ datadog_checks/base/utils/concurrency/limiter.py,sha256=is2ZpUEjfsI4nBGtXG2D0Zgv
 datadog_checks/base/utils/db/__init__.py,sha256=EVTc2FtnHWLHXI3M79jyMn9ypZAMa9eqG3EKLAiMF-M,211
 datadog_checks/base/utils/db/__init__.pyi,sha256=ewmGxxyJ52wAaYxNZahi2koEUnddfvHcn3HYxQ3RUr0,240
 datadog_checks/base/utils/db/core.py,sha256=bYanwXIqBzsSxK7b-Ofb0W1WiHbFBtKyYdUBonBLe_Q,11165
+datadog_checks/base/utils/db/health.py,sha256=OWdhGSUhEr8Rxr6anVxD__52wkG8kDaY7M015Y4fCkA,2361
 datadog_checks/base/utils/db/query.py,sha256=-PyxdqpbShkQ78h7sWnghQZVtjdLGVrm71n8OpHuPW4,14432
 datadog_checks/base/utils/db/sql.py,sha256=oiEzQa_vC_w3U65VFrFCoQHWj5GQLLRlSO0CfiSlp4A,2490
 datadog_checks/base/utils/db/sql_commenter.py,sha256=r_efK6TGRQxM_-Qj-ndEJdECk47J4nCFjkVyxu1XmvU,1522
@@ -219,6 +220,6 @@ datadog_checks/utils/tracing.py,sha256=HQbQakKM-Lw75MDkItaYJYipS6YO24Z_ymDVxDsx5
 datadog_checks/utils/prometheus/__init__.py,sha256=8WwXnM9g1sfS5267QYCJX_hd8MZl5kRgBgQ_SzdNdXs,161
 datadog_checks/utils/prometheus/functions.py,sha256=4vWsTGLgujHwdYZo0tlAQkqDPHofqUJM3k9eItJqERQ,197
 datadog_checks/utils/prometheus/metrics_pb2.py,sha256=xg3UdUHe4TjeR4s13LUKZ2U1WVSt6U6zjsVRG6lX6dc,173
-datadog_checks_base-37.17.1.dist-info/METADATA,sha256=WRi4JwneDzJKyzrSHfyAjQF-2o4kg81OCmWns4RYlmI,4244
-datadog_checks_base-37.17.1.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
-datadog_checks_base-37.17.1.dist-info/RECORD,,
+datadog_checks_base-37.18.0.dist-info/METADATA,sha256=14te5AqGZkd64H3TUo-Ro0hJdsgaPGFJs4iuKM-TQFA,4244
+datadog_checks_base-37.18.0.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
+datadog_checks_base-37.18.0.dist-info/RECORD,,