Alerting Plugins

opensearchpy/client/__init__.py

@@ -37,6 +37,7 @@
 from .indices import IndicesClient
 from .ingest import IngestClient
 from .nodes import NodesClient
+from .plugins import PluginsClient
 from .remote import RemoteClient
 from .snapshot import SnapshotClient
 from .tasks import TasksClient
@@ -200,6 +201,8 @@ class as kwargs, or a string in the format of ``host[:port]`` which will be
 
         self.features = FeaturesClient(self)
 
+        self.plugins = PluginsClient(self)
+
     def __repr__(self):
         try:
             # get a list of all connections

opensearchpy/client/plugins.py

@@ -0,0 +1,26 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+# Copyright OpenSearch Contributors
+# SPDX-License-Identifier: Apache-2.0
+
+from ..plugins.alerting import AlertingClient
+from .utils import NamespacedClient
+
+
+class PluginsClient(NamespacedClient):
+    def __init__(self, client):
+        super(PluginsClient, self).__init__(client)
+        # self.query_workbench = QueryWorkbenchClient(client)
+        # self.reporting = ReportingClient(client)
+        # self.notebooks = NotebooksClient(client)
+        self.alerting = AlertingClient(client)
+        # self.anomaly_detection = AnomalyDetectionClient(client)
+        # self.trace_analytics = TraceAnalyticsClient(client)
+        # self.index_management = IndexManagementClient(client)
+        # self.security = SecurityClient(client)

opensearchpy/client/plugins.pyi

@@ -0,0 +1,17 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+from typing import Any
+
+from ..client import OpenSearch
+from ..plugins.alerting import AlertingClient as AlertingClient
+from .utils import NamespacedClient as NamespacedClient
+
+class PluginsClient(NamespacedClient):
+    alerting: Any
+    def __init__(self, client: OpenSearch) -> None: ...

opensearchpy/plugins/__init__.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.

opensearchpy/plugins/__init__.pyi

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.

opensearchpy/plugins/alerting.py

@@ -0,0 +1,200 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+# Copyright OpenSearch Contributors
+# SPDX-License-Identifier: Apache-2.0
+
+from ..client.utils import NamespacedClient, _make_path, query_params
+
+
+class AlertingClient(NamespacedClient):
+    @query_params()
+    def search_monitor(self, body, params=None, headers=None):
+        """
+        Returns the search result for a monitor.
+
+        :arg monitor_id: The configuration for the monitor we are trying to search
+        """
+        return self.transport.perform_request(
+            "GET",
+            _make_path("_plugins", "_alerting", "monitors", "_search"),
+            params=params,
+            headers=headers,
+            body=body,
+        )
+
+    @query_params()
+    def get_monitor(self, monitor_id, params=None, headers=None):
+        """
+        Returns the details of a specific monitor.
+
+        :arg monitor_id: The id of the monitor we are trying to fetch
+        """
+        return self.transport.perform_request(
+            "GET",
+            _make_path("_plugins", "_alerting", "monitors", monitor_id),
+            params=params,
+            headers=headers,
+        )
+
+    @query_params("dryrun")
+    def run_monitor(self, monitor_id, params=None, headers=None):
+        """
+        Runs/Executes a specific monitor.
+
+        :arg monitor_id: The id of the monitor we are trying to execute
+        :arg dryrun: Shows the results of a run without actions sending any message
+        """
+        return self.transport.perform_request(
+            "POST",
+            _make_path("_plugins", "_alerting", "monitors", monitor_id, "_execute"),
+            params=params,
+            headers=headers,
+        )
+
+    @query_params()
+    def create_monitor(self, body=None, params=None, headers=None):
+        """
+        Creates a monitor with inputs, triggers, and actions.
+
+        :arg body: The configuration for the monitor (`inputs`, `triggers`, and `actions`)
+        """
+        return self.transport.perform_request(
+            "POST",
+            _make_path("_plugins", "_alerting", "monitors"),
+            params=params,
+            headers=headers,
+            body=body,
+        )
+
+    @query_params()
+    def update_monitor(self, monitor_id, body=None, params=None, headers=None):
+        """
+        Updates a monitor's inputs, triggers, and actions.
+
+        :arg monitor_id: The id of the monitor we are trying to update
+        :arg body: The configuration for the monitor (`inputs`, `triggers`, and `actions`)
+        """
+        return self.transport.perform_request(
+            "PUT",
+            _make_path("_plugins", "_alerting", "monitors", monitor_id),
+            params=params,
+            headers=headers,
+            body=body,
+        )
+
+    @query_params()
+    def delete_monitor(self, monitor_id, params=None, headers=None):
+        """
+        Deletes a specific monitor.
+
+        :arg monitor_id: The id of the monitor we are trying to delete
+        """
+        return self.transport.perform_request(
+            "DELETE",
+            _make_path("_plugins", "_alerting", "monitors", monitor_id),
+            params=params,
+            headers=headers,
+        )
+
+    @query_params()
+    def get_destination(self, destination_id=None, params=None, headers=None):
+        """
+        Returns the details of a specific destination.
+
+        :arg destination_id: The id of the destination we are trying to fetch. If None, returns all destinations
+        """
+        return self.transport.perform_request(
+            "GET",
+            _make_path("_plugins", "_alerting", "destinations", destination_id)
+            if destination_id
+            else _make_path("_plugins", "_alerting", "destinations"),
+            params=params,
+            headers=headers,
+        )
+
+    @query_params()
+    def create_destination(self, body=None, params=None, headers=None):
+        """
+        Creates a destination for slack, mail, or custom-webhook.
+
+        :arg body: The configuration for the destination
+        """
+        return self.transport.perform_request(
+            "POST",
+            _make_path("_plugins", "_alerting", "destinations"),
+            params=params,
+            headers=headers,
+            body=body,
+        )
+
+    @query_params()
+    def update_destination(self, destination_id, body=None, params=None, headers=None):
+        """
+        Updates a destination's inputs, triggers, and actions.
+
+        :arg destination_id: The id of the destination we are trying to update
+        :arg body: The configuration for the destination
+        """
+        return self.transport.perform_request(
+            "PUT",
+            _make_path("_plugins", "_alerting", "destinations", destination_id),
+            params=params,
+            headers=headers,
+            body=body,
+        )
+
+    @query_params()
+    def delete_destination(self, destination_id, params=None, headers=None):
+        """
+        Deletes a specific destination.
+
+        :arg destination_id: The id of the destination we are trying to delete
+        """
+        return self.transport.perform_request(
+            "DELETE",
+            _make_path("_plugins", "_alerting", "destinations", destination_id),
+            params=params,
+            headers=headers,
+        )
+
+    @query_params()
+    def get_alerts(self, params=None, headers=None):
+        """
+        Returns all alerts.
+
+        """
+        return self.transport.perform_request(
+            "GET",
+            _make_path("_plugins", "_alerting", "monitors", "alerts"),
+            params=params,
+            headers=headers,
+        )
+
+    @query_params()
+    def acknowledge_alert(self, monitor_id, body=None, params=None, headers=None):
+        """
+        Acknowledges an alert.
+
+        :arg monitor_id: The id of the monitor, the alert belongs to
+        :arg body: The alerts to be acknowledged
+        """
+        return self.transport.perform_request(
+            "POST",
+            _make_path(
+                "_plugins",
+                "_alerting",
+                "monitors",
+                monitor_id,
+                "_acknowledge",
+                "alerts",
+            ),
+            params=params,
+            headers=headers,
+            body=body,
+        )

