datadog-checks-base 37.19.0__py2.py3-none-any.whl → 37.21.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.19.0"
+__version__ = "37.21.0"

datadog_checks/base/__init__.pyi

@@ -3,7 +3,7 @@
 # Licensed under a 3-clause BSD style license (see LICENSE)
 from .__about__ import __version__
 from .agent import datadog_agent
-from .checks import AgentCheck
+from .checks import AgentCheck, DatabaseCheck
 from .checks.kube_leader import KubeLeaderElectionBaseCheck
 from .checks.openmetrics import OpenMetricsBaseCheck
 from .checks.openmetrics.v2.base import OpenMetricsBaseCheckV2
@@ -16,6 +16,7 @@ from .utils.common import ensure_bytes, ensure_unicode, to_native_string, to_str
 __all__ = [
     '__version__',
     'AgentCheck',
+    'DatabaseCheck',
     'ConfigurationError',
     'KubeLeaderElectionBaseCheck',
     'OpenMetricsBaseCheck',

datadog_checks/base/checks/__init__.pyi

@@ -2,6 +2,7 @@
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 from .base import AgentCheck
+from .db import DatabaseCheck
 from .network import EventType, NetworkCheck, Status
 
-__all__ = ['AgentCheck', 'EventType', 'NetworkCheck', 'Status']
+__all__ = ['AgentCheck', 'DatabaseCheck', 'EventType', 'NetworkCheck', 'Status']

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/checks/db.py

@@ -0,0 +1,22 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+
+from . import AgentCheck
+
+
+class DatabaseCheck(AgentCheck):
+    def database_monitoring_query_sample(self, raw_event: str):
+        self.event_platform_event(raw_event, "dbm-samples")
+
+    def database_monitoring_query_metrics(self, raw_event: str):
+        self.event_platform_event(raw_event, "dbm-metrics")
+
+    def database_monitoring_query_activity(self, raw_event: str):
+        self.event_platform_event(raw_event, "dbm-activity")
+
+    def database_monitoring_metadata(self, raw_event: str):
+        self.event_platform_event(raw_event, "dbm-metadata")
+
+    def database_monitoring_health(self, raw_event: str):
+        self.event_platform_event(raw_event, "dbm-health")

datadog_checks/base/utils/db/health.py

@@ -12,8 +12,7 @@ from typing import TYPE_CHECKING
 from datadog_checks.base.utils.serialization import json
 
 if TYPE_CHECKING:
-    from datadog_checks.base import AgentCheck
-
+    from datadog_checks.base import DatabaseCheck
 try:
     import datadog_agent
 except ImportError:
@@ -42,7 +41,7 @@ class HealthStatus(Enum):
 
 
 class Health:
-    def __init__(self, check: AgentCheck):
+    def __init__(self, check: DatabaseCheck):
         """
         Initialize the HealthCheck instance.
 

datadog_checks/base/utils/db/utils.py

@@ -471,12 +471,13 @@ class TagManager:
     multiple times.
     """
 
-    def __init__(self) -> None:
+    def __init__(self, normalizer: Optional[Callable[[Union[str, bytes]], str]] = None) -> None:
         self._tags: Dict[Union[str, TagType], List[str]] = {}
         self._cached_tag_list: Optional[tuple[str, ...]] = None
         self._keyless: TagType = TagType.KEYLESS
+        self._normalizer = normalizer
 
-    def set_tag(self, key: Optional[str], value: str, replace: bool = False) -> None:
+    def set_tag(self, key: Optional[str], value: str, replace: bool = False, normalize: bool = False) -> None:
         """
         Set a tag with the given key and value.
         If key is None or empty, the value is stored as a keyless tag.
@@ -485,7 +486,11 @@ class TagManager:
             value (str): The tag value
             replace (bool): If True, replaces all existing values for this key
                            If False, appends the value if it doesn't exist
+            normalize (bool): If True, applies tag normalization using the configured normalizer
         """
+        if normalize and self._normalizer:
+            value = self._normalizer(value)
+
         if not key:
             key = self._keyless
 
@@ -498,13 +503,14 @@ class TagManager:
             # Invalidate the cache since tags have changed
             self._cached_tag_list = None
 
-    def set_tags_from_list(self, tag_list: List[str], replace: bool = False) -> None:
+    def set_tags_from_list(self, tag_list: List[str], replace: bool = False, normalize: bool = False) -> None:
         """
         Set multiple tags from a list of strings.
         Strings can be in "key:value" format or just "value" format.
         Args:
             tag_list (List[str]): List of tags in "key:value" format or just "value"
             replace (bool): If True, replaces all existing tags with the new tags list
+            normalize (bool): If True, applies tag normalization using the configured normalizer
         """
         if replace:
             self._tags.clear()
@@ -513,11 +519,11 @@ class TagManager:
         for tag in tag_list:
             if ':' in tag:
                 key, value = tag.split(':', 1)
-                self.set_tag(key, value)
+                self.set_tag(key, value, normalize=normalize)
             else:
-                self.set_tag(None, tag)
+                self.set_tag(None, tag, normalize=normalize)
 
-    def delete_tag(self, key: Optional[str], value: Optional[str] = None) -> bool:
+    def delete_tag(self, key: Optional[str], value: Optional[str] = None, normalize: bool = False) -> bool:
         """
         Delete a tag or specific value for a tag.
         For keyless tags, use None or empty string as the key.
@@ -525,9 +531,13 @@ class TagManager:
             key (str): The tag key to delete, or None/empty for keyless tags
             value (str, optional): If provided, only deletes this specific value for the key.
                                  If None, deletes all values for the key.
+            normalize (bool): If True, applies tag normalization to the value for lookup
         Returns:
             bool: True if something was deleted, False otherwise
         """
+        if normalize and self._normalizer and value:
+            value = self._normalizer(value)
+
         if not key:
             key = self._keyless
 

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.19.0.dist-info → datadog_checks_base-37.21.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datadog-checks-base
-Version: 37.19.0
+Version: 37.21.0
 Summary: The Datadog Check Toolkit
 Project-URL: Source, https://github.com/DataDog/integrations-core
 Author-email: Datadog <packages@datadoghq.com>
@@ -10,7 +10,7 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: System :: Monitoring
 Provides-Extra: db
 Requires-Dist: mmh3==5.2.0; extra == 'db'
@@ -18,7 +18,7 @@ Provides-Extra: deps
 Requires-Dist: binary==1.0.2; extra == 'deps'
 Requires-Dist: cachetools==6.2.0; extra == 'deps'
 Requires-Dist: cryptography==45.0.6; extra == 'deps'
-Requires-Dist: ddtrace==3.12.3; 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'

{datadog_checks_base-37.19.0.dist-info → datadog_checks_base-37.21.0.dist-info}/RECORD

@@ -3,9 +3,9 @@ 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=h0HfvDkf2Aa8iTSDyAr3hM2lptwVXJOKhEWgL-rgl0I,139
+datadog_checks/base/__about__.py,sha256=pvycJFU0hkYwQYew20pwmnwFDOFZoWPr3etBDGeoKzI,139
 datadog_checks/base/__init__.py,sha256=yWegSLE-TZWIGSvAiJj9PSrUxzlOo_UVJLt2zORZ8Ek,363
-datadog_checks/base/__init__.pyi,sha256=eH8XhrtvnD6uE6FWfEyCmKwOaaLJxNolS08D6IRHZuU,995
+datadog_checks/base/__init__.pyi,sha256=a4Y1JIcPJ8pz9tRkBAvjWdtvSQwZxbMZBuRmIiSs_4E,1031
 datadog_checks/base/agent.py,sha256=nX9x_BYYizRKGNYfXq5z7S0FZ9xcX_wd2tuxpGe3_8k,350
 datadog_checks/base/config.py,sha256=qcAA4X9sXQZRdwQe8DgiGd2980VBp1SQA0d695tX_tU,604
 datadog_checks/base/constants.py,sha256=cR19tAqVysMFbdBWqIGZoHIKk1kGTyqRsCn9FfFQOnw,197
@@ -13,9 +13,10 @@ datadog_checks/base/errors.py,sha256=fPcFaR3zHpSkMo8epvF3lRe9KrEnS8g4J0dXM_nvzsw
 datadog_checks/base/log.py,sha256=gSfzYimmg0z3Dgmn8NpXuyMNjgXwmTbn0NcyUX8B1ls,6283
 datadog_checks/base/types.py,sha256=anajZS0W0TsxUHJQw-JHOP2NSeuC9BisXSy9mAStlxQ,1623
 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/__init__.pyi,sha256=ydetl6kEFCSChppYQhs8mvIP5l6vnZD5AbLABGhbFcM,309
 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/db.py,sha256=HzEOH4uZaMDAaUTJYy0K5wV9FryNQDXsSMAOHXPVaf4,794
 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 +117,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,7 +140,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/health.py,sha256=rdcZPdlLMT4g9tepkietuViKtmP4gwPsjMGCvqC5s54,2366
 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
@@ -146,7 +148,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=6rYXjV9I7Hr_PhgkvhbTiZ0QCmyHWoZYETeUD4Qe3Js,22441
+datadog_checks/base/utils/db/utils.py,sha256=g6GAG1OGvo4O-GrTB6nETvUZGfVUSpqYYJMBuhLs2pM,23130
 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
@@ -220,6 +222,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.19.0.dist-info/METADATA,sha256=eRGRbqzRaiIa1JBahGl2rN02TEj8dH3busevSN6hSHU,4245
-datadog_checks_base-37.19.0.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
-datadog_checks_base-37.19.0.dist-info/RECORD,,
+datadog_checks_base-37.21.0.dist-info/METADATA,sha256=RngK4W5OJrfoUb7udQ1t_kuEqdSP0_6Mk6FecbRTVyo,4245
+datadog_checks_base-37.21.0.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
+datadog_checks_base-37.21.0.dist-info/RECORD,,