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

"""
Return data to a mongodb server

Required python modules: pymongo

This returner will send data from the minions to a MongoDB server. To
configure the settings for your MongoDB server, add the following lines
to the minion config files.

.. code-block:: yaml

mongo.db: <database name>
    mongo.host: <server ip address>
    mongo.user: <MongoDB username>
    mongo.password: <MongoDB user password>
    mongo.port: 27017

Alternative configuration values can be used by prefacing the configuration.
Any values not found in the alternative configuration will be pulled from
the default location.

.. code-block:: yaml

alternative.mongo.db: <database name>
    alternative.mongo.host: <server ip address>
    alternative.mongo.user: <MongoDB username>
    alternative.mongo.password: <MongoDB user password>
    alternative.mongo.port: 27017

To use the mongo returner, append '--return mongo' to the salt command.

.. code-block:: bash

salt '*' test.ping --return mongo_return

To use the alternative configuration, append '--return_config alternative' to the salt command.

.. versionadded:: 2015.5.0

.. code-block:: bash

salt '*' test.ping --return mongo_return --return_config alternative

To override individual configuration items, append --return_kwargs '{"key:": "value"}' to the salt command.

.. versionadded:: 2016.3.0

.. code-block:: bash

salt '*' test.ping --return mongo --return_kwargs '{"db": "another-salt"}'

To override individual configuration items, append --return_kwargs '{"key:": "value"}' to the salt command.

.. versionadded:: 2016.3.0

.. code-block:: bash

salt '*' test.ping --return mongo --return_kwargs '{"db": "another-salt"}'

"""

import logging

import salt.returners
import salt.utils.jid
from salt.utils.versions import LooseVersion as _LooseVersion

try:
    import pymongo

PYMONGO_VERSION = _LooseVersion(pymongo.version)
    HAS_PYMONGO = True
except ImportError:
    HAS_PYMONGO = False

log = logging.getLogger(__name__)

# Define the module's virtual name
# currently only used iby _get_options
__virtualname__ = "mongo"

def __virtual__():
    if not HAS_PYMONGO:
        return False, "Could not import mongo returner; pymongo is not installed."
    return "mongo_return"

def _remove_dots(src):
    """
    Remove dots from the given data structure
    """
    output = {}
    for key, val in src.items():
        if isinstance(val, dict):
            val = _remove_dots(val)
        output[key.replace(".", "-")] = val
    return output

def _get_options(ret):
    """
    Get the monogo_return options from salt.
    """
    attrs = {
        "host": "host",
        "port": "port",
        "db": "db",
        "user": "user",
        "password": "password",
        "indexes": "indexes",
    }

_options = salt.returners.get_returner_options(
        __virtualname__, ret, attrs, __salt__=__salt__, __opts__=__opts__
    )
    return _options

def _get_conn(ret):
    """
    Return a mongodb connection object
    """
    _options = _get_options(ret)

host = _options.get("host")
    port = _options.get("port")
    db_ = _options.get("db")
    user = _options.get("user")
    password = _options.get("password")
    indexes = _options.get("indexes", False)

# at some point we should remove support for
    # pymongo versions < 2.3 until then there are
    # a bunch of these sections that need to be supported

if PYMONGO_VERSION > _LooseVersion("2.3"):
        conn = pymongo.MongoClient(host, port)
    else:
        conn = pymongo.Connection(host, port)
    mdb = conn[db_]

if user and password:
        mdb.authenticate(user, password)

if indexes:
        if PYMONGO_VERSION > _LooseVersion("2.3"):
            mdb.saltReturns.create_index("minion")
            mdb.saltReturns.create_index("jid")

mdb.jobs.create_index("jid")
        else:
            mdb.saltReturns.ensure_index("minion")
            mdb.saltReturns.ensure_index("jid")

mdb.jobs.ensure_index("jid")

return conn, mdb

def returner(ret):
    """
    Return data to a mongodb server
    """
    conn, mdb = _get_conn(ret)
    col = mdb[ret["id"]]

if isinstance(ret["return"], dict):
        back = _remove_dots(ret["return"])
    else:
        back = ret["return"]

if isinstance(ret, dict):
        full_ret = _remove_dots(ret)
    else:
        full_ret = ret

log.debug(back)
    sdata = {
        "minion": ret["id"],
        "jid": ret["jid"],
        "return": back,
        "fun": ret["fun"],
        "full_ret": full_ret,
    }
    if "out" in ret:
        sdata["out"] = ret["out"]

# save returns in the saltReturns collection in the json format:
    # { 'minion': <minion_name>, 'jid': <job_id>, 'return': <return info with dots removed>,
    #  'fun': <function>, 'full_ret': <unformatted return with dots removed>}

# again we run into the issue with deprecated code from previous versions

if PYMONGO_VERSION > _LooseVersion("2.3"):
        # using .copy() to ensure original data for load is unchanged
        mdb.saltReturns.insert_one(sdata.copy())
    else:
        mdb.saltReturns.insert(sdata.copy())

def get_jid(jid):
    """
    Return the return information associated with a jid
    """
    conn, mdb = _get_conn(ret=None)
    ret = {}
    rdata = mdb.saltReturns.find({"jid": jid}, {"_id": 0})
    if rdata:
        for data in rdata:
            minion = data["minion"]
            # return data in the format {<minion>: { <unformatted full return data>}}
            ret[minion] = data["full_ret"]
    return ret

def get_fun(fun):
    """
    Return the most recent jobs that have executed the named function
    """
    conn, mdb = _get_conn(ret=None)
    ret = {}
    rdata = mdb.saltReturns.find_one({"fun": fun}, {"_id": 0})
    if rdata:
        ret = rdata
    return ret

def prep_jid(nocache=False, passed_jid=None):  # pylint: disable=unused-argument
    """
    Do any work necessary to prepare a JID, including sending a custom id
    """
    return passed_jid if passed_jid is not None else salt.utils.jid.gen_jid(__opts__)

def save_minions(jid, minions, syndic_id=None):  # pylint: disable=unused-argument
    """
    Included for API consistency
    """