feat(config): add metric dimension by default

Signed-off-by: Dominik Rosiek <drosiek@sumologic.com>
SumoLogic · Sep 24, 2021 · 70de47c · 70de47c
1 parent 432c113
commit 70de47c
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -99,7 +99,7 @@ The parameters below are not strictly required. It is recommended to set these p
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+----------+
 | Metadata                       | Key value pairs that do not contribute to identifying a metric. Metadata are primarily used to assist in searching metrics. Collectd data may have internal metadata. The additional metadata specified here can be used to enrich the existing metadata set. Metadata cannot contain `Reserved symbols`_ and `Reserved keywords`_                                                                                                                        | Srings in the format of ``"key1"="val1", "key2"="val2"`` ... | False    |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+----------+
-| AddMetricDimension             | If set to ``true`` adds new dimension named ``metric`` to every data point which consists of ``type`` and ``type_instance`` concatenated using ``MetricDimensionSeparator``. By default it is set to ``False``.                                                                                                                                                                                                                                           | Boolean                                                      | False    |
+| AddMetricDimension             | If set to ``true`` adds new dimension named ``metric`` to every data point which consists of ``type`` and ``type_instance`` concatenated using ``MetricDimensionSeparator``. By default it is set to ``True``.                                                                                                                                                                                                                                            | Boolean                                                      | False    |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+----------+
 | MetricDimensionSeparator       | String used to concatenate ``type`` and ``type_instance`` while creating ``metric`` dimension. See ``AddMetricDimension`` option. By default it is ``.``.                                                                                                                                                                                                                                                                                                 | String                                                       | False    |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+----------+

diff --git a/sumologic_collectd_metrics/metrics_config.py b/sumologic_collectd_metrics/metrics_config.py
@@ -70,7 +70,7 @@ def default_config():
             ConfigOptions.content_encoding: 'deflate',
             ConfigOptions.content_type: 'application/vnd.sumologic.carbon2',
             ConfigOptions.shutdown_max_wait: 5,
-            ConfigOptions.add_metric_dimension: False,
+            ConfigOptions.add_metric_dimension: True,
             ConfigOptions.metric_dimension_separator: '.',
         }
 

diff --git a/test/collectd/values.py b/test/collectd/values.py
@@ -41,7 +41,7 @@ def __init__(self,
         self.ds_names = ds_names
         self.ds_types = ds_types
 
-    def metrics_str(self, sep=None):
+    def metrics_str(self, sep='.'):
         """
         Builds metric string. If sep is not None,
         it includes metric dimension using sep as separator

diff --git a/test/test_metrics_converter.py b/test/test_metrics_converter.py
@@ -75,7 +75,7 @@ def test_convert_to_metrics_single():
     dataset = CollecdMock().get_dataset('test_type')
     metrics = convert_to_metrics(data, dataset, None)
 
-    assert metrics == data.metrics_str()
+    assert metrics == data.metrics_str(None)
 
 
 def test_convert_to_metrics_multiple():
@@ -85,7 +85,7 @@ def test_convert_to_metrics_multiple():
     dataset = CollecdMock().get_dataset('test_type_2')
     metrics = convert_to_metrics(data, dataset, None)
 
-    assert metrics == data.metrics_str()
+    assert metrics == data.metrics_str(None)
 
 
 def test_convert_to_metrics_no_meta():
@@ -95,7 +95,7 @@ def test_convert_to_metrics_no_meta():
     dataset = CollecdMock().get_dataset('test_type_2')
     metrics = convert_to_metrics(data, dataset, None)
 
-    assert metrics == data.metrics_str()
+    assert metrics == data.metrics_str(None)
 
 
 def test_convert_to_metrics_with_metric_dimension():

diff --git a/test/test_metrics_writer.py b/test/test_metrics_writer.py
@@ -48,7 +48,7 @@ def test_write_callback_host_with_equal_char():
     expected_value = ['host=[invalid:host]' \
     ' plugin=test_plugin plugin_instance=test_plugin_instance' \
     ' type=test_type type_instance=test_type_instance ds_name=test_ds_name ds_type=test_ds_type' \
-    '  test_meta_key=test_meta_val 3.140000 1501775008']
+    ' metric=test_type.test_type_instance  test_meta_key=test_meta_val 3.140000 1501775008']
     metrics_writer.write_callback(data)
 
     assert metrics_writer.met_batcher.queue.qsize() == 1