Gecko [ goons4good.org ]

Name	Size	Permission	Date
__pycache__	[ DIR ]	drwxr-xr-x	2022-10-11 05:09
__init__.py	5.98 KB	-rw-r--r--	2022-05-16 09:16
appoptics_return.py	6.11 KB	-rw-r--r--	2022-05-16 09:16
carbon_return.py	8.24 KB	-rw-r--r--	2022-05-16 09:16
cassandra_cql_return.py	15.17 KB	-rw-r--r--	2022-05-16 09:16
cassandra_return.py	2.07 KB	-rw-r--r--	2022-05-16 09:16
couchbase_return.py	8.91 KB	-rw-r--r--	2022-05-16 09:16
couchdb_return.py	10.35 KB	-rw-r--r--	2022-05-16 09:16
django_return.py	2.27 KB	-rw-r--r--	2022-05-16 09:16
elasticsearch_return.py	12.18 KB	-rw-r--r--	2022-05-16 09:16
etcd_return.py	6.32 KB	-rw-r--r--	2022-05-16 09:16
highstate_return.py	15.59 KB	-rw-r--r--	2022-05-16 09:16
influxdb_return.py	8.03 KB	-rw-r--r--	2022-05-16 09:16
kafka_return.py	2.12 KB	-rw-r--r--	2022-05-16 09:16
librato_return.py	4.29 KB	-rw-r--r--	2022-05-16 09:16
local.py	541 B	-rw-r--r--	2022-05-16 09:16
local_cache.py	17.1 KB	-rw-r--r--	2022-05-16 09:16
mattermost_returner.py	4.08 KB	-rw-r--r--	2022-05-16 09:16
memcache_return.py	5.72 KB	-rw-r--r--	2022-05-16 09:16
mongo_future_return.py	10.08 KB	-rw-r--r--	2022-05-16 09:16
mongo_return.py	6.11 KB	-rw-r--r--	2022-05-16 09:16
multi_returner.py	2.82 KB	-rw-r--r--	2022-05-16 09:16
mysql.py	18.61 KB	-rw-r--r--	2022-05-16 09:16
nagios_nrdp_return.py	4.92 KB	-rw-r--r--	2022-05-16 09:16
odbc.py	7.77 KB	-rw-r--r--	2022-05-16 09:16
pgjsonb.py	17.18 KB	-rw-r--r--	2022-05-16 09:16
postgres.py	10.2 KB	-rw-r--r--	2022-05-16 09:16
postgres_local_cache.py	10.73 KB	-rw-r--r--	2022-05-16 09:16
pushover_returner.py	6.55 KB	-rw-r--r--	2022-05-16 09:16
rawfile_json.py	2.23 KB	-rw-r--r--	2022-05-16 09:16
redis_return.py	8.52 KB	-rw-r--r--	2022-05-16 09:16
sentry_return.py	5.3 KB	-rw-r--r--	2022-05-16 09:16
slack_returner.py	6.02 KB	-rw-r--r--	2022-05-16 09:16
slack_webhook_return.py	11.22 KB	-rw-r--r--	2022-05-16 09:16
sms_return.py	2.64 KB	-rw-r--r--	2022-05-16 09:16
smtp_return.py	8.2 KB	-rw-r--r--	2022-05-16 09:16
splunk.py	6.69 KB	-rw-r--r--	2022-05-16 09:16
sqlite3_return.py	7.73 KB	-rw-r--r--	2022-05-16 09:16
syslog_return.py	5.26 KB	-rw-r--r--	2022-05-16 09:16
telegram_return.py	1.92 KB	-rw-r--r--	2022-05-16 09:16
xmpp_return.py	4.85 KB	-rw-r--r--	2022-05-16 09:16
zabbix_return.py	2.45 KB	-rw-r--r--	2022-05-16 09:16

Rename

"""

Send json response data to Splunk via the HTTP Event Collector
Requires the following config values to be specified in config or pillar:

.. code-block:: yaml

splunk_http_forwarder:
      token: <splunk_http_forwarder_token>
      indexer: <hostname/IP of Splunk indexer>
      sourcetype: <Destination sourcetype for data>
      index: <Destination index for data>
      verify_ssl: true

Run a test by using ``salt-call test.ping --return splunk``

Written by Scott Pack (github.com/scottjpack)

"""

import logging
import socket
import time

import requests
import salt.utils.json

_max_content_bytes = 100000
http_event_collector_debug = False

log = logging.getLogger(__name__)

__virtualname__ = "splunk"

def __virtual__():
    """
    Return virtual name of the module.
    :return: The virtual name of the module.
    """
    return __virtualname__

def returner(ret):
    """
    Send a message to Splunk via the HTTP Event Collector
    """
    return _send_splunk(ret)

