dqlmagic 1.0.1__tar.gz

dqlmagic-1.0.1/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.1
+Name: dqlmagic
+Version: 1.0.1
+Summary: IPython magic function for Dynatrace Query Language (DQL)
+Home-page: https://github.com/dtPaTh/Dqlmagic
+Author: Patrick Thurner
+Author-email: patrick.thurner@dynatrace.com
+License: Apache 2.0
+Keywords: Notebook,Jupyter,DQL,Dynatrace Query Language
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+
+# Dqlmagic
+
+An IPython magic function allowing to use DQL in your notebooks.
+
+Dynatrace Query Language (DQL) is a powerful tool to explore your data and discover patterns, identify anomalies and outliers, create statistical modeling, and more based on data stored in Dynatrace Grail storage. 
+
+Dqlmagic makes DQL queries available to be used in jupyter notebooks.
+
+## Available magic functions
+
+### dql <dql_query>
+Allows to run a DQL query and returns the response records as json array.
+
+Available as inline and cell function. 
+
+### dql_raw <dql_query>
+Allows to run a DQL query and returns the response in raw json format as provided by the api.
+
+Available as inline and cell function. 
+
+### auth_grail <config_prefix>
+Inline function connecting to the grail cluster. 
+
+Reads connection parameters from .env file: 
+```
+dt_oauth_url="https://sso.dynatrace.com/sso/oauth2/token"
+
+dt_oauth_clientid="<YOUR-CLIENT-ID>"
+dt_oauth_clientsecret="<YOUR-CLIENT-SECRET>"
+dt_oauth_scope="<YOUR-ACCESS-SCOPE>"
+
+dt_tenant="<YOUR-TENANT-ID>"
+grail_apiurl="https://<YOUR-TENANT-ID>.live.dynatrace.com/api/v2/dql/query"
+```
+
+The ```<config_prefix>``` is **optional** to be used if you have multiple configs stored in your .env file like e.g. 
+
+```
+dt_config_prefix="DEV"
+
+DEV_dt_oauth_url="https://sso.dynatrace.com/sso/oauth2/token"
+DEV_dt_oauth_clientid="<YOUR-DEV-CLIENT-ID>"
+DEV_dt_oauth_clientsecret="<YOUR-DEV-CLIENT-SECRET>"
+DEV_dt_oauth_scope="<YOUR-DEV-ACCESS-SCOPE>"
+DEV_dt_tenant="<YOUR-DEV-TENANT-ID>"
+DEV_grail_apiurl="https://<YOUR-DEV-TENANT-ID>.apps.dynatracelabs.com/platform/storage/query/v1/"
+
+PROD_dt_oauth_url="https://sso.dynatrace.com/sso/oauth2/token"
+PROD_dt_oauth_clientid="<YOUR-PROD-CLIENT-ID>"
+PROD_dt_oauth_clientsecret="<YOUR-PROD-CLIENT-SECRET>"
+PROD_dt_oauth_scope="<YOUR-PROD-ACCESS-SCOPE>"
+PROD_dt_tenant="<YOUR-PROD-TENANT-ID>"
+PROD_grail_apiurl="https://<YOUR-PROD-TENANT-ID>.apps.dynatracelabs.com/platform/storage/query/v1/"
+
+```
+
+With the parameter ```dt_config_prefix```, you set the default config prefix used, if %auth_grail parameter ```<config_prefix>``` is not provided.
+
+For more details on how to setup API oauth clients in Dynatrace see [Configure and manage account API OAuth clients
+](https://www.dynatrace.com/support/help/how-to-use-dynatrace/account-management/identity-access-management/account-api-oauth)
+
+For more details on .env file see [How to NOT embedded credential in Jupyter notebook](https://yuthakarn.medium.com/how-to-not-show-credential-in-jupyter-notebook-c349f9278466) or [python-dotenv](https://pypi.org/project/python-dotenv/)

dqlmagic-1.0.1/dqlmagic/__init__.py

@@ -0,0 +1,6 @@
+__version__='1.0.1'
+
+from .dqlmagic import DQLmagic
+
+def load_ipython_extension(ipython):
+    ipython.register_magics(DQLmagic)

dqlmagic-1.0.1/dqlmagic/dqlmagic.py

@@ -0,0 +1,180 @@
+from IPython.core.magic import (Magics, magics_class, line_magic, cell_magic, line_cell_magic)
+import requests
+import json
+import os
+from dotenv import load_dotenv 
+from datetime import timedelta 
+import datetime
+import time
+
+@magics_class
+class DQLmagic(Magics):
+
+    config_prefix=''
+
+    oauth_url = None
+    oauth_clientid = None
+    oauth_clientsecret = None
+    oauth_scope = None
+
+    grail_apiurl = None
+    access_token = None
+    
+    dt_tenant = None
+    dt_app_context = None
+
+    isPlatformAPI = False
+
+    dql_default_query_timespan_minutes = 8*60
+
+    def get_bearer(self):
+        
+        if (self.oauth_url is None or self.oauth_clientid is None or self.oauth_clientsecret is None or self.oauth_scope is None or self.oauth_scope is None): 
+            self.access_token = None
+        else:
+            payload = "grant_type=client_credentials&client_id="+self.oauth_clientid+"&client_secret="+self.oauth_clientsecret+"&scope="+self.oauth_scope
+            
+            headers = {'content-type': "application/x-www-form-urlencoded"}
+            
+            try:
+                response = requests.request("POST", self.oauth_url, data=payload, headers=headers)
+                res = json.loads(response.text)
+
+                self.access_token = res["access_token"]
+            except:
+                self.access_token = None
+
+        return self.access_token
+    
+
+    @line_magic
+    def auth_grail(self, line):
+
+        load_dotenv() 
+        
+        cfgPrefix = os.getenv('dt_config_prefix')
+
+        if len(line)>0: 
+            cfgPrefix=line.strip()
+
+        if cfgPrefix==None: cfgPrefix=''
+        else: cfgPrefix+='_'
+        self.config_prefix = cfgPrefix
+        
+        self.oauth_url = os.getenv(self.config_prefix+'dt_oauth_url')
+        self.oauth_clientid = os.getenv(self.config_prefix+'dt_oauth_clientid')
+        self.oauth_clientsecret = os.getenv(self.config_prefix+'dt_oauth_clientsecret')
+        self.oauth_scope = os.getenv(self.config_prefix+'dt_oauth_scope')
+        
+        if (self.oauth_url is None): return "Missing connection parameter 'dt_oauth_url'"
+        if (self.oauth_clientid is None): return "Missing connection parameter 'oauth_clientid'"
+        if (self.oauth_clientsecret is None): return "Missing connection parameter 'oauth_clientsecret'"
+        if (self.oauth_scope is None): return "Missing connection parameter 'oauth_scope'"
+
+        self.grail_apiurl = os.getenv(self.config_prefix+'grail_apiurl')
+        self.dt_tenant = os.getenv(self.config_prefix+"dt_tenant")
+        self.dt_app_context = os.getenv(self.config_prefix+"dt_app_context")
+        queryTimespan = os.getenv('dql_default_query_timespan_minutes')
+        if queryTimespan != None: self.dql_default_query_timespan_minutes = int(queryTimespan)
+
+        if (self.grail_apiurl is None): return "Missing connection parameter 'grail_apiurl'"
+        if (self.dt_tenant is None): return "Missing connection parameter 'dt_tenant'"
+
+        
+        self.get_bearer()
+
+        if (self.access_token is None):
+            return "Couldn't successfully authenticate"
+        else:
+            return "Successfully authenticated"
+    
+    @line_magic
+    def dql(self, line):
+        return self.dql(line,None)
+
+    @cell_magic
+    def dql(self, line, cell):
+       return self.dql(line, cell)
+    
+    @line_cell_magic
+    def dql(self, line, cell=None):
+        res = self.dql_raw(line,cell)
+        if res:
+            jdata = json.loads(res)
+            return jdata["result"]["records"]
+        else:
+            return None
+
+    @line_magic
+    def dql_raw(self, line):
+        return self.dql_raw(line,None)
+
+    @cell_magic
+    def dql_raw(self, line, cell):
+        return self.dql_raw(line, cell)
+    
+    @line_cell_magic
+    def dql_raw(self, line, cell=None):
+
+        if (self.get_bearer() is None):
+            return "Not authorized. Log in via '%auth_grail <...>"
+        else : 
+
+            dql=line
+            if cell is not None:
+                dql = cell
+        
+            queryParams = {
+                "enrich":"metric-metadata"
+                }
+    
+            headers = {
+                "accept": "application/json",
+                "Authorization":"Bearer "+self.access_token,
+                "dt-tenant": self.dt_tenant
+            }
+        
+            now = datetime.datetime.utcnow()
+
+            body = {
+                "query": dql,
+                "defaultTimeframeStart": (now - timedelta(minutes=self.dql_default_query_timespan_minutes)).strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
+                "defaultTimeframeEnd": now.strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
+                "timezone": "UTC",
+                "locale": "en_US",
+                "maxResultRecords": 1000,
+                "fetchTimeoutSeconds": 60,
+                "requestTimeoutMilliseconds": 1000,
+                "enablePreview": True,
+                "defaultSamplingRatio": 1000,
+                "defaultScanLimitGbytes": 250
+            }
+            
+            response = requests.request("POST", self.grail_apiurl+"query:execute", headers=headers, params=queryParams, json=body)
+            if(response.status_code == 200):
+                return response.text
+            elif (response.status_code == 202):
+                print ("Start polling query updates..")                
+                statusQueryParams = {
+                    "request-token": response.json()["requestToken"],
+                    "enrich":"metric-metadata"
+                    }
+
+                polling_interval = 1
+
+                while True:
+                    statusResponse = requests.get(self.grail_apiurl+"query:poll", params=statusQueryParams)
+
+                    if statusResponse.status_code == 200:
+                        status_update = statusResponse.json()["state"]
+                        if status_update == "SUCCEEDED":
+                            return statusResponse.text
+                        else: 
+                            time.sleep(polling_interval)
+                    else: 
+                        return '{"result":{"records":[{"ERROR":"Failed to poll query result ('+str(statusResponse.status_code)+')"}]}}'
+                    
+            else:
+                return '{"result":{"records":[{"ERROR":"Failed to execute query ('+str(response.status_code)+')"}]}}'
+    
+        

dqlmagic-1.0.1/dqlmagic.egg-info/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.1
+Name: dqlmagic
+Version: 1.0.1
+Summary: IPython magic function for Dynatrace Query Language (DQL)
+Home-page: https://github.com/dtPaTh/Dqlmagic
+Author: Patrick Thurner
+Author-email: patrick.thurner@dynatrace.com
+License: Apache 2.0
+Keywords: Notebook,Jupyter,DQL,Dynatrace Query Language
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+
+# Dqlmagic
+
+An IPython magic function allowing to use DQL in your notebooks.
+
+Dynatrace Query Language (DQL) is a powerful tool to explore your data and discover patterns, identify anomalies and outliers, create statistical modeling, and more based on data stored in Dynatrace Grail storage. 
+
+Dqlmagic makes DQL queries available to be used in jupyter notebooks.
+
+## Available magic functions
+
+### dql <dql_query>
+Allows to run a DQL query and returns the response records as json array.
+
+Available as inline and cell function. 
+
+### dql_raw <dql_query>
+Allows to run a DQL query and returns the response in raw json format as provided by the api.
+
+Available as inline and cell function. 
+
+### auth_grail <config_prefix>
+Inline function connecting to the grail cluster. 
+
+Reads connection parameters from .env file: 
+```
+dt_oauth_url="https://sso.dynatrace.com/sso/oauth2/token"
+
+dt_oauth_clientid="<YOUR-CLIENT-ID>"
+dt_oauth_clientsecret="<YOUR-CLIENT-SECRET>"
+dt_oauth_scope="<YOUR-ACCESS-SCOPE>"
+
+dt_tenant="<YOUR-TENANT-ID>"
+grail_apiurl="https://<YOUR-TENANT-ID>.live.dynatrace.com/api/v2/dql/query"
+```
+
+The ```<config_prefix>``` is **optional** to be used if you have multiple configs stored in your .env file like e.g. 
+
+```
+dt_config_prefix="DEV"
+
+DEV_dt_oauth_url="https://sso.dynatrace.com/sso/oauth2/token"
+DEV_dt_oauth_clientid="<YOUR-DEV-CLIENT-ID>"
+DEV_dt_oauth_clientsecret="<YOUR-DEV-CLIENT-SECRET>"
+DEV_dt_oauth_scope="<YOUR-DEV-ACCESS-SCOPE>"
+DEV_dt_tenant="<YOUR-DEV-TENANT-ID>"
+DEV_grail_apiurl="https://<YOUR-DEV-TENANT-ID>.apps.dynatracelabs.com/platform/storage/query/v1/"
+
+PROD_dt_oauth_url="https://sso.dynatrace.com/sso/oauth2/token"
+PROD_dt_oauth_clientid="<YOUR-PROD-CLIENT-ID>"
+PROD_dt_oauth_clientsecret="<YOUR-PROD-CLIENT-SECRET>"
+PROD_dt_oauth_scope="<YOUR-PROD-ACCESS-SCOPE>"
+PROD_dt_tenant="<YOUR-PROD-TENANT-ID>"
+PROD_grail_apiurl="https://<YOUR-PROD-TENANT-ID>.apps.dynatracelabs.com/platform/storage/query/v1/"
+
+```
+
+With the parameter ```dt_config_prefix```, you set the default config prefix used, if %auth_grail parameter ```<config_prefix>``` is not provided.
+
+For more details on how to setup API oauth clients in Dynatrace see [Configure and manage account API OAuth clients
+](https://www.dynatrace.com/support/help/how-to-use-dynatrace/account-management/identity-access-management/account-api-oauth)
+
+For more details on .env file see [How to NOT embedded credential in Jupyter notebook](https://yuthakarn.medium.com/how-to-not-show-credential-in-jupyter-notebook-c349f9278466) or [python-dotenv](https://pypi.org/project/python-dotenv/)

dqlmagic-1.0.1/dqlmagic.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+pyproject.toml
+readme.md
+setup.cfg
+setup.py
+dqlmagic/__init__.py
+dqlmagic/dqlmagic.py
+dqlmagic.egg-info/PKG-INFO
+dqlmagic.egg-info/SOURCES.txt
+dqlmagic.egg-info/dependency_links.txt
+dqlmagic.egg-info/requires.txt
+dqlmagic.egg-info/top_level.txt
+dqlmagic.egg-info/zip-safe

dqlmagic-1.0.1/dqlmagic.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dqlmagic-1.0.1/dqlmagic.egg-info/requires.txt

@@ -0,0 +1,3 @@
+ipython
+jupyter
+python-dotenv

dqlmagic-1.0.1/dqlmagic.egg-info/top_level.txt

@@ -0,0 +1 @@
+dqlmagic

dqlmagic-1.0.1/dqlmagic.egg-info/zip-safe

@@ -0,0 +1 @@
+

dqlmagic-1.0.1/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

dqlmagic-1.0.1/readme.md

@@ -0,0 +1,62 @@
+# Dqlmagic
+
+An IPython magic function allowing to use DQL in your notebooks.
+
+Dynatrace Query Language (DQL) is a powerful tool to explore your data and discover patterns, identify anomalies and outliers, create statistical modeling, and more based on data stored in Dynatrace Grail storage. 
+
+Dqlmagic makes DQL queries available to be used in jupyter notebooks.
+
+## Available magic functions
+
+### dql <dql_query>
+Allows to run a DQL query and returns the response records as json array.
+
+Available as inline and cell function. 
+
+### dql_raw <dql_query>
+Allows to run a DQL query and returns the response in raw json format as provided by the api.
+
+Available as inline and cell function. 
+
+### auth_grail <config_prefix>
+Inline function connecting to the grail cluster. 
+
+Reads connection parameters from .env file: 
+```
+dt_oauth_url="https://sso.dynatrace.com/sso/oauth2/token"
+
+dt_oauth_clientid="<YOUR-CLIENT-ID>"
+dt_oauth_clientsecret="<YOUR-CLIENT-SECRET>"
+dt_oauth_scope="<YOUR-ACCESS-SCOPE>"
+
+dt_tenant="<YOUR-TENANT-ID>"
+grail_apiurl="https://<YOUR-TENANT-ID>.live.dynatrace.com/api/v2/dql/query"
+```
+
+The ```<config_prefix>``` is **optional** to be used if you have multiple configs stored in your .env file like e.g. 
+
+```
+dt_config_prefix="DEV"
+
+DEV_dt_oauth_url="https://sso.dynatrace.com/sso/oauth2/token"
+DEV_dt_oauth_clientid="<YOUR-DEV-CLIENT-ID>"
+DEV_dt_oauth_clientsecret="<YOUR-DEV-CLIENT-SECRET>"
+DEV_dt_oauth_scope="<YOUR-DEV-ACCESS-SCOPE>"
+DEV_dt_tenant="<YOUR-DEV-TENANT-ID>"
+DEV_grail_apiurl="https://<YOUR-DEV-TENANT-ID>.apps.dynatracelabs.com/platform/storage/query/v1/"
+
+PROD_dt_oauth_url="https://sso.dynatrace.com/sso/oauth2/token"
+PROD_dt_oauth_clientid="<YOUR-PROD-CLIENT-ID>"
+PROD_dt_oauth_clientsecret="<YOUR-PROD-CLIENT-SECRET>"
+PROD_dt_oauth_scope="<YOUR-PROD-ACCESS-SCOPE>"
+PROD_dt_tenant="<YOUR-PROD-TENANT-ID>"
+PROD_grail_apiurl="https://<YOUR-PROD-TENANT-ID>.apps.dynatracelabs.com/platform/storage/query/v1/"
+
+```
+
+With the parameter ```dt_config_prefix```, you set the default config prefix used, if %auth_grail parameter ```<config_prefix>``` is not provided.
+
+For more details on how to setup API oauth clients in Dynatrace see [Configure and manage account API OAuth clients
+](https://www.dynatrace.com/support/help/how-to-use-dynatrace/account-management/identity-access-management/account-api-oauth)
+
+For more details on .env file see [How to NOT embedded credential in Jupyter notebook](https://yuthakarn.medium.com/how-to-not-show-credential-in-jupyter-notebook-c349f9278466) or [python-dotenv](https://pypi.org/project/python-dotenv/)

dqlmagic-1.0.1/setup.cfg

@@ -0,0 +1,27 @@
+[metadata]
+name = dqlmagic
+version = attr: dqlmagic.__version__
+author = Patrick Thurner
+author_email = patrick.thurner@dynatrace.com
+url = https://github.com/dtPaTh/Dqlmagic
+description = IPython magic function for Dynatrace Query Language (DQL)
+long_description = file: readme.md
+long_description_content_type = text/markdown
+keywords = Notebook, Jupyter, DQL, Dynatrace Query Language
+license = Apache 2.0
+classifiers = 
+	License :: OSI Approved :: Apache Software License
+	Programming Language :: Python :: 3
+
+[options]
+packages = find:
+zip_safe = True
+install_requires = 
+	ipython
+	jupyter
+	python-dotenv
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

dqlmagic-1.0.1/setup.py

@@ -0,0 +1 @@
+__import__("setuptools").setup()