datadog-checks-base 37.7.0__py2.py3-none-any.whl → 37.8.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.7.0"
+__version__ = "37.8.0"

datadog_checks/base/__init__.py

@@ -1,51 +1,11 @@
 # (C) Datadog, Inc. 2018-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
-from datadog_checks.base.agent import datadog_agent
+import lazy_loader
 
-from .__about__ import __version__
-from .checks import AgentCheck
-from .checks.openmetrics import OpenMetricsBaseCheck
-from .checks.openmetrics.v2.base import OpenMetricsBaseCheckV2
-from .config import is_affirmative
-from .errors import ConfigurationError
-from .utils.common import ensure_bytes, ensure_unicode, to_native_string, to_string
+__getattr__, __dir__, __all__ = lazy_loader.attach_stub(__name__, __file__)
 
-if datadog_agent.get_config('use_boringssl'):
+if __getattr__('datadog_agent').get_config('use_boringssl'):
     import urllib3.contrib.pyopenssl
 
     urllib3.contrib.pyopenssl.inject_into_urllib3()
-
-# Windows-only
-try:
-    from .checks.win import PDHBaseCheck
-except ImportError:
-    PDHBaseCheck = None
-
-# Windows-only and Python 3+
-try:
-    from .checks.windows.perf_counters import PerfCountersBaseCheck
-except Exception:
-    PerfCountersBaseCheck = None
-
-# Kubernetes dep will not always be installed
-try:
-    from .checks.kube_leader import KubeLeaderElectionBaseCheck
-except ImportError:
-    KubeLeaderElectionBaseCheck = None
-
-__all__ = [
-    '__version__',
-    'AgentCheck',
-    'KubeLeaderElectionBaseCheck',
-    'OpenMetricsBaseCheck',
-    'OpenMetricsBaseCheckV2',
-    'PDHBaseCheck',
-    'PerfCountersBaseCheck',
-    'ConfigurationError',
-    'ensure_bytes',
-    'ensure_unicode',
-    'is_affirmative',
-    'to_native_string',
-    'to_string',  # For backwards compat (was renamed to `to_native_string`).
-]

datadog_checks/base/__init__.pyi

@@ -0,0 +1,31 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# 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.kube_leader import KubeLeaderElectionBaseCheck
+from .checks.openmetrics import OpenMetricsBaseCheck
+from .checks.openmetrics.v2.base import OpenMetricsBaseCheckV2
+from .checks.win import PDHBaseCheck
+from .checks.windows.perf_counters import PerfCountersBaseCheck
+from .config import is_affirmative
+from .errors import ConfigurationError
+from .utils.common import ensure_bytes, ensure_unicode, to_native_string, to_string
+
+__all__ = [
+    '__version__',
+    'AgentCheck',
+    'ConfigurationError',
+    'KubeLeaderElectionBaseCheck',
+    'OpenMetricsBaseCheck',
+    'OpenMetricsBaseCheckV2',
+    'PDHBaseCheck',
+    'PerfCountersBaseCheck',
+    'datadog_agent',
+    'ensure_bytes',
+    'ensure_unicode',
+    'is_affirmative',
+    'to_native_string',
+    'to_string',
+]

datadog_checks/base/checks/__init__.py

@@ -1,8 +1,6 @@
 # (C) Datadog, Inc. 2018-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
+import lazy_loader
 
-from .base import AgentCheck
-from .network import EventType, NetworkCheck, Status
-
-__all__ = ['AgentCheck', 'NetworkCheck', 'Status', 'EventType']
+__getattr__, __dir__, __all__ = lazy_loader.attach_stub(__name__, __file__)

datadog_checks/base/checks/__init__.pyi

@@ -0,0 +1,7 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from .base import AgentCheck
+from .network import EventType, NetworkCheck, Status
+
+__all__ = ['AgentCheck', 'EventType', 'NetworkCheck', 'Status']

datadog_checks/base/checks/base.py

