datadog-checks-base 37.18.1__py2.py3-none-any.whl → 37.20.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.18.1"
+__version__ = "37.20.0"

datadog_checks/base/checks/base.py

@@ -11,19 +11,10 @@ import os
 import re
 from collections import deque
 from os.path import basename
-from typing import (  # noqa: F401
+from typing import (
     TYPE_CHECKING,
     Any,
-    AnyStr,
-    Callable,
-    Deque,
-    Dict,
-    List,
-    Optional,
-    Sequence,
-    Set,
-    Tuple,
-    Union,
+    Deque,  # noqa: F401
 )
 
 import lazy_loader
@@ -294,10 +285,16 @@ class AgentCheck(object):
         # Functions that will be called exactly once (if successful) before the first check run
         self.check_initializations = deque()  # type: Deque[Callable[[], None]]
 
-        self.check_initializations.append(self.load_configuration_models)
+        self.check_initializations.extend(
+            [
+                self.load_configuration_models,
+                self.__initialize_persistent_cache_key_prefix,
+            ]
+        )
 
         self.__formatted_tags = None
         self.__logs_enabled = None
+        self.__persistent_cache_key_prefix: str = ""
 
         if os.environ.get("GOFIPS", "0") == "1":
             enable_fips()
@@ -491,6 +488,18 @@ class AgentCheck(object):
         self._log_deprecation('in_developer_mode')
         return False
 
+    def persistent_cache_id(self) -> str:
+        """
+        Returns the ID that identifies this check instance in the Agent persistent cache.
+
+        Overriding this method modifies the default behavior of the AgentCheck and can
+        be used to customize when the persistent cache is invalidated. The default behavior
+        defines the persistent cache ID as the digest of the full check configuration.
+
+        Some per-check isolation is still applied to avoid different checks with the same ID to share the same keys.
+        """
+        return self.check_id.split(":")[-1]
+
     def log_typos_in_options(self, user_config, models_config, level):
         # See Performance Optimizations in this package's README.md.
         from jellyfish import jaro_winkler_similarity
@@ -1009,13 +1018,15 @@ class AgentCheck(object):
             attributes['timestamp'] = int(timestamp * 1000)
 
         datadog_agent.send_log(json.encode(attributes), self.check_id)
+
         if cursor is not None:
-            self.write_persistent_cache('log_cursor_{}'.format(stream), json.encode(cursor))
+            self.write_persistent_cache(f'log_cursor_{stream}', json.encode(cursor))
 
     def get_log_cursor(self, stream='default'):
         # type: (str) -> dict[str, Any] | None
         """Returns the most recent log cursor from disk."""
-        data = self.read_persistent_cache('log_cursor_{}'.format(stream))
+        data = self.read_persistent_cache(f'log_cursor_{stream}')
+
         return json.decode(data) if data else None
 
     def _log_deprecation(self, deprecation_key, *args):
@@ -1082,9 +1093,9 @@ class AgentCheck(object):
 
         return entrypoint
 
-    def _persistent_cache_id(self, key):
-        # type: (str) -> str
-        return '{}_{}'.format(self.check_id, key)
+    def __initialize_persistent_cache_key_prefix(self):
+        namespace = ':'.join(self.check_id.split(':')[:-1])
+        self.__persistent_cache_key_prefix = f'{namespace}:{self.persistent_cache_id()}_'
 
     def read_persistent_cache(self, key):
         # type: (str) -> str
@@ -1094,9 +1105,9 @@ class AgentCheck(object):
             key (str):
                 the key to retrieve
         """
-        return datadog_agent.read_persistent_cache(self._persistent_cache_id(key))
+        return datadog_agent.read_persistent_cache(f"{self.__persistent_cache_key_prefix}{key}")
 
-    def write_persistent_cache(self, key, value):
+    def write_persistent_cache(self, key: str, value: str):
         # type: (str, str) -> None
         """Stores `value` in a persistent cache for this check instance.
         The cache is located in a path where the agent is guaranteed to have read & write permissions. Namely in
@@ -1110,7 +1121,7 @@ class AgentCheck(object):
             value (str):
                 the value to store
         """
-        datadog_agent.write_persistent_cache(self._persistent_cache_id(key), value)
+        datadog_agent.write_persistent_cache(f"{self.__persistent_cache_key_prefix}{key}", value)
 
     def set_external_tags(self, external_tags):
         # type: (Sequence[ExternalTagType]) -> None
@@ -1282,13 +1293,7 @@ class AgentCheck(object):
 
                 run_with_isolation(self, aggregator, datadog_agent)
             else:
-                while self.check_initializations:
-                    initialization = self.check_initializations.popleft()
-                    try:
-                        initialization()
-                    except Exception:
-                        self.check_initializations.appendleft(initialization)
-                        raise
+                self.run_check_initializations()
 
                 instance = copy.deepcopy(self.instances[0])
 
@@ -1328,6 +1333,15 @@ class AgentCheck(object):
 
         return error_report
 
+    def run_check_initializations(self):
+        while self.check_initializations:
+            initialization = self.check_initializations.popleft()
+            try:
+                initialization()
+            except Exception:
+                self.check_initializations.appendleft(initialization)
+                raise
+
     def event(self, event):
         # type: (Event) -> None
         """Send an event.

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/persistent_cache.py

@@ -0,0 +1,33 @@
+from collections.abc import Collection
+
+from datadog_checks.base import AgentCheck
+from datadog_checks.base.utils.containers import hash_mutable
+
+
+def config_set_persistent_cache_id(
+    check: AgentCheck,
+    init_config_options: Collection[str] | None = None,
+    instance_config_options: Collection[str] | None = None,
+):
+    """
+    Returns an ID for the persisitent cache derives from a subset of the check's config options.
+
+    If the value of any of the provided options changes, the generate cache ID will change.
+
+    Parameters:
+        check: the check instance the key is going to be used for.
+        init_config_options: the subset of init_config options to use to generate the cache ID.
+        instance_config_options: the subset of config options to use to generate the cache ID.
+    """
+
+    if not init_config_options and not instance_config_options:
+        raise ValueError("At least one of init_config_options or instance_config_options must be provided")
+
+    set_init_config_options = set(init_config_options) if init_config_options else set()
+    set_instance_config_options = set(instance_config_options) if instance_config_options else set()
+
+    init_config_values = tuple(value for key, value in check.init_config.items() if key in set_init_config_options)
+    instance_config_values = tuple(value for key, value in check.instance.items() if key in set_instance_config_options)
+
+    selected_values = init_config_values + instance_config_values
+    return str(hash_mutable(selected_values)).replace("-", "")

{datadog_checks_base-37.18.1.dist-info → datadog_checks_base-37.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datadog-checks-base
-Version: 37.18.1
+Version: 37.20.0
 Summary: The Datadog Check Toolkit
 Project-URL: Source, https://github.com/DataDog/integrations-core
 Author-email: Datadog <packages@datadoghq.com>
@@ -13,29 +13,29 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: System :: Monitoring
 Provides-Extra: db
-Requires-Dist: mmh3==5.1.0; extra == 'db'
+Requires-Dist: mmh3==5.2.0; extra == 'db'
 Provides-Extra: deps
 Requires-Dist: binary==1.0.2; extra == 'deps'
-Requires-Dist: cachetools==6.1.0; extra == 'deps'
-Requires-Dist: cryptography==45.0.4; extra == 'deps'
-Requires-Dist: ddtrace==3.9.3; extra == 'deps'
+Requires-Dist: cachetools==6.2.0; extra == 'deps'
+Requires-Dist: cryptography==45.0.6; extra == 'deps'
+Requires-Dist: ddtrace==3.12.5; extra == 'deps'
 Requires-Dist: jellyfish==1.2.0; extra == 'deps'
 Requires-Dist: lazy-loader==0.4; extra == 'deps'
 Requires-Dist: prometheus-client==0.22.1; extra == 'deps'
-Requires-Dist: protobuf==6.31.1; extra == 'deps'
+Requires-Dist: protobuf==6.32.0; extra == 'deps'
 Requires-Dist: pydantic==2.11.7; extra == 'deps'
 Requires-Dist: python-dateutil==2.9.0.post0; extra == 'deps'
-Requires-Dist: pywin32==310; (sys_platform == 'win32') and extra == 'deps'
+Requires-Dist: pywin32==311; (sys_platform == 'win32') and extra == 'deps'
 Requires-Dist: pyyaml==6.0.2; extra == 'deps'
 Requires-Dist: requests-toolbelt==1.0.0; extra == 'deps'
 Requires-Dist: requests-unixsocket2==1.0.0; extra == 'deps'
-Requires-Dist: requests==2.32.4; extra == 'deps'
+Requires-Dist: requests==2.32.5; extra == 'deps'
 Requires-Dist: simplejson==3.20.1; extra == 'deps'
 Requires-Dist: urllib3==2.5.0; extra == 'deps'
-Requires-Dist: wrapt==1.17.2; extra == 'deps'
+Requires-Dist: wrapt==1.17.3; extra == 'deps'
 Provides-Extra: http
 Requires-Dist: aws-requests-auth==0.4.3; extra == 'http'
-Requires-Dist: botocore==1.38.41; extra == 'http'
+Requires-Dist: botocore==1.40.21; extra == 'http'
 Requires-Dist: oauthlib==3.3.1; extra == 'http'
 Requires-Dist: pyjwt==2.10.1; extra == 'http'
 Requires-Dist: pyopenssl==25.1.0; extra == 'http'
@@ -44,7 +44,7 @@ Requires-Dist: requests-kerberos==0.15.0; extra == 'http'
 Requires-Dist: requests-ntlm==1.3.0; extra == 'http'
 Requires-Dist: requests-oauthlib==2.0.0; extra == 'http'
 Provides-Extra: json
-Requires-Dist: orjson==3.11.1; extra == 'json'
+Requires-Dist: orjson==3.11.3; extra == 'json'
 Provides-Extra: kube
 Requires-Dist: kubernetes==33.1.0; extra == 'kube'
 Requires-Dist: requests-oauthlib==2.0.0; extra == 'kube'

{datadog_checks_base-37.18.1.dist-info → datadog_checks_base-37.20.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=4qSLAXxeYfOKih3MKLLjw5ykR-Ucmj6wEToUwV4N5Lc,139
+datadog_checks/base/__about__.py,sha256=hXkLHsKgHttGQ7R5jeQ0cESbDNRVE8U1W-La8t1CUAw,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
@@ -15,7 +15,7 @@ datadog_checks/base/types.py,sha256=anajZS0W0TsxUHJQw-JHOP2NSeuC9BisXSy9mAStlxQ,
 datadog_checks/base/checks/__init__.py,sha256=q7V6v-FwQWkQC1QWaVzKaPjZMaxPJHJcLd71C0uM7bA,211
 datadog_checks/base/checks/__init__.pyi,sha256=LASfm-daLNQIYe6-w0NPqBw4cl83nYIX5_B-VhV6ARo,262
 datadog_checks/base/checks/_config_ast.py,sha256=v1rAhwORF80b3kfZKhf6zXZ7S5D3A2QPUK4tSo8eo-Y,3268
-datadog_checks/base/checks/base.py,sha256=kcnZ8ySfleMGw5y6iLEvhLaF42WGCMes0LfylLo_v50,59857
+datadog_checks/base/checks/base.py,sha256=xP56kjtCvW-CMWrdVN3ZC1yAhQr4jad9ORPDuOdz-eM,60654
 datadog_checks/base/checks/network.py,sha256=UkgqkVHaoX7Hqi0WKEx-TvaFiF6-37VyF9A3m2aSaJM,1966
 datadog_checks/base/checks/kube_leader/__init__.py,sha256=q7V6v-FwQWkQC1QWaVzKaPjZMaxPJHJcLd71C0uM7bA,211
 datadog_checks/base/checks/kube_leader/__init__.pyi,sha256=UGDywoRwmCIz3Zii1uHsp7jiFGWRdn5fFMZZxgGGlQs,398
@@ -116,6 +116,7 @@ datadog_checks/base/utils/functions.py,sha256=iGlybxR6aPPElNxNb2ELOzbk328j9OVBAx
 datadog_checks/base/utils/headers.py,sha256=0SSdC71jwaB61BODfusahCVr1c56GvT9iwt7cidcHP0,1779
 datadog_checks/base/utils/http.py,sha256=ePSzL7x_xsb1dnXJyU2fBXIgOU0p5UFZIpG2AX_jZZA,44651
 datadog_checks/base/utils/limiter.py,sha256=YRTrPCX1S5EtHLVcP_-GEfzRots_LTcy1f_uHZVs90g,3027
+datadog_checks/base/utils/persistent_cache.py,sha256=i5I9BKIb5V2BFEs0sVTf8bBQUIH21G2nL_tRQHC9GMk,1538
 datadog_checks/base/utils/platform.py,sha256=wW8f6XKo4JHxvu1sN0DpLDmYjS_cCu8GoKvfTjIj4yM,2499
 datadog_checks/base/utils/secrets.py,sha256=Tj5MBOoyGXXDWB3Hr-7UKDy5GV1NZJkFPY4T4v9PHHg,551
 datadog_checks/base/utils/serialization.py,sha256=pcRUzZIUZkOsfnGDGbxeUwGXrSsFl_9rLhA0ekD_AZ8,975
@@ -138,6 +139,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 +221,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.18.1.dist-info/METADATA,sha256=c0CirmMk4cxkDnX8P1TPhQMMjyfjAMHQJ7hLf9hRQTo,4244
-datadog_checks_base-37.18.1.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
-datadog_checks_base-37.18.1.dist-info/RECORD,,
+datadog_checks_base-37.20.0.dist-info/METADATA,sha256=Btd945pDmErXUpZ1MdzT1T8BWpedTQU4xKyl9XsHOA8,4245
+datadog_checks_base-37.20.0.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
+datadog_checks_base-37.20.0.dist-info/RECORD,,