Alerting Plugins

.ci/run-repository.sh

@@ -34,6 +34,7 @@ docker run \
   --network=${network_name} \
   --env "STACK_VERSION=${STACK_VERSION}" \
   --env "OPENSEARCH_URL=${opensearch_url}" \
+  --env "OPENSEARCH_VERSION=${OPENSEARCH_VERSION}" \
   --env "TEST_SUITE=${TEST_SUITE}" \
   --env "PYTHON_CONNECTION_CLASS=${PYTHON_CONNECTION_CLASS}" \
   --env "TEST_TYPE=server" \

noxfile.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 import nox
 
 SOURCE_FILES = (

opensearchpy/__init__.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 # flake8: noqa
 from __future__ import absolute_import
 

opensearchpy/_async/_extra_imports.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 # type: ignore
 
 # This file exists for the sole reason of making mypy not

opensearchpy/_async/client/__init__.py

@@ -24,6 +24,24 @@
 #  KIND, either express or implied.  See the License for the
 #  specific language governing permissions and limitations
 #  under the License.
+#
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
 
 from __future__ import unicode_literals
 
@@ -37,6 +55,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
@@ -197,6 +216,7 @@ class as kwargs, or a string in the format of ``host[:port]`` which will be
         self.remote = RemoteClient(self)
         self.snapshot = SnapshotClient(self)
         self.tasks = TasksClient(self)
+        self.plugins = PluginsClient(self)
 
         self.features = FeaturesClient(self)
 

opensearchpy/_async/client/__init__.pyi

@@ -24,6 +24,23 @@
 #  KIND, either express or implied.  See the License for the
 #  specific language governing permissions and limitations
 #  under the License.
+#
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
 
 from __future__ import unicode_literals
 
@@ -60,7 +77,7 @@ class AsyncOpenSearch(object):
         self,
         hosts: Any = ...,
         transport_class: Type[AsyncTransport] = ...,
-        **kwargs: Any,
+        **kwargs: Any
     ) -> None: ...
     def __repr__(self) -> str: ...
     async def __aenter__(self) -> "AsyncOpenSearch": ...

opensearchpy/_async/client/cat.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 from .utils import NamespacedClient, _make_path, query_params
 
 

opensearchpy/_async/client/cluster.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
 
 

opensearchpy/_async/client/dangling_indices.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
 
 

opensearchpy/_async/client/features.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 from .utils import NamespacedClient, query_params
 
 

opensearchpy/_async/client/indices.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
 
 

opensearchpy/_async/client/ingest.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
 
 

opensearchpy/_async/client/nodes.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 from .utils import NamespacedClient, _make_path, query_params
 
 

opensearchpy/_async/client/plugins.py

@@ -0,0 +1,51 @@
+# 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.
+
+import warnings
+
+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)
+
+        self._dynamic_lookup(client)
+
+    def _dynamic_lookup(self, client):
+        # Issue : https://github.com/opensearch-project/opensearch-py/issues/90#issuecomment-1003396742
+
+        plugins = [
+            # "query_workbench",
+            # "reporting",
+            # "notebooks",
+            "alerting",
+            # "anomaly_detection",
+            # "trace_analytics",
+            # "index_management",
+            # "security"
+        ]
+        for plugin in plugins:
+            if not hasattr(client, plugin):
+                setattr(client, plugin, getattr(self, plugin))
+            else:
+                warnings.warn(
+                    f"Cannot load `{plugin}` directly to AsyncOpenSearch. `{plugin}` already exists in AsyncOpenSearch. Please use `AsyncOpenSearch.plugin.{plugin}` instead.",
+                    category=RuntimeWarning,
+                    stacklevel=2,
+                )

opensearchpy/_async/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 AsyncOpenSearch
+from ..plugins.alerting import AlertingClient as AlertingClient
+from .utils import NamespacedClient as NamespacedClient
+
+class PluginsClient(NamespacedClient):
+    alerting: Any
+    def __init__(self, client: AsyncOpenSearch) -> None: ...

opensearchpy/_async/client/remote.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 from .utils import NamespacedClient, query_params
 
 

opensearchpy/_async/client/snapshot.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
 
 

opensearchpy/_async/client/tasks.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 import warnings
 
 from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params

opensearchpy/_async/client/utils.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 from ...client.utils import (  # noqa
     SKIP_IN_PATH,
     NamespacedClient,

opensearchpy/_async/compat.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 import asyncio
 
 from ..compat import *  # noqa

opensearchpy/_async/helpers.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 # Licensed to Elasticsearch B.V.under one or more agreements.
 # Elasticsearch B.V.licenses this file to you under the Apache 2.0 License.
 # See the LICENSE file in the project root for more information
@@ -203,7 +204,7 @@ async def map_actions():
                         raise_on_error,
                         ignore_status,
                         *args,
-                        **kwargs,
+                        **kwargs
                     ),
                 ):
 
@@ -470,5 +471,5 @@ async def _change_doc_index(hits, index):
         target_client,
         _change_doc_index(docs, target_index),
         chunk_size=chunk_size,
-        **kwargs,
+        **kwargs
     )

opensearchpy/_async/http_aiohttp.py

@@ -24,6 +24,7 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
+
 import asyncio
 import os
 import ssl
@@ -97,7 +98,7 @@ def __init__(
         http_compress=None,
         opaque_id=None,
         loop=None,
-        **kwargs,
+        **kwargs
     ):
         """
         Default connection class for ``AsyncOpenSearch`` using the `aiohttp` library and the http protocol.
@@ -142,7 +143,7 @@ def __init__(
             headers=headers,
             http_compress=http_compress,
             opaque_id=opaque_id,
-            **kwargs,
+            **kwargs
         )
 
         if http_auth is not None:

opensearchpy/_async/http_aiohttp.pyi

@@ -64,5 +64,5 @@ class AIOHttpConnection(AsyncConnection):
         http_compress: Optional[bool] = ...,
         opaque_id: Optional[str] = ...,
         loop: Any = ...,
-        **kwargs: Any,
+        **kwargs: Any
     ) -> None: ...

opensearchpy/_async/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/_async/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.