Skip to content
This repository has been archived by the owner on Dec 17, 2021. It is now read-only.

Commit

Permalink
feat: aggregate 'is_metric' and 'return_multimetric' parameters to on…
Browse files Browse the repository at this point in the history 
…e -> 'data_format'
  • Loading branch information
@omrozowicz-splunk
omrozowicz-splunk committed Aug 19, 2021
1 parent 7071f33 commit 0d3d111
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 50 deletions.
45 changes: 12 additions & 33 deletions splunk_connect_for_snmp_mib_server/mib_server.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,17 @@


class MibServer:

def __init__(self, args, server_config):
self._args = args
self._server_config = server_config
self._translator = Translator(server_config)
self._flask_app = self.build_flask_app()
self.data_format = {
"METRIC": self._translator.format_metric_data,
"TEXT": self._translator.format_text_event,
"MULTIMETRIC": self._translator.format_multimetric_data
}

def build_flask_app(self):
app = Flask(__name__)
Expand All @@ -51,46 +57,19 @@ def autoindex(path="."):
def translator():
logger.debug(request.json)
var_binds = request.json.get("var_binds")
metric = request.args.get("metric")
return_multimetric = request.args.get("return_multimetric")
data_format = request.args.get("data_format")
logger.debug(f"type of var_binds: {type(var_binds)}")
logger.debug(f"var_binds: {var_binds}")
logger.debug(f"return_multimetric: {return_multimetric}")
logger.debug(f"type of metric: {str(metric)} -- metric: {metric}")
if metric == "True":
# if metric is true, var_binds has just one element
var_bind = var_binds[0]
result = json.dumps(self._translator.format_metric_data(var_bind))
logger.debug(f"requested data format: {str(data_format)} ")
if data_format in self.data_format:
method = self.data_format.get(data_format)
result = method(var_binds)
else:
# when 'return_multimetric' variable is set up as 'True', mib server should return both metric and
# non-metric representation of the result
if return_multimetric == "True":
return self._return_multimetric_data(var_binds)
else:
result = self._translator.format_trap_event(var_binds)
result = self._translator.format_text_event(var_binds)
return result

return app

def _return_multimetric_data(self, varbinds: list) -> dict:
"""
If field 'return_multimetric' was set to 'True', mib_server returns dictionary containing metric structure,
non-metric structure and metric name. For example:
{'metric_name': 'sc4snmp.IF-MIB.ifDescr_1',
'metric': '{"metric_name": "sc4snmp.IF-MIB.ifDescr_1", "_value": "lo", "metric_type": "OctetString"}',
'non_metric': 'oid-type1="ObjectIdentity" value1-type="OctetString" 1.3.6.1.2.1.2.2.1.2.1="lo"
value1="lo" IF-MIB::ifDescr.1="lo" '}
:param varbinds: list of varbinds
:return: dictionary of the above structure
"""
result_dict = self._translator.format_metric_data(varbinds[0])
result_string = self._translator.format_trap_event(varbinds)
result = {'metric_name': result_dict['metric_name'], 'metric': json.dumps(result_dict),
'non_metric': result_string}
return result

def run_mib_server(self):
# poetry run fails when debug=True
self._flask_app.run(host="0.0.0.0", port=self._args.port)
24 changes: 22 additions & 2 deletions splunk_connect_for_snmp_mib_server/translator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ def get_custom_translation_table(self):
return translation_table

# Format and translate the trap events
def format_trap_event(self, var_binds):
def format_text_event(self, var_binds: list):
trap_event_string = ""
offset = 0

Expand Down Expand Up @@ -346,11 +346,12 @@ def format_trap_event(self, var_binds):
return trap_event_string

# Format and translate the metric data
def format_metric_data(self, var_bind):
def format_metric_data(self, var_bind: list, index=0):
"""
format one varBind object into metric format
@param var_bind: single varBind object
"""
var_bind = var_bind[index]
metric_data = {}

oid = var_bind["oid"]
Expand Down Expand Up @@ -382,3 +383,22 @@ def format_metric_data(self, var_bind):
metric_data["custom_metric_name"] = custom_translated_oid
logger.debug(f"metric_data: {json.dumps(metric_data)}")
return metric_data

