brynq-sdk-elastic 2.0.1__tar.gz → 2.2.1__tar.gz

{brynq_sdk_elastic-2.0.1 → brynq_sdk_elastic-2.2.1}/PKG-INFO

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

{brynq_sdk_elastic-2.0.1 → brynq_sdk_elastic-2.2.1}/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 os.getenv("ELASTIC_HOST") is None:
-                warnings.warn("Environment variable ELASTIC_HOST is not set. Using default: localhost")
-            if os.getenv("KIBANA_PORT") is None:
-                warnings.warn("Environment variable ELASTIC_PORT is not set. Using default: 9200")
-            if os.getenv("KIBANA_PORT") is None:
-                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 os.getenv("ELASTIC_SPACE") is None:
-                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,6 +71,9 @@ class Elastic:
         :return: if the connection is established or not
         """
         # Get the health of the database connection
+        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:
@@ -87,26 +96,34 @@ class Elastic:
         :param space_name: The name of the space
         :return: The status of the creation of the space
         """
-        url = f'{self.kibana_host}/api/spaces/space'
-        data = {
-            "id": space_name,
-            "name": space_name,
-            "description": f"This is the space for {space_name}",
-            "color": "#aabbcc",
-            "initials": space_name[0:2].upper(),
-            "disabledFeatures": [],
-        }
+        try:
+            if self.disabled:
+                return 'Space creation disabled'
+
+            url = f'{self.kibana_host}/api/spaces/space'
+            data = {
+                "id": space_name,
+                "name": space_name,
+                "description": f"This is the space for {space_name}",
+                "color": "#aabbcc",
+                "initials": space_name[0:2].upper(),
+                "disabledFeatures": [],
+            }
 
-        response = requests.head(url=url + fr'/{space_name}', headers=self.kibana_headers, verify=self.verify)
+            response = requests.head(url=url + fr'/{space_name}', headers=self.kibana_headers, verify=self.verify)
 
-        if response.status_code == 200:
-            return f'Index \'{space_name}\' already exists'
-        else:
-            response = requests.post(url=url, headers=self.kibana_headers, data=json.dumps(data), verify=self.verify)
             if response.status_code == 200:
-                return f'space {space_name} created'
+                return f'Index \'{space_name}\' already exists'
             else:
-                raise ConnectionError(f'Could not create space {space_name} with status code: {response.status_code}. Response: {response.text}')
+                response = requests.post(url=url, headers=self.kibana_headers, data=json.dumps(data), verify=self.verify)
+                if response.status_code == 200:
+                    return f'space {space_name} created'
+                else:
+                    raise ConnectionError(f'Could not create space {space_name} with status code: {response.status_code}. Response: {response.text}')
+        except:
+            message = "Could not create space, since this is not strictly necessary to write logs, continue without it"
+            print(message)
+            return message
 
     def create_data_view(self, space_name: str, view_name: str, name: str, time_field: str) -> str:
         """
@@ -116,26 +133,34 @@ class Elastic:
         :param time_field: The name of the time field
         :return: The status of the creation of the data view
         """
