datadog-checks-base 37.17.0__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.0"
+__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/utils/db/utils.py

@@ -107,21 +107,33 @@ class ConstantRateLimiter:
     Basic rate limiter that sleeps long enough to ensure the rate limit is not exceeded. Not thread safe.
     """
 
-    def __init__(self, rate_limit_s):
+    def __init__(self, rate_limit_s, max_sleep_chunk_s=5):
         """
         :param rate_limit_s: rate limit in seconds
+        :param max_sleep_chunk_s: maximum size of each sleep chunk while waiting for the next period
         """
         self.rate_limit_s = max(rate_limit_s, 0)
         self.period_s = 1.0 / self.rate_limit_s if self.rate_limit_s > 0 else 0
         self.last_event = 0
+        self.max_sleep_chunk_s = max(0, max_sleep_chunk_s)
 
-    def update_last_time_and_sleep(self):
+    def update_last_time_and_sleep(self, cancel_event: Optional[threading.Event] = None):
         """
         Sleeps long enough to enforce the rate limit
         """
-        elapsed_s = time.time() - self.last_event
-        sleep_amount = max(self.period_s - elapsed_s, 0)
-        time.sleep(sleep_amount)
+        if self.period_s <= 0:
+            self.update_last_time()
+            return
+
+        deadline = self.last_event + self.period_s
+        while True:
+            now = time.time()
+            remaining = deadline - now
+            if remaining <= 0:
+                break
+            if cancel_event is not None and cancel_event.is_set():
+                break
+            time.sleep(min(remaining, self.max_sleep_chunk_s if self.max_sleep_chunk_s > 0 else remaining))
         self.update_last_time()
 
     def shall_execute(self):
@@ -275,6 +287,7 @@ class DBMAsyncJob(object):
         min_collection_interval=15,
         dbms="TODO",
         rate_limit=1,
+        max_sleep_chunk_s=1,
         run_sync=False,
         enabled=True,
         expected_db_exceptions=(),
@@ -295,7 +308,8 @@ class DBMAsyncJob(object):
         self._last_check_run = 0
         self._shutdown_callback = shutdown_callback
         self._dbms = dbms
-        self._rate_limiter = ConstantRateLimiter(rate_limit)
+        self._rate_limiter = ConstantRateLimiter(rate_limit, max_sleep_chunk_s=max_sleep_chunk_s)
+        self._max_sleep_chunk_s = max_sleep_chunk_s
         self._run_sync = run_sync
         self._enabled = enabled
         self._expected_db_exceptions = expected_db_exceptions
@@ -387,7 +401,7 @@ class DBMAsyncJob(object):
 
     def _set_rate_limit(self, rate_limit):
         if self._rate_limiter.rate_limit_s != rate_limit:
-            self._rate_limiter = ConstantRateLimiter(rate_limit)
+            self._rate_limiter = ConstantRateLimiter(rate_limit, max_sleep_chunk_s=self._max_sleep_chunk_s)
 
     def _run_sync_job_rate_limited(self):
         if self._rate_limiter.shall_execute():
@@ -401,7 +415,7 @@ class DBMAsyncJob(object):
             raise
         finally:
             if not self._cancel_event.is_set():
-                self._rate_limiter.update_last_time_and_sleep()
+                self._rate_limiter.update_last_time_and_sleep(cancel_event=self._cancel_event)
             else:
                 self._rate_limiter.update_last_time()
 

{datadog_checks_base-37.17.0.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.0
+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.0.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=OGNRWmqbgVQlsRuznKvzC-6tPPWiFqHVOpBqXz6TrCI,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
@@ -145,7 +146,7 @@ datadog_checks/base/utils/db/statement_metrics.py,sha256=U7EtERkmFzfCtfyd3094fBa
 datadog_checks/base/utils/db/timed_cache.py,sha256=a9Ks5KKUvExB6GOATXTSCLamVtLD919Dn6HpweGKtFw,2114
 datadog_checks/base/utils/db/transform.py,sha256=H3JN8_MF0Pk0HaXvIZeX1A8iQrP8KBgS741MPeBiWDo,23969
 datadog_checks/base/utils/db/types.py,sha256=OLX2Oq58JQPFBD4oqUpCLkAP7ovRGN_i1vFk1E0N8Lg,267
-datadog_checks/base/utils/db/utils.py,sha256=f1unpvrx-iFlcD-xUAnrlq5hk-udSw0GyQKYHaPLxFM,21683
+datadog_checks/base/utils/db/utils.py,sha256=6rYXjV9I7Hr_PhgkvhbTiZ0QCmyHWoZYETeUD4Qe3Js,22441
 datadog_checks/base/utils/discovery/__init__.py,sha256=vPCOdsThBcBjFJRPhDm6IsZGOwk8HlvciwCe_l8dKLk,211
 datadog_checks/base/utils/discovery/__init__.pyi,sha256=ScVLU1Njj9ekZmewltb0cULI6BylssVHfn4CcPNeyr8,173
 datadog_checks/base/utils/discovery/cache.py,sha256=f9L3A7YZpZ-mpZpFIwjsa5ab9cZMGkqdetdr9EpalbI,887
@@ -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.0.dist-info/METADATA,sha256=UaY1u0ma7GdxBAIQLtFKQPwNntPVPzLDDi8nYN434_k,4244
-datadog_checks_base-37.17.0.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
-datadog_checks_base-37.17.0.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,,