1#@!#!123s

: / opt / saltstack / salt / lib / python3.10 / site-packages / salt / states /
Filename : serverdensity_device.py
back
"""
Monitor Server with Server Density
==================================

.. versionadded:: 2014.7.0

`Server Density <https://www.serverdensity.com/>`_
Is a hosted monitoring service.

.. warning::

    This state module is beta. It might be changed later to include more or
    less automation.

.. note::

    This state module requires a pillar for authentication with Server Density
    To install a v1 agent:

    .. code-block:: yaml

        serverdensity:
          api_token: "b97da80a41c4f61bff05975ee51eb1aa"
          account_url: "https://your-account.serverdensity.io"

    To install a v2 agent:

    .. code-block:: yaml

        serverdensity:
          api_token: "b97da80a41c4f61bff05975ee51eb1aa"
          account_name: "your-account"

.. note::

    Although Server Density allows duplicate device names in its database, this
    module will raise an exception if you try monitoring devices with the same
    name.


Example:

.. code-block:: yaml

    'server_name':
      serverdensity_device.monitored
"""


import logging

import salt.utils.json

# TODO:
#
#  Add a plugin support
#  Add notification support


log = logging.getLogger(__name__)


def _get_salt_params():
    """
    Try to get all sort of parameters for Server Density server info.

    NOTE: Missing publicDNS and publicIPs parameters. There might be way of
    getting them with salt-cloud.
    """
    all_stats = __salt__["status.all_status"]()
    all_grains = __salt__["grains.items"]()
    params = {}
    try:
        params["name"] = all_grains["id"]
        params["hostname"] = all_grains["host"]
        if all_grains["kernel"] == "Darwin":
            sd_os = {"code": "mac", "name": "Mac"}
        else:
            sd_os = {"code": all_grains["kernel"].lower(), "name": all_grains["kernel"]}
        params["os"] = salt.utils.json.dumps(sd_os)
        params["cpuCores"] = all_stats["cpuinfo"]["cpu cores"]
        params["installedRAM"] = str(
            int(all_stats["meminfo"]["MemTotal"]["value"]) / 1024
        )
        params["swapSpace"] = str(
            int(all_stats["meminfo"]["SwapTotal"]["value"]) / 1024
        )
        params["privateIPs"] = salt.utils.json.dumps(all_grains["fqdn_ip4"])
        params["privateDNS"] = salt.utils.json.dumps(all_grains["fqdn"])
    except KeyError:
        pass

    return params


def monitored(
    name, group=None, salt_name=True, salt_params=True, agent_version=1, **params
):
    """
    Device is monitored with Server Density.

    name
        Device name in Server Density.

    salt_name
        If ``True`` (default), takes the name from the ``id`` grain. If
        ``False``, the provided name is used.

    group
        Group name under with device will appear in Server Density dashboard.
        Default - `None`.

    agent_version
        The agent version you want to use. Valid values are 1 or 2.
        Default - 1.

    salt_params
        If ``True`` (default), needed config parameters will be sourced from
        grains and from :mod:`status.all_status
        <salt.modules.status.all_status>`.

    params
        Add parameters that you want to appear in the Server Density dashboard.
        Will overwrite the `salt_params` parameters. For more info, see the
        `API docs`__.

    .. __: https://apidocs.serverdensity.com/Inventory/Devices/Creating

    Usage example:

    .. code-block:: yaml

        'server_name':
          serverdensity_device.monitored

    .. code-block:: yaml

        'server_name':
          serverdensity_device.monitored:
            - group: web-servers

    .. code-block:: yaml

        'my_special_server':
          serverdensity_device.monitored:
            - salt_name: False
            - group: web-servers
            - cpuCores: 2
            - os: '{"code": "linux", "name": "Linux"}'
    """
    ret = {"name": name, "changes": {}, "result": None, "comment": ""}
    params_from_salt = _get_salt_params()

    if salt_name:
        name = params_from_salt.pop("name")
        ret["name"] = name
    else:
        params_from_salt.pop("name")

    if group:
        params["group"] = group

    if agent_version != 2:
        # Anything different from 2 will fallback into the v1.
        agent_version = 1

    # override salt_params with given params
    if salt_params:
        for key, value in params.items():
            params_from_salt[key] = value
        params_to_use = params_from_salt
    else:
        params_to_use = params

    device_in_sd = True if __salt__["serverdensity_device.ls"](name=name) else False
    sd_agent_installed = True if "sd-agent" in __salt__["pkg.list_pkgs"]() else False

    if device_in_sd and sd_agent_installed:
        ret["result"] = True
        ret["comment"] = (
            "Such server name already exists in this Server Density account. And"
            " sd-agent is installed"
        )
        ret["changes"] = {}
        return ret

    if not device_in_sd:
        device = __salt__["serverdensity_device.create"](name, **params_from_salt)
        agent_key = device["agentKey"]
        ret["comment"] = "Device created in Server Density db."
        ret["changes"] = {"device_created": device}
        if __opts__["test"]:
            ret["result"] = None
            ret["comment"] = "Device set to be created in Server Density db."
            return ret
    elif device_in_sd:
        device = __salt__["serverdensity_device.ls"](name=name)[0]
        agent_key = device["agentKey"]
        ret["comment"] = "Device was already in Server Density db."
    else:
        ret["result"] = False
        ret["comment"] = (
            "Failed to create device in Server Density DB and this device does not"
            " exist in db either."
        )
        ret["changes"] = {}
        if __opts__["test"]:
            ret["result"] = None
            ret[
                "comment"
            ] = "Agent is not installed and device is not in the Server Density DB"
        return ret

    if __opts__["test"]:
        ret["result"] = None
        ret["comment"] = (
            "Server Density agent is set to be installed and device created in the"
            " Server Density DB"
        )
        return ret

    installed_agent = __salt__["serverdensity_device.install_agent"](
        agent_key, agent_version
    )

    ret["result"] = True
    ret[
        "comment"
    ] = "Successfully installed agent and created device in Server Density db."
    ret["changes"] = {"created_device": device, "installed_agent": installed_agent}
    return ret