datadog-checks-base 37.15.0__py2.py3-none-any.whl → 37.17.0__py2.py3-none-any.whl

datadog_checks/base/checks/win/wmi/sampler.py

@@ -23,6 +23,7 @@ Please refer to `checks.lib.wmi.counter_type` for more information*
 Original discussion thread: https://github.com/DataDog/dd-agent/issues/1952
 Credits to @TheCloudlessSky (https://github.com/TheCloudlessSky)
 """
+
 from copy import deepcopy
 from threading import Event, Thread
 
@@ -227,7 +228,7 @@ class WMISampler(object):
                 result = parsed_value
 
         if result is None:
-            self.logger.error(u"Invalid '%s' WMI Provider Architecture. The parameter is ignored.", value)
+            self.logger.error("Invalid '%s' WMI Provider Architecture. The parameter is ignored.", value)
 
         self._provider = result or ProviderArchitecture.DEFAULT
 
@@ -278,7 +279,7 @@ class WMISampler(object):
         """
         # No data is returned while sampling
         if self._sampling:
-            raise TypeError(u"Sampling `WMISampler` object has no len()")
+            raise TypeError("Sampling `WMISampler` object has no len()")
 
         return len(self._current_sample)
 
@@ -288,7 +289,7 @@ class WMISampler(object):
         """
         # No data is returned while sampling
         if self._sampling:
-            raise TypeError(u"Sampling `WMISampler` object is not iterable")
+            raise TypeError("Sampling `WMISampler` object is not iterable")
 
         if self.is_raw_perf_class:
             # Format required
@@ -334,7 +335,7 @@ class WMISampler(object):
             calculator = get_calculator(counter_type)
         except UndefinedCalculator:
             self.logger.warning(
-                u"Undefined WMI calculator for counter_type %s. Values are reported as RAW.", counter_type
+                "Undefined WMI calculator for counter_type %s. Values are reported as RAW.", counter_type
             )
 
         return calculator
@@ -364,7 +365,7 @@ class WMISampler(object):
         Create a new WMI connection
         """
         self.logger.debug(
-            u"Connecting to WMI server (host=%s, namespace=%s, provider=%s, username=%s).",
+            "Connecting to WMI server (host=%s, namespace=%s, provider=%s, username=%s).",
             self.host,
             self.namespace,
             self.provider,
@@ -550,7 +551,7 @@ class WMISampler(object):
             wql = "Select {property_names} from {class_name}{filters}".format(
                 property_names=formated_property_names, class_name=self.class_name, filters=self.formatted_filters
             )
-            self.logger.debug(u"Querying WMI: %s", wql)
+            self.logger.debug("Querying WMI: %s", wql)
         except Exception as e:
             self.logger.error(str(e))
             return []
@@ -575,7 +576,7 @@ class WMISampler(object):
             results = self._parse_results(raw_results, includes_qualifiers=includes_qualifiers)
 
         except pywintypes.com_error:
-            self.logger.warning(u"Failed to execute WMI query (%s)", wql, exc_info=True)
+            self.logger.warning("Failed to execute WMI query (%s)", wql, exc_info=True)
             results = []
 
         return results
@@ -615,7 +616,6 @@ class WMISampler(object):
                 )
 
                 if should_get_qualifier_type:
-
                     # Can't index into "Qualifiers_" for keys that don't exist
                     # without getting an exception.
                     qualifiers = dict((q.Name, q.Value) for q in wmi_property.Qualifiers_)
@@ -628,14 +628,14 @@ class WMISampler(object):
                         self._property_counter_types[wmi_property.Name] = counter_type
 
                         self.logger.debug(
-                            u"Caching property qualifier CounterType: %s.%s = %s",
+                            "Caching property qualifier CounterType: %s.%s = %s",
                             self.class_name,
                             wmi_property.Name,
                             counter_type,
                         )
                     else:
                         self.logger.debug(
-                            u"CounterType qualifier not found for %s.%s", self.class_name, wmi_property.Name
+                            "CounterType qualifier not found for %s.%s", self.class_name, wmi_property.Name
                         )
 
                 try:

datadog_checks/base/checks/windows/perf_counters/base.py

@@ -7,10 +7,11 @@ from contextlib import contextmanager, suppress
 import pywintypes
 import win32pdh
 
-from ....config import is_affirmative
-from ....errors import ConfigTypeError, ConfigurationError
-from ....utils.functions import raise_exception
-from ... import AgentCheck
+from datadog_checks.base.checks import AgentCheck
+from datadog_checks.base.config import is_affirmative
+from datadog_checks.base.errors import ConfigTypeError, ConfigurationError
+from datadog_checks.base.utils.functions import raise_exception
+
 from .connection import Connection
 from .counter import PerfObject
 

datadog_checks/base/checks/windows/perf_counters/connection.py

@@ -9,7 +9,7 @@ import win32api
 import win32pdh
 import win32wnet
 
-from ....errors import ConfigTypeError
+from datadog_checks.base.errors import ConfigTypeError
 
 
 class NetworkResources:
@@ -77,7 +77,7 @@ class Connection:
             # https://docs.microsoft.com/en-us/windows/win32/api/winnetwk/ns-winnetwk-netresourcea
             # https://mhammond.github.io/pywin32/PyNETRESOURCE.html
             self.network_resource = win32wnet.NETRESOURCE()
-            self.network_resource.lpRemoteName = fr'\\{server}'
+            self.network_resource.lpRemoteName = rf'\\{server}'
 
         self.__query_handle = None
 

datadog_checks/base/checks/windows/perf_counters/counter.py

@@ -7,7 +7,8 @@ import weakref
 import pywintypes
 import win32pdh
 
-from ....errors import ConfigTypeError, ConfigValueError
+from datadog_checks.base.errors import ConfigTypeError, ConfigValueError
+
 from .constants import PDH_CSTATUS_INVALID_DATA, PDH_INVALID_DATA
 from .transform import NATIVE_TRANSFORMERS, TRANSFORMERS
 from .utils import construct_counter_path, get_counter_value, get_counter_values, validate_path

datadog_checks/base/checks/windows/perf_counters/transformers/service_check.py

@@ -1,8 +1,8 @@
 # (C) Datadog, Inc. 2021-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
-from .....constants import ServiceCheck
-from .....errors import ConfigTypeError, ConfigValueError
+from datadog_checks.base.constants import ServiceCheck
+from datadog_checks.base.errors import ConfigTypeError, ConfigValueError
 
 
 def get_service_check(check, metric_name, modifiers):

datadog_checks/base/checks/windows/perf_counters/transformers/temporal_percent.py

@@ -1,9 +1,9 @@
 # (C) Datadog, Inc. 2021-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
-from .....errors import ConfigTypeError, ConfigValueError
-from .....utils.common import total_time_to_temporal_percent
-from .....utils.constants import TIME_UNITS
+from datadog_checks.base.errors import ConfigTypeError, ConfigValueError
+from datadog_checks.base.utils.common import total_time_to_temporal_percent
+from datadog_checks.base.utils.constants import TIME_UNITS
 
 
 def get_temporal_percent(check, metric_name, modifiers):

datadog_checks/base/checks/windows/perf_counters/transformers/time_elapsed.py

@@ -1,7 +1,7 @@
 # (C) Datadog, Inc. 2021-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
-from .....utils.time import get_timestamp
+from datadog_checks.base.utils.time import get_timestamp
 
 
 def get_time_elapsed(check, metric_name, modifiers):

datadog_checks/base/stubs/aggregator.py

@@ -8,8 +8,9 @@ import os
 import re
 from collections import OrderedDict, defaultdict
 
-from ..constants import ServiceCheck
-from ..utils.common import ensure_unicode, to_native_string
+from datadog_checks.base.constants import ServiceCheck
+from datadog_checks.base.utils.common import ensure_unicode, to_native_string
+
 from .common import HistogramBucketStub, MetricStub, ServiceCheckStub
 from .similar import build_similar_elements_msg
 
@@ -425,10 +426,19 @@ class AggregatorStub(object):
         assert condition, msg
 
     def assert_metrics_using_metadata(
-        self, metadata_metrics, check_metric_type=True, check_submission_type=False, exclude=None
+        self,
+        metadata_metrics,
+        check_metric_type=True,
+        check_submission_type=False,
+        exclude=None,
+        check_symmetric_inclusion=False,
     ):
         """
-        Assert metrics using metadata.csv
+        Assert metrics using metadata.csv. The assertion fails if there are metrics emitted that are
+        not in metadata.csv. Metrics passed in the `exclude` parameter are ignored.
+
+        Pass `check_symmetric_inclusion=True` to assert that both set of metrics, those submitted and
+        those in metadata.csv, are the same.
 
         Checking type: By default we are asserting the in-app metric type (`check_submission_type=False`),
         asserting this type make sense for e2e (metrics collected from agent).
@@ -444,6 +454,7 @@ class AggregatorStub(object):
 
         exclude = exclude or []
         errors = set()
+        submitted_metrics = set()
         for metric_name, metric_stubs in self._metrics.items():
             if metric_name in exclude:
                 continue
@@ -456,6 +467,8 @@ class AggregatorStub(object):
                 if check_submission_type and actual_metric_type in ['histogram', 'historate']:
                     metric_stub_name += '.count'
 
+                submitted_metrics.add(metric_stub_name)
+
                 # Checking the metric is in `metadata.csv`
                 if metric_stub_name not in metadata_metrics:
                     errors.add("Expect `{}` to be in metadata.csv.".format(metric_stub_name))
@@ -478,6 +491,10 @@ class AggregatorStub(object):
                             )
                         )
 
+        if check_symmetric_inclusion:
+            missing_metrics = metadata_metrics.keys() - submitted_metrics
+            errors.update(f"Expect `{m}` from metadata.csv but not submitted." for m in missing_metrics)
+
         assert not errors, "Metadata assertion errors using metadata.csv:" + "\n\t- ".join([''] + sorted(errors))
 
     def assert_service_checks(self, service_checks):

datadog_checks/base/stubs/datadog_agent.py

@@ -52,7 +52,7 @@ class DatadogAgentStub(object):
             key = (check_id, name)
             if key in self._metadata:
                 actual[name] = self._metadata[key]
-        assert data == actual
+        assert data == actual, f'Expected metadata: {data}; actual metadata: {actual}'
 
     def assert_metadata_count(self, count):
         metadata_items = len(self._metadata)
@@ -67,10 +67,10 @@ class DatadogAgentStub(object):
                     external_tags = {k: sorted(v) for (k, v) in external_tags.items()}
                     tags = {k: sorted(v) for (k, v) in tags.items()}
 
-                assert (
-                    external_tags == tags
-                ), 'Expected {} external tags for hostname {}, found {}. Submitted external tags: {}'.format(
-                    external_tags, hostname, tags, repr(self._external_tags)
+                assert external_tags == tags, (
+                    'Expected {} external tags for hostname {}, found {}. Submitted external tags: {}'.format(
+                        external_tags, hostname, tags, repr(self._external_tags)
+                    )
                 )
                 return
 

datadog_checks/base/stubs/log.py

@@ -3,7 +3,7 @@
 # Licensed under a 3-clause BSD style license (see LICENSE)
 import logging
 
-from ..log import CheckLoggingAdapter as AgentLoggingAdapter
+from datadog_checks.base.log import CheckLoggingAdapter as AgentLoggingAdapter
 
 TRACE_LEVEL = 7
 

datadog_checks/base/utils/db/core.py

@@ -6,10 +6,10 @@ from itertools import chain
 from typing import Any, Callable, Dict, List, Tuple  # noqa: F401
 
 from datadog_checks.base import AgentCheck  # noqa: F401
+from datadog_checks.base.config import is_affirmative
+from datadog_checks.base.utils.containers import iter_unique
 from datadog_checks.base.utils.db.types import QueriesExecutor, QueriesSubmitter, Transformer  # noqa: F401
 
-from ...config import is_affirmative
-from ..containers import iter_unique
 from .query import Query
 from .transform import COLUMN_TRANSFORMERS, EXTRA_TRANSFORMERS
 from .utils import SUBMISSION_METHODS, create_submission_transformer, tracked_query

datadog_checks/base/utils/db/query.py

@@ -214,9 +214,7 @@ class Query(object):
             elif extra_type not in extra_transformers and extra_type not in submission_transformers:
                 raise ValueError('unknown type `{}` for extra {} of {}'.format(extra_type, extra_name, query_name))
 
-            transformer_factory = extra_transformers.get(
-                extra_type, submission_transformers.get(extra_type)
-            )  # type: TransformerFactory
+            transformer_factory = extra_transformers.get(extra_type, submission_transformers.get(extra_type))  # type: TransformerFactory
 
             extra_source = extra.get('source')
             if extra_type in submission_transformers:

datadog_checks/base/utils/db/transform.py

@@ -8,14 +8,14 @@ import time
 from datetime import datetime
 from typing import Any, Callable, Dict, List, Tuple  # noqa: F401
 
+from datadog_checks.base import is_affirmative
+from datadog_checks.base.constants import ServiceCheck
 from datadog_checks.base.types import ServiceCheckStatus  # noqa: F401
+from datadog_checks.base.utils import constants
+from datadog_checks.base.utils.common import compute_percent, total_time_to_temporal_percent
 from datadog_checks.base.utils.db.types import Transformer, TransformerFactory  # noqa: F401
+from datadog_checks.base.utils.time import ensure_aware_datetime
 
-from ... import is_affirmative
-from ...constants import ServiceCheck
-from .. import constants
-from ..common import compute_percent, total_time_to_temporal_percent
-from ..time import ensure_aware_datetime
 from .utils import create_extra_transformer
 
 # Used for the user-defined `expression`s
@@ -85,9 +85,7 @@ def get_monotonic_gauge(transformers, column_name, **modifiers):
     Send the result as both a `gauge` suffixed by `.total` and a `monotonic_count` suffixed by `.count`.
     """
     gauge = transformers['gauge'](transformers, '{}.total'.format(column_name), **modifiers)  # type: Callable
-    monotonic_count = transformers['monotonic_count'](
-        transformers, '{}.count'.format(column_name), **modifiers
-    )  # type: Callable
+    monotonic_count = transformers['monotonic_count'](transformers, '{}.count'.format(column_name), **modifiers)  # type: Callable
 
     def monotonic_gauge(_, value, **kwargs):
         # type: (List, str, Dict[str, Any]) -> None

datadog_checks/base/utils/db/utils.py

@@ -20,12 +20,11 @@ from cachetools import TTLCache
 from datadog_checks.base import is_affirmative
 from datadog_checks.base.agent import datadog_agent
 from datadog_checks.base.log import get_check_logger
+from datadog_checks.base.utils.common import to_native_string
 from datadog_checks.base.utils.db.types import Transformer  # noqa: F401
 from datadog_checks.base.utils.format import json
 from datadog_checks.base.utils.tracing import INTEGRATION_TRACING_SERVICE_NAME, tracing_enabled
 
-from ..common import to_native_string
-
 logger = logging.getLogger(__file__)
 
 # AgentCheck methods to transformer name e.g. set_metadata -> metadata
@@ -335,7 +334,7 @@ class DBMAsyncJob(object):
         try:
             self._log.info("[%s] Starting job loop", self._job_tags_str)
             while True:
-                if self._cancel_event.isSet():
+                if self._cancel_event.is_set():
                     self._log.info("[%s] Job loop cancelled", self._job_tags_str)
                     self._check.count("dd.{}.async_job.cancel".format(self._dbms), 1, tags=self._job_tags, raw=True)
                     break
@@ -354,7 +353,7 @@ class DBMAsyncJob(object):
                 else:
                     self._run_job_rate_limited()
         except Exception as e:
-            if self._cancel_event.isSet():
+            if self._cancel_event.is_set():
                 # canceling can cause exceptions if the connection is closed the middle of the check run
                 # in this case we still want to report it as a cancellation instead of a crash
                 self._log.debug("[%s] Job loop error after cancel: %s", self._job_tags_str, e)
@@ -401,7 +400,7 @@ class DBMAsyncJob(object):
         except:
             raise
         finally:
-            if not self._cancel_event.isSet():
+            if not self._cancel_event.is_set():
                 self._rate_limiter.update_last_time_and_sleep()
             else:
                 self._rate_limiter.update_last_time()