Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: replace ' ' with '_' #37

Merged
merged 3 commits into from
Sep 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions sumologic_collectd_metrics/metrics_config.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# -*- coding: utf-8 -*-

from .metrics_util import (validate_field, validate_non_empty,
validate_non_negative, validate_positive,
validate_string_type)
from .metrics_util import (validate_non_empty, validate_non_negative,
validate_positive, validate_string_type)


class ConfigOptions(object):
Expand Down Expand Up @@ -144,9 +143,6 @@ def _parse_tags(self, child):
if len(child.values) % 2 != 0:
raise Exception('Missing tags key/value in options %s.' % str(child.values))

for value in child.values:
validate_field(value, child.key, 'Value', 'Key')

self.conf[child.key] = zip(*(iter(child.values),) * 2)

self.collectd.info('Parsed %s tags %s' % (child.key, self.conf[child.key]))
6 changes: 3 additions & 3 deletions sumologic_collectd_metrics/metrics_converter.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import math

from .metrics_util import validate_field
from .metrics_util import sanitize_field


class IntrinsicKeys(object):
Expand All @@ -24,8 +24,8 @@ def gen_tag(key, value):
"""
Tag is of form key=value
"""
key = validate_field(key, value, 'Key', 'Value')
value = validate_field(value, key, 'Value', 'Key')
key = sanitize_field(key)
value = sanitize_field(value)
if not key:
raise Exception('Key for value %s cannot be empty' % value)

Expand Down
24 changes: 2 additions & 22 deletions sumologic_collectd_metrics/metrics_util.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-

_reserved_symbols = {
' ': None,
' ': '_',
'=': ':',
}

Expand Down Expand Up @@ -31,7 +31,7 @@ def validate_string_type(value, field, label1, label2):
(label1, value, label2, field, type(value)))


def validate_field(value, field, label1, label2):
def sanitize_field(value):
"""
Field must be string that does not contains '=' or ' '
"""
Expand All @@ -41,30 +41,10 @@ def validate_field(value, field, label1, label2):

for reserved_symbol, replacement in _reserved_symbols.items():
if reserved_symbol in value:
if replacement is None:
raise Exception('%s %s for %s %s must not contain reserved symbol \"%s\"' %
(label1, value, label2, field, reserved_symbol))

value = value.replace(reserved_symbol, replacement)
return value


def validate_type(data, types):
"""
Validate type are defined in types.db and matching data values
"""

# Verify type is defined in types.db
if data.type not in types:
raise Exception('Do not know how to handle type %s. Do you have all your types.db files'
' configured?' % data.type)

# Verify values conform to the type defined
if len(data.values) != len(types[data.type]):
raise Exception('Number values %s differ from types defined for %s' %
(data.values, data.type))


class RecoverableException(Exception):
"""
Exception that are recoverable.
Expand Down
11 changes: 0 additions & 11 deletions test/test_metrics_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -229,17 +229,6 @@ def test_invalid_http_post_interval_exception():
assert 'Specify HttpPostInterval' in str(e)


def test_contains_reserved_symbols_exception():
with pytest.raises(Exception) as e:
met_config = Helper.default_config()
tags = ('meta_key1', 'meta_val1', 'meta_key2', 'meta val2')
config = CollectdConfig([Helper.url_node(),
tags_node(ConfigOptions.meta_tags, tags)])
met_config.parse_config(config)

assert 'Value meta val2 for Key Metadata must not contain reserved symbol " "' in str(e)


def test_non_ascii_strings():
met_config = Helper.default_config()

Expand Down
4 changes: 4 additions & 0 deletions test/test_metrics_converter.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ def test_gen_value_not_string_exception():
assert expected, value


def test_gen_value_reserved():
assert gen_tag('tag_key space=', 'tag_value=t st') == 'tag_key_space:=tag_value:t_st'


def test_tags_to_str():
tags = ['tag_key1=tag_val1', 'tag_key2=tag_val2', 'tag_key3=tag_val3']
tag_str = tags_to_str(tags)
Expand Down