From 126da7bbfa5677bbdbcfbaf7a1b3a5ce7cc13202 Mon Sep 17 00:00:00 2001 From: Shashank Reddy Boyapally Date: Tue, 1 Oct 2024 00:10:52 -0500 Subject: [PATCH] splunk connector added Signed-off-by: Shashank Reddy Boyapally --- fmatch/splunk_matcher.py | 66 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 fmatch/splunk_matcher.py diff --git a/fmatch/splunk_matcher.py b/fmatch/splunk_matcher.py new file mode 100644 index 0000000..1aaaaee --- /dev/null +++ b/fmatch/splunk_matcher.py @@ -0,0 +1,66 @@ +#pylint: disable = C0209 +""" +Matcher for splunk datasource +""" +import orjson +from splunklib import client, results + + +class SplunkMatcher: + """Splunk data source matcher + """ + def __init__(self, host, port, username, password, indice): #pylint: disable = R0913 + self.indice = indice + self.service = client.connect( + host=host, port=port, username=username, password=password + ) + + async def query(self, query, searchList="", max_results=10000): + """ + Query data from splunk server using splunk lib sdk + + Args: + query (string): splunk query + OPTIONAL: searchList (string): additional query parameters for index + """ + query["count"] = max_results + + # If additional search parameters are provided, include those in searchindex + searchindex = ( + "search index={} {}".format(self.indice, searchList) + if searchList + else "search index={}".format(self.indice) + ) + try: + oneshotsearch_results = self.service.jobs.oneshot(searchindex, **query) + except Exception as e: #pylint: disable = W0718 + print("Error querying splunk: {}".format(e)) + return None + + # Get the results and display them using the JSONResultsReader + res_array = [] + async for record in self._stream_results(oneshotsearch_results): + try: + res_array.append( + { + "data": orjson.loads(record["_raw"]), #pylint: disable = E1101 + "host": record["host"], + "source": record["source"], + "sourcetype": record["sourcetype"], + "bucket": record["_bkt"], + "serial": record["_serial"], + "timestamp": record["_indextime"], + } + ) + except Exception as e: #pylint: disable = W0718 + print(f"Error on including Splunk record query in results array: {e}") + + return res_array + + async def _stream_results(self, oneshotsearch_results): + for record in results.JSONResultsReader(oneshotsearch_results): + yield record + + async def close(self): + """Closes splunk client connections""" + await self.service.logout()