WWWWWW

Current Directory: /opt/saltstack/salt/lib/python3.10/site-packages/salt/states
Viewing File: /opt/saltstack/salt/lib/python3.10/site-packages/salt/states/telemetry_alert.py
"""
Manage Telemetry alert configurations
=====================================

.. versionadded:: 2016.3.0

Create, Update and destroy Mongo Telemetry alert configurations.

This module uses requests, which can be installed via package, or pip.

This module accepts explicit credential (telemetry api key)
or can also read api key credentials from a pillar.
Example:

.. code-block:: yaml

    ensure telemetry alert X is defined on deployment Y:
        telemetry_alert.present:
            - deployment_id: "rs-XXXXXX"
            - metric_name: "testMetric"
            - alert_config:
               max: 1
               filter:  SERVER_ROLE_MONGOD_PRIMARY
               escalate_to: "example@pagerduty.com"
            - name: "**MANAGED BY ORCA DO NOT EDIT BY HAND** manages alarm on testMetric"
"""


def __virtual__():
    # Only load if telemetry is available.
    if "telemetry.get_alert_config" in __salt__:
        return "telemetry_alert"
    return (False, "telemetry module could not be loaded")


def present(
    name, deployment_id, metric_name, alert_config, api_key=None, profile="telemetry"
):
    """
    Ensure the telemetry alert exists.

    name
        An optional description of the alarm (not currently supported by telemetry API)

    deployment_id
        Specifies the ID of the root deployment resource
        (replica set cluster or sharded cluster) to which this alert definition is attached

    metric_name
        Specifies the unique ID of the metric to whose values these thresholds will be applied

    alert_config: Is a list of dictionaries where each dict contains the following fields:
        filter
            By default the alert will apply to the deployment and all its constituent resources.
            If the alert only applies to a subset of those resources, a filter may be specified to narrow this scope.

        min
            the smallest "ok" value the metric may take on; if missing or null, no minimum is enforced.

        max
            the largest "ok" value the metric may take on; if missing or null, no maximum is enforced.

        notify_all
            Used to indicate if you want to alert both onCallEngineer and apiNotifications

    api_key
        Telemetry api key for the user

    profile
        A dict of telemetry config information.  If present, will be used instead of
        api_key.

    """

    ret = {"name": metric_name, "result": True, "comment": "", "changes": {}}

    saved_alert_config = __salt__["telemetry.get_alert_config"](
        deployment_id, metric_name, api_key, profile
    )

    post_body = {
        "deployment": deployment_id,
        "filter": alert_config.get("filter"),
        "notificationChannel": __salt__["telemetry.get_notification_channel_id"](
            alert_config.get("escalate_to")
        ).split(),
        "condition": {
            "metric": metric_name,
            "max": alert_config.get("max"),
            "min": alert_config.get("min"),
        },
    }
    # Diff the alert config with the passed-in attributes
    difference = []
    if saved_alert_config:
        # del saved_alert_config["_id"]
        for k, v in post_body.items():
            if k not in saved_alert_config:
                difference.append(f"{k}={v} (new)")
                continue
            v2 = saved_alert_config[k]

            if v == v2:
                continue
            if isinstance(v, str) and v == str(v2):
                continue
            if isinstance(v, float) and v == float(v2):
                continue
            if isinstance(v, int) and v == int(v2):
                continue
            difference.append(f"{k}='{v}' was: '{v2}'")
    else:
        difference.append("new alert config")

    create_or_update_args = (
        deployment_id,
        metric_name,
        alert_config,
        api_key,
        profile,
    )
    if saved_alert_config:  # alert config is present.  update, or do nothing
        # check to see if attributes matches is_present. If so, do nothing.
        if len(difference) == 0:
            ret["comment"] = f"alert config {metric_name} present and matching"
            return ret
        if __opts__["test"]:
            msg = f"alert config {metric_name} is to be updated."
            ret["comment"] = msg
            ret["result"] = "\n".join(difference)
            return ret

        result, msg = __salt__["telemetry.update_alarm"](*create_or_update_args)

        if result:
            ret["changes"]["diff"] = difference
            ret["comment"] = "Alert updated."
        else:
            ret["result"] = False
            ret["comment"] = "Failed to update {} alert config: {}".format(
                metric_name, msg
            )
    else:  # alert config is absent. create it.
        if __opts__["test"]:
            msg = f"alert config {metric_name} is to be created."
            ret["comment"] = msg
            ret["result"] = None
            return ret

        result, msg = __salt__["telemetry.create_alarm"](*create_or_update_args)

        if result:
            ret["changes"]["new"] = msg
        else:
            ret["result"] = False
            ret["comment"] = "Failed to create {} alert config: {}".format(
                metric_name, msg
            )

    return ret


def absent(name, deployment_id, metric_name, api_key=None, profile="telemetry"):
    """
    Ensure the telemetry alert config is deleted

    name
        An optional description of the alarms (not currently supported by telemetry API)

    deployment_id
        Specifies the ID of the root deployment resource
        (replica set cluster or sharded cluster) to which this alert definition is attached

    metric_name
        Specifies the unique ID of the metric to whose values these thresholds will be applied

    api_key
        Telemetry api key for the user

    profile
        A dict with telemetry config data. If present, will be used instead of
        api_key.
    """
    ret = {"name": metric_name, "result": True, "comment": "", "changes": {}}

    is_present = __salt__["telemetry.get_alert_config"](
        deployment_id, metric_name, api_key, profile
    )

    if is_present:
        alert_id = is_present.get("_id")
        if __opts__["test"]:
            ret["comment"] = (
                "alert {} is set to be removed from deployment: {}.".format(
                    metric_name, deployment_id
                )
            )
            ret["result"] = None
            return ret
        deleted, msg = __salt__["telemetry.delete_alarms"](
            deployment_id,
            alert_id,
            is_present.get("condition", {}).get("metric"),
            api_key,
            profile,
        )

        if deleted:
            ret["changes"]["old"] = metric_name
            ret["changes"]["new"] = None
        else:
            ret["result"] = False
            ret["comment"] = "Failed to delete alert {} from deployment: {}".format(
                metric_name, msg
            )
    else:
        ret["comment"] = "alarm on {} does not exist within {}.".format(
            metric_name, deployment_id
        )
    return ret
F1l3 Manager
