aboutsummaryrefslogtreecommitdiffstats
path: root/src/onapsdk/ves/ves.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/onapsdk/ves/ves.py')
-rw-r--r--src/onapsdk/ves/ves.py84
1 files changed, 84 insertions, 0 deletions
diff --git a/src/onapsdk/ves/ves.py b/src/onapsdk/ves/ves.py
new file mode 100644
index 0000000..1f3f592
--- /dev/null
+++ b/src/onapsdk/ves/ves.py
@@ -0,0 +1,84 @@
+"""Base VES event sender."""
+# Copyright 2022 Orange, Deutsche Telekom AG, Nokia
+#
+# Licensed 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 typing import Dict, Union
+
+import json
+import requests
+
+from onapsdk.ves.ves_service import VesService
+
+ACTION = "Send event to Ves"
+POST_HTTP_METHOD = "POST"
+
+
+class Ves(VesService):
+ """Ves library provides functions for sending events to VES."""
+
+ event_endpoint_url: str = "{}/eventListener/{}"
+ event_batch_endpoint_url: str = "{}/eventListener/{}/eventBatch"
+
+ @classmethod
+ def send_event(cls,
+ version: str,
+ json_event: str,
+ basic_auth: Dict[str, str]) -> Union[requests.Response, None]:
+ """
+ Send an event stored in a file to VES.
+
+ Args:
+ version: (str) version of VES data format
+ json_event: (str) event to send
+ basic_auth: Dict[str, str], for example:{ 'username': 'bob', 'password': 'secret' }
+ Returns:
+ (requests.Response) HTTP response status
+
+ """
+ return Ves.__send_event_message(cls.event_endpoint_url.format(VesService._url, version),
+ json_event, basic_auth)
+
+ @classmethod
+ def send_batch_event(cls,
+ version: str,
+ json_event: str,
+ basic_auth: Dict[str, str]) -> Union[requests.Response, None]:
+ """
+ Send a batch event stored in a file to VES.
+
+ Args:
+ version: (str) version of VES data format
+ json_event: (str) event to send
+ basic_auth: Dict[str, str], for example:{ 'username': 'bob', 'password': 'secret' }
+ Returns:
+ (requests.Response) HTTP response status
+
+ """
+ return Ves.__send_event_message(cls.event_batch_endpoint_url.
+ format(VesService._url, version),
+ json_event, basic_auth)
+
+ @classmethod
+ def __send_event_message(cls,
+ base_url: str,
+ json_event: str,
+ basic_auth: Dict[str, str]
+ ) -> Union[requests.Response, None]:
+ cls._logger.debug("Event to send %s", json_event)
+ return cls.send_message(
+ POST_HTTP_METHOD,
+ ACTION,
+ f"{base_url}",
+ basic_auth=basic_auth,
+ json=json.loads(json_event)
+ )