brynq-sdk-elastic 2.0.0__tar.gz → 2.2.0__tar.gz

{brynq_sdk_elastic-2.0.0 → brynq_sdk_elastic-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq_sdk_elastic
-Version: 2.0.0
+Version: 2.2.0
 Summary: elastic wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_elastic-2.0.0 → brynq_sdk_elastic-2.2.0}/brynq_sdk/elastic/elastic.py

@@ -9,17 +9,33 @@ import os
 
 
 class Elastic:
-    def __init__(self, api_key: str = None, customer_name: str = None, space_name: str = None):
+    def __init__(self, api_key: str = None, customer_name: str = None, space_name: str = None, disabled: bool = False):
         """
         A package to create indexes, users, roles, getting data, etc.
         :param api_key: The api key to connect to elasticsearch if not provided in the .env file
         """
         try:
             self.verify = False
-            elasticsearch_host = os.getenv("ELASTIC_HOST", "localhost")
-            elasticsearch_port = os.getenv("ELASTIC_PORT", "9200")
-            kibana_port = os.getenv("KIBANA_PORT", "5601")
-            elastic_token = os.getenv('ELASTIC_API_KEY', None)
+            self.disabled = disabled
+            elasticsearch_host = os.getenv("ELASTIC_HOST")
+            elasticsearch_port = os.getenv("ELASTIC_PORT")
+            kibana_port = os.getenv("KIBANA_PORT")
+            elastic_token = os.getenv('ELASTIC_API_KEY', api_key)
+
+            if not self.disabled:
+                # Check for missing environment variables and show warnings
+                if elasticsearch_host is None:
+                    raise KeyError("Environment variable ELASTIC_HOST is not set. Please set it and try again")
+                if elasticsearch_port is None:
+                    elasticsearch_port = 9200
+                    warnings.warn("Environment variable ELASTIC_PORT is not set. Using default port 9200")
+                if kibana_port is None:
+                    kibana_port = 5601
+                    warnings.warn("Environment variable KIBANA_PORT is not set. Using default port 5601")
+                if elastic_token is None:
+                    raise KeyError("Environment variable ELASTIC_API_KEY is not set and no api_key is provided. Please specify either one and try again")
+                if os.getenv("ELASTIC_SPACE") is None:
+                    warnings.warn("Environment variable ELASTIC_SPACE is not set. Using 'default'")
 
             # Build the host URLs
             self.elasticsearch_host = f'https://{elasticsearch_host}:{elasticsearch_port}'
@@ -28,17 +44,6 @@ class Elastic:
             self.space_name = os.getenv('ELASTIC_SPACE', 'default') if space_name is None else space_name
             self.client_user = os.getenv('BRYNQ_SUBDOMAIN', 'default').lower().replace(' ', '_') if customer_name is None else customer_name.lower().replace(' ', '_')
 
-            # Check for missing environment variables and show warnings
-            if elasticsearch_host == "localhost":
-                warnings.warn("Environment variable ELASTIC_HOST is not set. Using default: localhost")
-            if elasticsearch_port == "9200":
-                warnings.warn("Environment variable ELASTIC_PORT is not set. Using default: 9200")
-            if kibana_port == "5601":
-                warnings.warn("Environment variable KIBANA_PORT is not set. Using default: 5601")
-            if elastic_token is None:
-                raise KeyError("Environment variable ELASTIC_API_KEY is not set and no api_key is provided. Please specify either one and try again")
-            if self.space_name == 'default':
-                warnings.warn("Environment variable ELASTIC_SPACE is not set. Using 'default'")
             if self.client_user == 'default':
                 warnings.warn("Environment variable BRYNQ_SUBDOMAIN is not set and customer_name is not specified. Using 'default'")
 
@@ -54,8 +59,9 @@ class Elastic:
                 'Authorization': f'ApiKey {self.elastic_token}',
                 'kbn-xsrf': 'true'
             }
-            self.get_health()
-            self.create_space(space_name=self.space_name)
+            if not self.disabled:
+                self.get_health()
+                self.create_space(space_name=self.space_name)
         except Exception as e:
             raise ConnectionError('Could not establish a connection: {}'.format(str(e)))
 
@@ -65,12 +71,18 @@ class Elastic:
         :return: if the connection is established or not
         """
         # Get the health of the database connection
-        health = requests.get(url=f'{self.elasticsearch_host}/_cat/health?', headers=self.elastic_headers, verify=self.verify).status_code
-        if health != 200:
-            raise ConnectionError('Elasticsearch cluster health check failed with status code: {}'.format(health))
-        else:
+        if self.disabled:
             return 'Healthy connection established with elasticsearch!'
 
+        try:
+            health = requests.get(url=f'{self.elasticsearch_host}/_cat/health?', headers=self.elastic_headers, verify=self.verify).status_code
+            if health != 200:
+                raise ConnectionError(f"Elasticsearch cluster health check failed with status code: {health}")
+            else:
+                return 'Healthy connection established with elasticsearch!'
+        except Exception as e:
+            raise ConnectionError(f'Elasticsearch was not reachable, error is: {e}')
+
     def initialize_customer(self):
         # Creates the index for the user if it does not exist yet
         self.create_index(index_name=f'task_execution_log_{self.client_user}')
@@ -84,6 +96,9 @@ class Elastic:
         :param space_name: The name of the space
         :return: The status of the creation of the space
         """