def _get_options():
    try:
        token = __salt__["config.get"]("splunk_http_forwarder:token")
        indexer = __salt__["config.get"]("splunk_http_forwarder:indexer")
        sourcetype = __salt__["config.get"]("splunk_http_forwarder:sourcetype")
        index = __salt__["config.get"]("splunk_http_forwarder:index")
        verify_ssl = __salt__["config.get"](
            "splunk_http_forwarder:verify_ssl", default=True
        )
    except Exception:  # pylint: disable=broad-except
        log.error("Splunk HTTP Forwarder parameters not present in config.")
        return None
    splunk_opts = {
        "token": token,
        "indexer": indexer,
        "sourcetype": sourcetype,
        "index": index,
        "verify_ssl": verify_ssl,
    }
    return splunk_opts

def _send_splunk(event, index_override=None, sourcetype_override=None):
    """
    Send the results to Splunk.
    Requires the Splunk HTTP Event Collector running on port 8088.
    This is available on Splunk Enterprise version 6.3 or higher.

"""
    # Get Splunk Options
    opts = _get_options()
    log.info(
        "Options: %s",
        salt.utils.json.dumps(opts),
    )
    http_event_collector_key = opts["token"]
    http_event_collector_host = opts["indexer"]
    http_event_collector_verify_ssl = opts["verify_ssl"]
    # Set up the collector
    splunk_event = http_event_collector(
        http_event_collector_key,
        http_event_collector_host,
        verify_ssl=http_event_collector_verify_ssl,
    )
    # init the payload
    payload = {}

# Set up the event metadata
    if index_override is None:
        payload.update({"index": opts["index"]})
    else:
        payload.update({"index": index_override})
    if sourcetype_override is None:
        payload.update({"sourcetype": opts["sourcetype"]})
    else:
        payload.update({"index": sourcetype_override})

# Add the event
    payload.update({"event": event})
    log.info(
        "Payload: %s",
        salt.utils.json.dumps(payload),
    )
    # Fire it off
    splunk_event.sendEvent(payload)
    return True

# Thanks to George Starcher for the http_event_collector class (https://github.com/georgestarcher/)

class http_event_collector:
    def __init__(
        self,
        token,
        http_event_server,
        host="",
        http_event_port="8088",
        http_event_server_ssl=True,
        max_bytes=_max_content_bytes,
        verify_ssl=True,
    ):
        self.token = token
        self.batchEvents = []
        self.maxByteLength = max_bytes
        self.currentByteLength = 0
        self.verify_ssl = verify_ssl

# Set host to specified value or default to localhostname if no value provided
        if host:
            self.host = host
        else:
            self.host = socket.gethostname()

# Build and set server_uri for http event collector
        # Defaults to SSL if flag not passed
        # Defaults to port 8088 if port not passed

if http_event_server_ssl:
            buildURI = ["https://"]
        else:
            buildURI = ["http://"]
        for i in [http_event_server, ":", http_event_port, "/services/collector/event"]:
            buildURI.append(i)
        self.server_uri = "".join(buildURI)

if http_event_collector_debug:
            log.debug(self.token)
            log.debug(self.server_uri)

def sendEvent(self, payload, eventtime=""):
        # Method to immediately send an event to the http event collector

headers = {"Authorization": "Splunk " + self.token}

# If eventtime in epoch not passed as optional argument use current system time in epoch
        if not eventtime:
            eventtime = str(int(time.time()))

# Fill in local hostname if not manually populated
        if "host" not in payload:
            payload.update({"host": self.host})

# Update time value on payload if need to use system time
        data = {"time": eventtime}
        data.update(payload)

# send event to http event collector
        r = requests.post(
            self.server_uri,
            data=salt.utils.json.dumps(data),
            headers=headers,
            verify=self.verify_ssl,
        )

# Print debug info if flag set
        if http_event_collector_debug:
            log.debug(r.text)
            log.debug(data)

def batchEvent(self, payload, eventtime=""):
        # Method to store the event in a batch to flush later

# Fill in local hostname if not manually populated
        if "host" not in payload:
            payload.update({"host": self.host})

serialized_payload = salt.utils.json.dumps(payload)
        payloadLength = len(serialized_payload)

if (self.currentByteLength + payloadLength) > self.maxByteLength:
            self.flushBatch()
            # Print debug info if flag set
            if http_event_collector_debug:
                log.debug("auto flushing")
        else:
            self.currentByteLength = self.currentByteLength + payloadLength

# If eventtime in epoch not passed as optional argument use current system time in epoch
        if not eventtime:
            eventtime = str(int(time.time()))

# Update time value on payload if need to use system time
        data = {"time": eventtime}
        data.update(payload)

self.batchEvents.append(serialized_payload)

def flushBatch(self):
        # Method to flush the batch list of events

if len(self.batchEvents) > 0:
            headers = {"Authorization": "Splunk " + self.token}
            r = requests.post(
                self.server_uri,
                data=" ".join(self.batchEvents),
                headers=headers,
                verify=self.verify_ssl,
            )
            self.batchEvents = []
            self.currentByteLength = 0