def format_multimetric_data(self, varbinds: list) -> dict:
"""
If field 'return_multimetric' was set to 'True', mib_server returns dictionary containing metric structure,
non-metric structure and metric name. For example:
{'metric_name': 'sc4snmp.IF-MIB.ifDescr_1',
'metric': '{"metric_name": "sc4snmp.IF-MIB.ifDescr_1", "_value": "lo", "metric_type": "OctetString"}',
'non_metric': 'oid-type1="ObjectIdentity" value1-type="OctetString" 1.3.6.1.2.1.2.2.1.2.1="lo"
value1="lo" IF-MIB::ifDescr.1="lo" '}
:param varbinds: list of varbinds
:return: dictionary of the above structure
"""
result_dict = self.format_metric_data(varbinds)
result_string = self.format_text_event(varbinds)
result = {'metric_name': result_dict['metric_name'], 'metric': json.dumps(result_dict),
'non_metric': result_string}
return result
32 changes: 17 additions & 15 deletions tests/test_translator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ def test_format_trap(self):
},
]

translated_var_binds = self.my_translator.format_trap_event(
translated_var_binds = self.my_translator.format_text_event(
input_var_binds_list
)
assert len(translated_var_binds) > 0
Expand All @@ -135,7 +135,7 @@ def test_format_trap_non_existing_oid(self):
},
]

translated_var_binds = self.my_translator.format_trap_event(
translated_var_binds = self.my_translator.format_text_event(
input_var_binds_list
)

Expand Down Expand Up @@ -186,38 +186,40 @@ def test_format_trap_invalid_input(self):
},
]

translated_var_binds = self.my_translator.format_trap_event(
translated_var_binds = self.my_translator.format_text_event(
input_var_binds_invalids
)
assert len(translated_var_binds) == 0

@mongomock.patch()
def test_format_metric(self):
input_var_binds = {
input_var_binds = [{
"oid": "1.3.6.1.2.1.1.3.0",
"val": "123",
"val_type": "TimeTicks",
}
}]
translated_dict = self.my_translator.format_metric_data(input_var_binds)
for required_key in ["metric_name", "_value", "metric_type"]:
assert required_key in translated_dict
assert translated_dict["metric_name"] == "sc4snmp.SNMPv2-MIB.sysUpTime_0"
assert translated_dict["_value"] == input_var_binds["val"]
assert translated_dict["metric_type"] == input_var_binds["val_type"]
input_var_bind = input_var_binds[0]
assert translated_dict["_value"] == input_var_bind["val"]
assert translated_dict["metric_type"] == input_var_bind["val_type"]

@mongomock.patch()
def test_format_non_existing_metric(self):
input_var_binds = {
input_var_binds = [{
"oid": "1.3.6666.16666.26666.16666.1.3.0",
"val": "123",
"val_type": "TimeTicks",
}
}]
translated_dict = self.my_translator.format_metric_data(input_var_binds)
for required_key in ["metric_name", "_value", "metric_type"]:
assert required_key in translated_dict
assert translated_dict["_value"] == input_var_binds["val"]
assert translated_dict["metric_type"] == input_var_binds["val_type"]
untranslated_oid = input_var_binds["oid"].replace(".", "_")
input_var_bind = input_var_binds[0]
assert translated_dict["_value"] == input_var_bind["val"]
assert translated_dict["metric_type"] == input_var_bind["val_type"]
untranslated_oid = input_var_bind["oid"].replace(".", "_")
assert translated_dict["metric_name"] == f"sc4snmp.{untranslated_oid}"

@mongomock.patch()
Expand Down Expand Up @@ -277,11 +279,11 @@ def test_translate_all_snmp_simulator_data_types(self):
and len(value_types) == len(expected_translations)
)
for index in range(0, len(oids)):
input_var_binds_colons = {
input_var_binds_colons = [{
"oid": oids[index],
"val": str_values[index],
"val_type": value_types[index],
}
}]
translated_metrics = self.my_translator.format_metric_data(
input_var_binds_colons
)
Expand All @@ -308,6 +310,6 @@ def test_more_mib_files(self):

for i in range(0, len(input_var_binds)):
translated_dict = self.my_translator.format_metric_data(
input_var_binds[i]
input_var_binds, i
)
assert translated_dict["metric_name"] == expected_values[i]

0 comments on commit 0d3d111

Please sign in to comment.