@@ -1,15 +1,14 @@
 # (C) Datadog, Inc. 2018-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
+from __future__ import annotations
+
 import copy
 import functools
 import importlib
-import inspect
 import logging
 import os
 import re
-import traceback
-import unicodedata
 from collections import deque
 from os.path import basename
 from typing import (  # noqa: F401
@@ -27,10 +26,10 @@ from typing import (  # noqa: F401
     Union,
 )
 
-import yaml
-from pydantic import BaseModel, ValidationError
+import lazy_loader
 
 from datadog_checks.base.agent import AGENT_RUNNING, aggregator, datadog_agent
+from datadog_checks.base.utils.format import json
 
 from ..config import is_affirmative
 from ..constants import ServiceCheck
@@ -46,15 +45,8 @@ from ..types import (
 )
 from ..utils.agent.utils import should_profile_memory
 from ..utils.common import ensure_bytes, to_native_string
-from ..utils.diagnose import Diagnosis
 from ..utils.fips import enable_fips
-from ..utils.http import RequestsWrapper
-from ..utils.limiter import Limiter
-from ..utils.metadata import MetadataManager
-from ..utils.secrets import SecretsSanitizer
-from ..utils.serialization import from_json, to_json
 from ..utils.tagging import GENERIC_TAGS
-from ..utils.tls import TlsContextWrapper
 from ..utils.tracing import traced_class
 
 if AGENT_RUNNING:
@@ -87,7 +79,18 @@ if is_affirmative(datadog_agent.get_config('integration_profiling')):
     prof.start()
 
 if TYPE_CHECKING:
+    import inspect as _module_inspect
     import ssl  # noqa: F401
+    import traceback as _module_traceback
+    import unicodedata as _module_unicodedata
+
+    from datadog_checks.base.utils.diagnose import Diagnosis
+    from datadog_checks.base.utils.http import RequestsWrapper
+    from datadog_checks.base.utils.metadata import MetadataManager
+
+inspect: _module_inspect = lazy_loader.load('inspect')
+traceback: _module_traceback = lazy_loader.load('traceback')
+unicodedata: _module_unicodedata = lazy_loader.load('unicodedata')
 
 # Metric types for which it's only useful to submit once per set of tags
 ONE_PER_CONTEXT_METRIC_TYPES = [aggregator.GAUGE, aggregator.RATE, aggregator.MONOTONIC_COUNT]
@@ -342,6 +345,9 @@ class AgentCheck(object):
         limit = self._get_metric_limit(instance=instance)
 
         if limit > 0:
+            # See Performance Optimizations in this package's README.md.
+            from datadog_checks.base.utils.limiter import Limiter
+
             return Limiter(name, 'metrics', limit, self.warning)
 
         return None
@@ -386,17 +392,22 @@ class AgentCheck(object):
         """
         Convenience wrapper to ease programmatic use of this class from the C API.
         """
+        # See Performance Optimizations in this package's README.md.
+        import yaml
+
         return yaml.safe_load(yaml_str)
 
     @property
-    def http(self):
-        # type: () -> RequestsWrapper
+    def http(self) -> RequestsWrapper:
         """
         Provides logic to yield consistent network behavior based on user configuration.
 
         Only new checks or checks on Agent 6.13+ can and should use this for HTTP requests.
         """
         if not hasattr(self, '_http'):
+            # See Performance Optimizations in this package's README.md.
+            from datadog_checks.base.utils.http import RequestsWrapper
+
             self._http = RequestsWrapper(self.instance or {}, self.init_config, self.HTTP_CONFIG_REMAPPER, self.log)
 
         return self._http
@@ -432,12 +443,14 @@ class AgentCheck(object):
         return self.__formatted_tags
 
     @property
-    def diagnosis(self):
-        # type: () -> Diagnosis
+    def diagnosis(self) -> Diagnosis:
         """
         A Diagnosis object to register explicit diagnostics and record diagnoses.
         """
         if not hasattr(self, '_diagnosis'):
+            # See Performance Optimizations in this package's README.md.
+            from datadog_checks.base.utils.diagnose import Diagnosis
+
             self._diagnosis = Diagnosis(sanitize=self.sanitize)
         return self._diagnosis
 
@@ -451,6 +464,9 @@ class AgentCheck(object):
         Since: Agent 7.24
         """
         if not hasattr(self, '_tls_context_wrapper'):
+            # See Performance Optimizations in this package's README.md.
+            from datadog_checks.base.utils.tls import TlsContextWrapper
+
             self._tls_context_wrapper = TlsContextWrapper(
                 self.instance or {}, self.TLS_CONFIG_REMAPPER, overrides=overrides
             )
@@ -461,8 +477,7 @@ class AgentCheck(object):
         return self._tls_context_wrapper.tls_context
 
     @property
-    def metadata_manager(self):
-        # type: () -> MetadataManager
+    def metadata_manager(self) -> MetadataManager:
         """
         Used for sending metadata via Go bindings.
         """
@@ -470,6 +485,9 @@ class AgentCheck(object):
             if not self.check_id and AGENT_RUNNING:
                 raise RuntimeError('Attribute `check_id` must be set')
 
+            # See Performance Optimizations in this package's README.md.
+            from datadog_checks.base.utils.metadata import MetadataManager
+
             self._metadata_manager = MetadataManager(self.name, self.check_id, self.log, self.METADATA_TRANSFORMERS)
 
         return self._metadata_manager
@@ -498,8 +516,9 @@ class AgentCheck(object):
         return False
 
     def log_typos_in_options(self, user_config, models_config, level):
-        # only import it when running in python 3
+        # See Performance Optimizations in this package's README.md.
         from jellyfish import jaro_winkler_similarity
+        from pydantic import BaseModel
 
         user_configs = user_config or {}  # type: Dict[str, Any]
         models_config = models_config or {}
@@ -570,6 +589,8 @@ class AgentCheck(object):
 
         model = getattr(package, model_name, None)
         if model is not None:
+            from pydantic import ValidationError
+
             try:
                 config_model = model.model_validate(config, context=context)
             except ValidationError as e:
@@ -598,12 +619,14 @@ class AgentCheck(object):
     def _get_config_model_context(self, config):
         return {'logger': self.log, 'warning': self.warning, 'configured_fields': frozenset(config)}
 
-    def register_secret(self, secret):
-        # type: (str) -> None
+    def register_secret(self, secret: str) -> None:
         """
         Register a secret to be scrubbed by `.sanitize()`.
         """
         if not hasattr(self, '_sanitizer'):
+            # See Performance Optimizations in this package's README.md.
+            from datadog_checks.base.utils.secrets import SecretsSanitizer
+
             # Configure lazily so that checks that don't use sanitization aren't affected.
             self._sanitizer = SecretsSanitizer()
             self.log.setup_sanitization(sanitize=self.sanitize)
@@ -953,6 +976,10 @@ class AgentCheck(object):
         # type: (str, ServiceCheckStatus, Sequence[str], str, str, bool) -> None
         """Send the status of a service.
 
+        !!! warning "Soft Deprecation"
+            When building new checks avoid submitting service checks.
+            **Checks that already submit service checks will continue to do so.**
+
         Parameters:
             name (str):
                 the name of the service check
@@ -1005,15 +1032,15 @@ class AgentCheck(object):
             # convert seconds to milliseconds
             attributes['timestamp'] = int(timestamp * 1000)
 
-        datadog_agent.send_log(to_json(attributes), self.check_id)
+        datadog_agent.send_log(json.encode(attributes), self.check_id)
         if cursor is not None:
-            self.write_persistent_cache('log_cursor_{}'.format(stream), to_json(cursor))
+            self.write_persistent_cache('log_cursor_{}'.format(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))
-        return from_json(data) if data else None
+        return json.decode(data) if data else None
 
     def _log_deprecation(self, deprecation_key, *args):
         # type: (str, *str) -> None
@@ -1184,7 +1211,11 @@ class AgentCheck(object):
         The agent calls this method to retrieve diagnostics from integrations. This method
         runs explicit diagnostics if available.
         """
-        return to_json([d._asdict() for d in (self.diagnosis.diagnoses + self.diagnosis.run_explicit())])
+        return json.encode([d._asdict() for d in (self.diagnosis.diagnoses + self.diagnosis.run_explicit())])
+
+    def _clear_diagnosis(self) -> None:
+        if hasattr(self, '_diagnosis'):
+            self._diagnosis.clear()
 
     def _get_requests_proxy(self):
         # type: () -> ProxySettings
@@ -1268,7 +1299,7 @@ class AgentCheck(object):
     def run(self):
         # type: () -> str
         try:
-            self.diagnosis.clear()
+            self._clear_diagnosis()
             # Ignore check initializations if running in a separate process
             if is_affirmative(self.instance.get('process_isolation', self.init_config.get('process_isolation', False))):
                 from ..utils.replay.execute import run_with_isolation
@@ -1304,7 +1335,7 @@ class AgentCheck(object):
         except Exception as e:
             message = self.sanitize(str(e))
             tb = self.sanitize(traceback.format_exc())
-            error_report = to_json([{'message': message, 'traceback': tb}])
+            error_report = json.encode([{'message': message, 'traceback': tb}])
         finally:
             if self.metric_limiter:
                 if is_affirmative(self.debug_metrics.get('metric_contexts', False)):

datadog_checks/base/checks/kube_leader/__init__.py

@@ -1,9 +1,6 @@
 # (C) Datadog, Inc. 2018-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
+import lazy_loader
 
-from .base_check import KubeLeaderElectionBaseCheck
-from .mixins import KubeLeaderElectionMixin
-from .record import ElectionRecordAnnotation, ElectionRecordLease
-
-__all__ = ['KubeLeaderElectionMixin', 'ElectionRecordAnnotation', 'ElectionRecordLease', 'KubeLeaderElectionBaseCheck']
+__getattr__, __dir__, __all__ = lazy_loader.attach_stub(__name__, __file__)

datadog_checks/base/checks/kube_leader/__init__.pyi

@@ -0,0 +1,8 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from .base_check import KubeLeaderElectionBaseCheck
+from .mixins import KubeLeaderElectionMixin
+from .record import ElectionRecordAnnotation, ElectionRecordLease
+
+__all__ = ['ElectionRecordAnnotation', 'ElectionRecordLease', 'KubeLeaderElectionBaseCheck', 'KubeLeaderElectionMixin']

datadog_checks/base/checks/kubelet_base/__init__.py

@@ -0,0 +1,6 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+import lazy_loader
+
+__getattr__, __dir__, __all__ = lazy_loader.attach_stub(__name__, __file__)

datadog_checks/base/checks/kubelet_base/__init__.pyi

@@ -0,0 +1,6 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from .base import KubeletBase
+
+__all__ = ['KubeletBase']

datadog_checks/base/checks/openmetrics/__init__.py

@@ -1,8 +1,6 @@
 # (C) Datadog, Inc. 2018-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
+import lazy_loader
 
-
-from .base_check import OpenMetricsBaseCheck
-
-__all__ = ['OpenMetricsBaseCheck']
+__getattr__, __dir__, __all__ = lazy_loader.attach_stub(__name__, __file__)

datadog_checks/base/checks/openmetrics/__init__.pyi

@@ -0,0 +1,6 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from .base_check import OpenMetricsBaseCheck
+
+__all__ = ['OpenMetricsBaseCheck']

datadog_checks/base/checks/openmetrics/v2/scraper.py

@@ -50,7 +50,6 @@ class OpenMetricsScraper:
         """
         The base class for any scraper overrides.
         """
-
         self.config = config
 
         # Save a reference to the check instance
@@ -393,7 +392,6 @@ class OpenMetricsScraper:
         """
         Yield the connection line.
         """
-
         try:
             with self.get_connection() as connection:
                 # Media type will be used to select parser dynamically

datadog_checks/base/checks/openmetrics/v2/transformers/__init__.py

@@ -1,13 +1,6 @@
 # (C) Datadog, Inc. 2020-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
-from .counter import get_counter
-from .counter_gauge import get_counter_gauge
-from .gauge import get_gauge
-from .histogram import get_histogram
-from .metadata import get_metadata
-from .rate import get_rate
-from .service_check import get_service_check
-from .summary import get_summary
-from .temporal_percent import get_temporal_percent
-from .time_elapsed import get_time_elapsed
+import lazy_loader
+
+__getattr__, __dir__, __all__ = lazy_loader.attach_stub(__name__, __file__)

datadog_checks/base/checks/openmetrics/v2/transformers/__init__.pyi

@@ -0,0 +1,26 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from .counter import get_counter
+from .counter_gauge import get_counter_gauge
+from .gauge import get_gauge
+from .histogram import get_histogram
+from .metadata import get_metadata
+from .rate import get_rate
+from .service_check import get_service_check
+from .summary import get_summary
+from .temporal_percent import get_temporal_percent
+from .time_elapsed import get_time_elapsed
+
+__all__ = [
+    'get_counter',
+    'get_counter_gauge',
+    'get_gauge',
+    'get_histogram',
+    'get_metadata',
+    'get_rate',
+    'get_service_check',
+    'get_summary',
+    'get_temporal_percent',
+    'get_time_elapsed',
+]

datadog_checks/base/checks/prometheus/__init__.py

@@ -1,9 +1,6 @@
 # (C) Datadog, Inc. 2018-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
+import lazy_loader
 
-from .base_check import GenericPrometheusCheck, PrometheusScraper
-from .mixins import PrometheusFormat, UnknownFormatError
-from .prometheus_base import PrometheusCheck
-
-__all__ = ['PrometheusFormat', 'UnknownFormatError', 'PrometheusCheck', 'GenericPrometheusCheck', 'PrometheusScraper']
+__getattr__, __dir__, __all__ = lazy_loader.attach_stub(__name__, __file__)

datadog_checks/base/checks/prometheus/__init__.pyi

@@ -0,0 +1,8 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from .base_check import GenericPrometheusCheck, PrometheusScraper
+from .mixins import PrometheusFormat, UnknownFormatError
+from .prometheus_base import PrometheusCheck
+
+__all__ = ['GenericPrometheusCheck', 'PrometheusCheck', 'PrometheusFormat', 'PrometheusScraper', 'UnknownFormatError']

datadog_checks/base/checks/prometheus/mixins.py

@@ -569,7 +569,7 @@ class PrometheusScraperMixin(object):
             and not handler.ignore_tls_warning
             and not is_affirmative(handler.options.get('ssl_verify', True))
         ):
-            self.log.warning(u'An unverified HTTPS request is being made to %s', endpoint)
+            self.log.debug(u'An unverified HTTPS request is being made to %s', endpoint)
 
         try:
             response = handler.get(endpoint, extra_headers=headers, stream=False)

datadog_checks/base/checks/win/__init__.py

@@ -1,8 +1,6 @@
 # (C) Datadog, Inc. 2018-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
+import lazy_loader
 
-from .winpdh import WinPDHCounter
-from .winpdh_base import PDHBaseCheck
-
-__all__ = ['PDHBaseCheck', 'WinPDHCounter']
+__getattr__, __dir__, __all__ = lazy_loader.attach_stub(__name__, __file__)

datadog_checks/base/checks/win/__init__.pyi

@@ -0,0 +1,7 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from .winpdh import WinPDHCounter
+from .winpdh_base import PDHBaseCheck
+
+__all__ = ['PDHBaseCheck', 'WinPDHCounter']