opensearchpy/plugins/alerting.pyi

@@ -0,0 +1,71 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+from typing import Any, Union
+
+from ..client.utils import NamespacedClient as NamespacedClient
+from ..client.utils import query_params as query_params
+
+class AlertingClient(NamespacedClient):
+    def search_monitor(
+        self, body: Any, params: Any | None = ..., headers: Any | None = ...
+    ) -> Union[bool, Any]: ...
+    def get_monitor(
+        self, monitor_id: Any, params: Any | None = ..., headers: Any | None = ...
+    ) -> Union[bool, Any]: ...
+    def run_monitor(
+        self, monitor_id: Any, params: Any | None = ..., headers: Any | None = ...
+    ) -> Union[bool, Any]: ...
+    def create_monitor(
+        self,
+        body: Any | None = ...,
+        params: Any | None = ...,
+        headers: Any | None = ...,
+    ) -> Union[bool, Any]: ...
+    def update_monitor(
+        self,
+        monitor_id: Any,
+        body: Any | None = ...,
+        params: Any | None = ...,
+        headers: Any | None = ...,
+    ) -> Union[bool, Any]: ...
+    def delete_monitor(
+        self, monitor_id: Any, params: Any | None = ..., headers: Any | None = ...
+    ) -> Union[bool, Any]: ...
+    def get_destination(
+        self,
+        destination_id: Any | None = ...,
+        params: Any | None = ...,
+        headers: Any | None = ...,
+    ) -> Union[bool, Any]: ...
+    def create_destination(
+        self,
+        body: Any | None = ...,
+        params: Any | None = ...,
+        headers: Any | None = ...,
+    ) -> Union[bool, Any]: ...
+    def update_destination(
+        self,
+        destination_id: Any,
+        body: Any | None = ...,
+        params: Any | None = ...,
+        headers: Any | None = ...,
+    ) -> Union[bool, Any]: ...
+    def delete_destination(
+        self, destination_id: Any, params: Any | None = ..., headers: Any | None = ...
+    ) -> Union[bool, Any]: ...
+    def get_alerts(
+        self, params: Any | None = ..., headers: Any | None = ...
+    ) -> Union[bool, Any]: ...
+    def acknowledge_alert(
+        self,
+        monitor_id: Any,
+        body: Any | None = ...,
+        params: Any | None = ...,
+        headers: Any | None = ...,
+    ) -> Union[bool, Any]: ...

out/opensearchpy/client/plugins.pyi

@@ -0,0 +1,7 @@
+from ..plugins.alerting import AlertingClient as AlertingClient
+from .utils import NamespacedClient as NamespacedClient
+from typing import Any
+
+class PluginsClient(NamespacedClient):
+    alerting: Any
+    def __init__(self, client) -> None: ...

out/opensearchpy/plugins/alerting.pyi

@@ -0,0 +1,16 @@
+from ..client.utils import NamespacedClient as NamespacedClient, query_params as query_params
+from typing import Any, Union
+
+class AlertingClient(NamespacedClient):
+    def search_monitor(self, body, params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...
+    def get_monitor(self, monitor_id, params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...
+    def run_monitor(self, monitor_id, params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...
+    def create_monitor(self, body: Any | None = ..., params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...
+    def update_monitor(self, monitor_id, body: Any | None = ..., params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...
+    def delete_monitor(self, monitor_id, params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...
+    def get_destination(self, destination_id: Any | None = ..., params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...
+    def create_destination(self, body: Any | None = ..., params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...
+    def update_destination(self, destination_id, body: Any | None = ..., params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...
+    def delete_destination(self, destination_id, params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...
+    def get_alerts(self, params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...
+    def acknowledge_alert(self, monitor_id, body: Any | None = ..., params: Any | None = ..., headers: Any | None = ...) -> Union[bool, Any]: ...