-        url = f'{self.kibana_host}/s/{space_name}/api/data_views/data_view'
-        data = {
-            "data_view": {
-                "title": f'{view_name}*',
-                "id": f'{view_name}',
-                "name": f'{name}',
-                "timeFieldName": time_field
+        try:
+            if self.disabled:
+                return 'Data view creation disabled'
+
+            url = f'{self.kibana_host}/s/{space_name}/api/data_views/data_view'
+            data = {
+                "data_view": {
+                    "title": f'{view_name}*',
+                    "id": f'{view_name}',
+                    "name": f'{name}',
+                    "timeFieldName": time_field
+                }
             }
-        }
 
-        response = requests.head(url=url + fr'/{view_name}', headers=self.kibana_headers, verify=self.verify)
+            response = requests.head(url=url + fr'/{view_name}', headers=self.kibana_headers, verify=self.verify)
 
-        if response.status_code == 200:
-            return f'Data view \'{view_name}\' already exists'
-        else:
-            response = requests.post(url=url, headers=self.kibana_headers, data=json.dumps(data), verify=self.verify)
             if response.status_code == 200:
-                return f'data view {view_name} created'
+                return f'Data view \'{view_name}\' already exists'
             else:
-                raise ConnectionError(f'Could not create data view {view_name} with status code: {response.status_code}. Response: {response.text}')
+                response = requests.post(url=url, headers=self.kibana_headers, data=json.dumps(data), verify=self.verify)
+                if response.status_code == 200:
+                    return f'data view {view_name} created'
+                else:
+                    raise ConnectionError(f'Could not create data view {view_name} with status code: {response.status_code}. Response: {response.text}')
+        except:
+            message = "Could not create data view, since this is not strictly necessary to write logs, continue without it"
+            print(message)
+            return message
 
     def get_all_docs_from_index(self, index: str) -> pd.DataFrame:
         """
@@ -143,6 +168,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.
@@ -185,6 +213,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)
@@ -205,6 +236,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)
 
@@ -224,47 +258,58 @@ class Elastic:
         :param index: one or more index names in a list.
         :return: The response of the request to elasticsearch
         """
-        url = f'{self.kibana_host}/api/security/role/{role_name}'
-        # Set the body
-        body = {
-            'elasticsearch': {
-                'cluster': ['transport_client'],
-                'indices': [
-                    {
-                        'names': [index],
-                        'privileges': ['read', 'write', 'read_cross_cluster', 'view_index_metadata', 'index']
-                    }
-                ]
-            },
-            'kibana': [{
-                'feature': {
-                    'dashboard': ['read'],
-                    'discover': ['read']
+        try:
+            if self.disabled:
+                return 'Role creation disabled'
+
+            url = f'{self.kibana_host}/api/security/role/{role_name}'
+            # Set the body
+            body = {
+                'elasticsearch': {
+                    'cluster': ['transport_client'],
+                    'indices': [
+                        {
+                            'names': [index],
+                            'privileges': ['read', 'write', 'read_cross_cluster', 'view_index_metadata', 'index']
+                        }
+                    ]
                 },
-                'spaces': [role_name],
-            }],
-            'metadata': {
-                'version': 1
+                'kibana': [{
+                    'feature': {
+                        'dashboard': ['read'],
+                        'discover': ['read']
+                    },
+                    'spaces': [role_name],
+                }],
+                'metadata': {
+                    'version': 1
+                }
             }
-        }
-        body = json.dumps(body)
+            body = json.dumps(body)
 
-        response = requests.head(url=url, headers=self.kibana_headers, verify=self.verify)
+            response = requests.head(url=url, headers=self.kibana_headers, verify=self.verify)
 
-        if response.status_code == 200:
-            return f'Role \'{role_name}\' already exists'
-        else:
-            response = requests.put(url=url, data=body, headers=self.kibana_headers, verify=self.verify)
-            if response.status_code == 204:
-                return f'Role {role_name} created'
+            if response.status_code == 200:
+                return f'Role \'{role_name}\' already exists'
             else:
-                raise ConnectionError(f'Could not create role {role_name} with status code: {response.status_code}. Response: {response.text}')
+                response = requests.put(url=url, data=body, headers=self.kibana_headers, verify=self.verify)
+                if response.status_code == 204:
+                    return f'Role {role_name} created'
+                else:
+                    raise ConnectionError(f'Could not create role {role_name} with status code: {response.status_code}. Response: {response.text}')
+        except:
+            message = "Could not create role, since this is not strictly necessary to write logs, continue without it"
+            print(message)
+            return message
 
     def get_indices(self) -> dict:
         """
         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
 
@@ -277,6 +322,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}',
@@ -303,6 +351,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)
@@ -315,6 +366,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
@@ -326,6 +380,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
@@ -336,6 +393,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.1 → brynq_sdk_elastic-2.2.1}/brynq_sdk_elastic.egg-info/PKG-INFO

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

{brynq_sdk_elastic-2.0.1 → brynq_sdk_elastic-2.2.1}/setup.py

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