updating tag_by alias

Author: mrafi97

datadog_checks_base/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.22.1"
+__version__ = "37.22.0"

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

@@ -147,8 +147,8 @@ def _get_tag_query_tag(self, sampler, wmi_obj, tag_query):
         self.log.debug("Extracted `tag_queries` tag: '%s'", tag)
         return tag
 
-    def _extract_metrics(self, wmi_sampler, tag_by, tag_queries, constant_tags, tag_by_prefix):
-        # type: (WMISampler, str, List[List[str]], List[str], str) -> List[WMIMetric]
+    def _extract_metrics(self, wmi_sampler, tag_by, tag_queries, constant_tags):
+        # type: (WMISampler, str, List[List[str]], List[str]) -> List[WMIMetric]
         """
         Extract and tag metrics from the WMISampler.
 
@@ -174,8 +174,6 @@ def _extract_metrics(self, wmi_sampler, tag_by, tag_queries, constant_tags, tag_
 
         extracted_metrics = []
         tag_by = tag_by.lower()
-        if tag_by_prefix:
-            tag_by_prefix = tag_by_prefix.lower()
 
         for wmi_obj in wmi_sampler:
             tags = list(constant_tags) if constant_tags else []
@@ -205,13 +203,21 @@ def _extract_metrics(self, wmi_sampler, tag_by, tag_queries, constant_tags, tag_
                 # Tag with `tag_by` parameter
                 for t in tag_by.split(','):
                     t = t.strip()
+                    if ' as ' in t:
+                        t_split = t.split(' as ')
+                        t = t_split[0].strip()
+                        alias = t_split[1].strip()
+                    else:
+                        alias = None
                     if normalized_wmi_property == t:
                         tag_value = str(wmi_value).lower()
                         if tag_queries and tag_value.find("#") > 0:
                             tag_value = tag_value[: tag_value.find("#")]
-                        if tag_by_prefix:
-                            t = "{prefix}_{name}".format(prefix=tag_by_prefix, name=t)
-                        tags.append("{name}:{value}".format(name=t, value=tag_value))
+
+                        if alias:
+                            tags.append("{name}:{value}".format(name=alias, value=tag_value))
+                        else:
+                            tags.append("{name}:{value}".format(name=t, value=tag_value))
                         continue
 
                 # No metric extraction on 'Name' and properties in tag_by
@@ -272,6 +278,7 @@ def _get_instance_key(self, host, namespace, wmi_class, other=None):
     def get_running_wmi_sampler(self, properties, filters, **kwargs):
         # type: (List[str], List[Dict[str, WMIFilter]], **Any) -> WMISampler
         tag_by = kwargs.pop('tag_by', "")
+
         return self._get_running_wmi_sampler(
             instance_key=None,
             wmi_class=self.wmi_class,

wmi_check/assets/configuration/spec.yaml

@@ -143,18 +143,12 @@ files:
         The `tag_by` parameter lets you tag each metric with a property from the WMI class you're using.
         This is only useful when you will have multiple values for your WMI query.
         Comma-separated list of property names
+        Add aliases to the property tags with by appending AS <ALIAS_NAME> to the property name.
+        For example: Name AS wmi_name will be tagged as wmi_name:value instead of Name:value.
       value:
         type: string
         display_default: null
-        example: Name,Label
-    - name: tag_by_prefix
-      description: |
-        The `tag_by_prefix` parameter lets you specify a prefix to use for the tags generated by the `tag_by` parameter.
-        If not provided, the tags will not be prefixed. Prefixes will added like this: <PREFIX>_<PROPERTY_NAME>.
-      value:
-        type: string
-        display_default: null
-        example: wmi
+        example: Name AS wmi_name,Label
     - name: tag_queries
       description: |
         The `tag_queries`  parameter lets you specify a list of queries, to tag metrics with a target class property.

wmi_check/datadog_checks/wmi_check/__about__.py

@@ -2,4 +2,4 @@
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
-__version__ = '3.4.0'
+__version__ = '3.5.0'

wmi_check/datadog_checks/wmi_check/config_models/instance.py

@@ -48,7 +48,6 @@ class InstanceConfig(BaseModel):
     provider: Optional[int] = None
     service: Optional[str] = None
     tag_by: Optional[str] = None
-    tag_by_prefix: Optional[str] = None
     tag_queries: Optional[tuple[tuple[str, ...], ...]] = None
     tags: Optional[tuple[str, ...]] = None
     username: Optional[str] = None

wmi_check/datadog_checks/wmi_check/data/conf.yaml.example

@@ -132,14 +132,10 @@ instances:
     ## The `tag_by` parameter lets you tag each metric with a property from the WMI class you're using.
     ## This is only useful when you will have multiple values for your WMI query.
     ## Comma-separated list of property names
+    ## Add aliases to the property tags with by appending AS <ALIAS_NAME> to the property name.
+    ## For example: Name AS wmi_name will be tagged as wmi_name:value instead of Name:value.
     #
-    # tag_by: Name,Label
-
-    ## @param tag_by_prefix - string - optional
-    ## The `tag_by_prefix` parameter lets you specify a prefix to use for the tags generated by the `tag_by` parameter.
-    ## If not provided, the tags will not be prefixed. Prefixes will added like this: <PREFIX>_<PROPERTY_NAME>.
-    #
-    # tag_by_prefix: wmi
+    # tag_by: Name AS wmi_name,Label
 
     ## @param tag_queries - list of lists - optional
     ## The `tag_queries`  parameter lets you specify a list of queries, to tag metrics with a target class property.

wmi_check/datadog_checks/wmi_check/wmi_check.py

@@ -21,7 +21,6 @@ def __init__(self, name, init_config, instances):
         self.filters = self.instance.get('filters', [])  # type: List[Dict[str, WMIFilter]]
         self.metrics_to_capture = self.instance.get('metrics', [])  # type: List[List[str]]
         self.tag_by = self.instance.get('tag_by', "")  # type: str
-        self.tag_by_prefix = self.instance.get('tag_by_prefix', "")  # type: str
         self.tag_queries = self.instance.get('tag_queries', [])  # type: List[TagQuery]
 
         custom_tags = self.instance.get('tags', [])  # type: List[str]
@@ -38,7 +37,18 @@ def check(self, _):
         # Create or retrieve an existing WMISampler
         metric_name_and_type_by_property, properties = self.get_wmi_properties()
 
-        wmi_sampler = self.get_running_wmi_sampler(properties, self.filters, tag_by=self.tag_by)
+        tag_by_properties = ""
+        for t in self.tag_by.split(','):
+            t = t.strip()
+            if ' AS ' in t:
+                t_split = t.split(' AS ')
+                t = t_split[0].strip()
+                tag_by_properties += t + ","
+            else:
+                tag_by_properties += t + ","
+        tag_by_properties = tag_by_properties.rstrip(',')
+
+        wmi_sampler = self.get_running_wmi_sampler(properties, self.filters, tag_by=tag_by_properties)
 
         # Sample, extract & submit metrics
         try:
@@ -57,7 +67,7 @@ def check(self, _):
 
     def extract_metrics(self, wmi_sampler):
         # type: (WMISampler) -> List[WMIMetric]
-        return self._extract_metrics(wmi_sampler, self.tag_by, self.tag_queries, self.constant_tags, self.tag_by_prefix)
+        return self._extract_metrics(wmi_sampler, self.tag_by, self.tag_queries, self.constant_tags)
 
     def get_wmi_properties(self):
         # type: () -> WMIProperties

wmi_check/tests/conftest.py

@@ -114,10 +114,11 @@ def mock_sampler_with_tag_by_prefix():
         {
             "IOReadBytesPerSec": 20455,
             "IDProcess": 1234,
-            "Name": "chrome.exe",
+            "Name": "foo",
             "ThreadCount": 4,
             "VirtualBytes": 3811,
             "PercentProcessorTime": 5,
+            "Label": "bar",
         }
     ]
     main_property_names = [
@@ -127,6 +128,7 @@ def mock_sampler_with_tag_by_prefix():
         "PercentProcessorTime",
         "IDProcess",
         "Name",
+        "Label",
     ]
     main_sampler = MockSampler(main_wmi_objects, main_property_names)
     main_sampler.class_name = 'Win32_PerfFormattedData_PerfProc_Process'

wmi_check/tests/test_wmi_check.py

@@ -4,6 +4,7 @@
 
 import copy
 import logging
+import pytest
 from unittest.mock import patch
 
 from . import common
@@ -109,23 +110,31 @@ def test_tag_queries_without_alias(mock_sampler_with_tag_queries, aggregator, ch
     aggregator.assert_all_metrics_covered()
 
 
-def test_tag_by_is_correctly_prefixed(mock_sampler_with_tag_by_prefix, aggregator, check):
+@pytest.mark.parametrize(
+    "tag_by,result_tags",
+    [
+        ('Name AS wmi_name', ['wmi_name:foo']),
+        ('Name,Label AS wmi_label', ['name:foo', 'wmi_label:bar']),
+        ('name as wmi_name,label as wmi_label', ['wmi_name:foo', 'wmi_label:bar']),
+        ('nameaswmi_name', [])
+    ],
+)
+def test_tag_by_is_correctly_prefixed(mock_sampler_with_tag_by_prefix, aggregator, check, tag_by, result_tags):
     instance = copy.deepcopy(common.INSTANCE)
-    instance['tag_by_prefix'] = 'wmi'
+    instance['tag_by'] = tag_by
 
     c = check(instance)
 
     with patch.object(c, '_extract_metrics', wraps=c._extract_metrics) as mock_extract:
         c.check(instance)
         assert mock_extract.called
         # Check the arguments it was called with
-        # _extract_metrics(self, wmi_sampler, tag_by, tag_queries, constant_tags, tag_by_prefix)
+        # _extract_metrics(self, wmi_sampler, tag_by, tag_queries, constant_tags)
         call_args = mock_extract.call_args
-        # The last positional argument (index 4) should be tag_by_prefix
-        assert call_args[0][4] == 'wmi'
+        assert call_args[0][1] == tag_by
 
-    # Verify metrics are tagged with the prefix
+    # Verify metrics are tagged with the alias
     for metric in common.INSTANCE_METRICS:
-        aggregator.assert_metric(metric, tags=['wmi_name:chrome.exe'], count=1)
+        aggregator.assert_metric(metric, tags=result_tags, count=1)
 
     aggregator.assert_all_metrics_covered()