+        if self.disabled:
+            return 'Space creation disabled'
+
         url = f'{self.kibana_host}/api/spaces/space'
         data = {
             "id": space_name,
@@ -113,6 +128,9 @@ class Elastic:
         :param time_field: The name of the time field
         :return: The status of the creation of the data view
         """
+        if self.disabled:
+            return 'Data view creation disabled'
+
         url = f'{self.kibana_host}/s/{space_name}/api/data_views/data_view'
         data = {
             "data_view": {
@@ -140,6 +158,9 @@ class Elastic:
         :param index: the name of the index
         :return: The response of the request to elasticsearch
         """
+        if self.disabled:
+            return pd.DataFrame()
+
         size = 10000
 
         # Get all indices with the given index from the function parameter. For each day a new index.
@@ -182,6 +203,9 @@ class Elastic:
         :param index_name: The index you want to delete
         :return: The response of the request to elasticsearch
         """
+        if self.disabled:
+            return 'Index deletion disabled'
+
         # Check if index exists
         url = f'{self.elasticsearch_host}/{index_name}'
         response = requests.head(url=url, headers=self.elastic_headers, verify=self.verify)
@@ -202,6 +226,9 @@ class Elastic:
         :param index_name: The name of the desired index
         :return: The response of the request to elasticsearch
         """
+        if self.disabled:
+            return 'Index creation disabled'
+
         url = f'{self.elasticsearch_host}/{index_name}'
         response = requests.head(url=url, headers=self.elastic_headers, verify=self.verify)
 
@@ -221,6 +248,9 @@ class Elastic:
         :param index: one or more index names in a list.
         :return: The response of the request to elasticsearch
         """
+        if self.disabled:
+            return 'Role creation disabled'
+
         url = f'{self.kibana_host}/api/security/role/{role_name}'
         # Set the body
         body = {
@@ -262,6 +292,9 @@ class Elastic:
         Get all the indices in the elasticsearch instance
         :return: A dictionary with all the indices
         """
+        if self.disabled:
+            return {}
+
         indices = requests.get(url=f'{self.elasticsearch_host}/_cat/indices?format=json', headers=self.elastic_headers, verify=self.verify).json()
         return indices
 
@@ -274,6 +307,9 @@ class Elastic:
         :param roles: Give the roles to which the user belongs in a list. Most often the same role_name as the user_name
         :return: The response of the request to elasticsearch
         """
+        if self.disabled:
+            return 'User creation disabled'
+
         url = f'{self.elasticsearch_host}/_security/user/{user_name}'
         body = {
             'password': f'{password}',
@@ -300,6 +336,9 @@ class Elastic:
         :param document: The document to be posted
         :return: The response of the request to elasticsearch
         """
+        if self.disabled:
+            return None
+
         url = f'{self.elasticsearch_host}/{index_name}/_doc/'
         body = json.dumps(document)
         response = requests.post(url=url, data=body, headers=self.elastic_headers, verify=self.verify)
@@ -312,6 +351,9 @@ class Elastic:
         :param document_id: The id of the document to be retrieved
         :return: The response of the request to elasticsearch
         """
+        if self.disabled:
+            return None
+
         url = f'{self.elasticsearch_host}/{index_name}/_doc/{document_id}'
         response = requests.get(url=url, headers=self.elastic_headers, verify=self.verify)
         return response
@@ -323,6 +365,9 @@ class Elastic:
         :param document_id: The id of the document to be deleted
         :return: The response of the request to elasticsearch
         """
+        if self.disabled:
+            return None
+
         url = f'{self.elasticsearch_host}/{index_name}/_doc/{document_id}'
         response = requests.delete(url=url, headers=self.elastic_headers, verify=self.verify)
         return response
@@ -333,6 +378,9 @@ class Elastic:
         :param information: the information to be inserted into the database.
         :return: the response of the post request
         """
+        if self.disabled:
+            return None
+
         # Add new document
         url = f'{self.elasticsearch_host}/task_execution_log_{self.client_user}/_doc/'
         body = json.dumps(information)

{brynq_sdk_elastic-2.0.0 → brynq_sdk_elastic-2.2.0}/brynq_sdk_elastic.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq-sdk-elastic
-Version: 2.0.0
+Version: 2.2.0
 Summary: elastic wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_elastic-2.0.0 → brynq_sdk_elastic-2.2.0}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup
 
 setup(
     name='brynq_sdk_elastic',
-    version='2.0.0',
+    version='2.2.0',
     description='elastic wrapper from BrynQ',
     long_description='elastic wrapper from BrynQ',
     author='BrynQ',