Merge pull request #77 from skyflowapi/SK-678-add-metrices-in-python-sdk

SK-678 add metrices in python-sdk

Author: skyflow-bharti

.github/workflows/release.yml

@@ -7,6 +7,7 @@ on:
       - "setup.py"
       - "*.yml"
       - "*.md"
+      - "version.py"
 
 jobs:
   build-and-deploy:
@@ -39,6 +40,7 @@ jobs:
           git config user.name ${{ github.actor }}
           git config user.email ${{ github.actor }}@users.noreply.github.com
           git add setup.py
+          git add version.py
           git commit -m "[AUTOMATED] Public Release - ${{ steps.previoustag.outputs.tag }}"
           git push origin
           

ci-scripts/bump_version.sh

@@ -6,13 +6,16 @@ then
 	echo "Bumping package version to $1"
 
 	sed -E "s/current_version = .+/current_version = \'$SEMVER\'/g" setup.py > tempfile && cat tempfile > setup.py && rm -f tempfile
+	sed -E "s/SDK_VERSION = .+/SDK_VERSION = \'$SEMVER\'/g" version.py > tempfile && cat tempfile > version.py && rm -f tempfile
+
 	echo --------------------------
 	echo "Done, Package now at $1"
 
 else
 	echo "Bumping package version to $1-dev.$2"
 
 	sed -E "s/current_version = .+/current_version = \'$SEMVER-dev.$2\'/g" setup.py > tempfile && cat tempfile > setup.py && rm -f tempfile
+	sed -E "s/SDK_VERSION = .+/SDK_VERSION = \'$SEMVER-dev.$2\'/g" version.py > tempfile && cat tempfile > version.py && rm -f tempfile
 
 	echo --------------------------
 	echo "Done, Package now at $1-dev.$2"

skyflow/_utils.py

@@ -4,6 +4,9 @@
 import urllib.parse
 import logging
 from enum import Enum
+import platform
+import sys
+from version import SDK_VERSION
 
 skyflowLog = logging.getLogger('skyflow')
 skyflowLog.setLevel(logging.ERROR)
@@ -127,3 +130,31 @@ def render_key(parents):
         outStr += s % str(x)
         depth += 1
     return outStr
+
+def getMetrics():
+    ''' fetch metrics
+    '''
+    sdk_name_version = "skyflow-python@" + SDK_VERSION
+
+    try:
+        sdk_client_device_model = platform.node()
+    except Exception:
+        sdk_client_device_model = ""
+
+    try:
+        sdk_client_os_details = sys.platform
+    except Exception:
+        sdk_client_os_details = ""
+
+    try:
+        sdk_runtime_details = sys.version
+    except Exception:
+        sdk_runtime_details = ""
+
+    details_dic = {
+        'sdk_name_version': sdk_name_version,
+        'sdk_client_device_model': sdk_client_device_model,
+        'sdk_client_os_details': sdk_client_os_details,
+        'sdk_runtime_details': "Python " + sdk_runtime_details,
+    }
+    return details_dic

skyflow/service_account/_token.py

@@ -7,7 +7,7 @@
 import requests
 from warnings import warn
 from collections import namedtuple
-from skyflow._utils import log_info, InterfaceName, InfoMessages
+from skyflow._utils import log_info, InterfaceName, InfoMessages, getMetrics
 
 
 from skyflow.errors._skyflow_errors import *
@@ -126,7 +126,8 @@ def getSignedJWT(clientID, keyID, tokenURI, privateKey):
 
 def sendRequestWithToken(url, token):
     headers = {
-        "content-type": "application/json"
+        "content-type": "application/json",
+        "sky-metadata": json.dumps(getMetrics())
     }
     payload = {
         "grant_type": "urn:ietf:params:oauth:grant-type:jwt-bearer",

skyflow/vault/_client.py

@@ -1,6 +1,7 @@
 '''
 	Copyright (c) 2022 Skyflow, Inc.
 '''
+import json
 import types
 import requests
 from ._insert import getInsertRequestBody, processResponse, convertResponse
@@ -13,7 +14,7 @@
 from ._get import sendGetRequests
 import asyncio
 from skyflow.errors._skyflow_errors import SkyflowError, SkyflowErrorCodes, SkyflowErrorMessages
-from skyflow._utils import log_info, InfoMessages, InterfaceName
+from skyflow._utils import log_info, InfoMessages, InterfaceName, getMetrics
 from ._token import tokenProviderWrapper
 
 
@@ -52,7 +53,8 @@ def insert(self, records: dict, options: InsertOptions = InsertOptions()):
         self.storedToken = tokenProviderWrapper(
             self.storedToken, self.tokenProvider, interface)
         headers = {
-            "Authorization": "Bearer " + self.storedToken
+            "Authorization": "Bearer " + self.storedToken,
+            "sky-metadata": json.dumps(getMetrics())
         }
 
         response = requests.post(requestURL, data=jsonBody, headers=headers)
@@ -131,6 +133,8 @@ def invoke_connection(self, config: ConnectionConfig):
         if not 'X-Skyflow-Authorization'.lower() in request.headers:
             request.headers['x-skyflow-authorization'] = self.storedToken
 
+        request.headers['sky-metadata'] = json.dumps(getMetrics())
+
         response = session.send(request)
         session.close()
         return processResponse(response, interface=interface)

skyflow/vault/_detokenize.py

@@ -5,7 +5,7 @@
 import asyncio
 from aiohttp import ClientSession, request
 import json
-from skyflow._utils import InterfaceName
+from skyflow._utils import InterfaceName, getMetrics
 
 interface = InterfaceName.DETOKENIZE.value
 
@@ -48,7 +48,9 @@ async def sendDetokenizeRequests(data, url, token):
     async with ClientSession() as session:
         for record in validatedRecords:
             headers = {
-                "Authorization": "Bearer " + token
+                "Authorization": "Bearer " + token,
+                "sky-metadata": json.dumps(getMetrics())
+
             }
             task = asyncio.ensure_future(post(url, record, headers, session))
             tasks.append(task)

skyflow/vault/_get.py

@@ -1,11 +1,12 @@
 '''
 	Copyright (c) 2022 Skyflow, Inc.
 '''
+import json
 from skyflow.errors._skyflow_errors import SkyflowError, SkyflowErrorCodes, SkyflowErrorMessages
 import asyncio
 from aiohttp import ClientSession
 from ._config import RedactionType
-from skyflow._utils import InterfaceName
+from skyflow._utils import InterfaceName, getMetrics
 from ._get_by_id import get
 
 interface = InterfaceName.GET.value
@@ -83,7 +84,8 @@ async def sendGetRequests(data, url, token):
     async with ClientSession() as session:
         for record in validatedRecords:
             headers = {
-                "Authorization": "Bearer " + token
+                "Authorization": "Bearer " + token,
+                "sky-metadata": json.dumps(getMetrics())
             }
             params = {"redaction": redaction}
             if ids is not None:

skyflow/vault/_get_by_id.py

@@ -6,7 +6,7 @@
 from aiohttp import ClientSession
 import json
 from ._config import RedactionType
-from skyflow._utils import InterfaceName
+from skyflow._utils import InterfaceName, getMetrics
 
 interface = InterfaceName.GET_BY_ID.value
 
@@ -66,7 +66,8 @@ async def sendGetByIdRequests(data, url, token):
     async with ClientSession() as session:
         for record in validatedRecords:
             headers = {
-                "Authorization": "Bearer " + token
+                "Authorization": "Bearer " + token,
+                "sky-metadata": json.dumps(getMetrics())
             }
             params = {"skyflow_ids": record[0], "redaction": record[2]}
             task = asyncio.ensure_future(

skyflow/vault/_update.py

@@ -6,7 +6,7 @@
 import asyncio
 from skyflow.errors._skyflow_errors import SkyflowError, SkyflowErrorCodes, SkyflowErrorMessages
 from ._insert import getTableAndFields
-from skyflow._utils import InterfaceName
+from skyflow._utils import InterfaceName, getMetrics
 from aiohttp import ClientSession
 from ._config import UpdateOptions
 
@@ -40,7 +40,8 @@ async def sendUpdateRequests(data,options: UpdateOptions,url,token):
             }
             reqBody = json.dumps(reqBody)
             headers = {
-                "Authorization": "Bearer " + token
+                "Authorization": "Bearer " + token,
+                "sky-metadata": json.dumps(getMetrics())
             }
             task = asyncio.ensure_future(put(recordUrl, reqBody, headers, session))
             tasks.append(task)

tests/vault/test_url_encoder.py

@@ -1,9 +1,12 @@
 '''
 	Copyright (c) 2022 Skyflow, Inc.
 '''
+import platform
+import sys
 import unittest
-from skyflow._utils import http_build_query
-
+from unittest import mock
+from skyflow._utils import http_build_query, getMetrics
+from version import SDK_VERSION
 
 class TestUrlEncoder(unittest.TestCase):
     def setUp(self) -> None:
@@ -50,3 +53,63 @@ def test_encoder_array(self):
 
         self.assertEqual(
             http_data, "key=value&nested%5Barray%5D%5B0%5D=one&nested%5Barray%5D%5B1%5D=two&nested%5Bkey%5D=value")
+
+    # Test Case 1: Success case
+    def test_get_metrics(self):
+        expected = {
+            'sdk_name_version': "skyflow-python@" + SDK_VERSION, 
+            'sdk_client_device_model': platform.node(),
+            'sdk_client_os_details': sys.platform,
+            'sdk_runtime_details': "Python " + sys.version,
+        }
+        actual = getMetrics()
+        self.assertEqual(actual, expected)
+
+    @mock.patch('platform.node', return_value='')
+    def test_getMetrics_no_device_model(self, mock_node):
+        expected_output = {
+            'sdk_name_version': 'skyflow-python@' + SDK_VERSION,
+            'sdk_client_device_model': '',
+            'sdk_client_os_details': sys.platform,
+            'sdk_runtime_details': "Python " + sys.version
+        }
+
+        actual_output = getMetrics()
+        expected_output['sdk_client_device_model'] = ''
+        self.assertEqual(actual_output, expected_output)
+
+    @mock.patch('platform.node', return_value='Mocked Device Model')
+    def test_getMetrics_with_device_model(self, mock_node):
+        expected_output = {
+            'sdk_name_version': 'skyflow-python@' + SDK_VERSION,
+            'sdk_client_device_model': 'Mocked Device Model',
+            'sdk_client_os_details': sys.platform,
+            'sdk_runtime_details': "Python " + sys.version
+        }
+
+        actual_output = getMetrics()
+        self.assertEqual(actual_output, expected_output)
+
+    @mock.patch('sys.platform', return_value='mocked_os')
+    def test_getMetrics_with_os_details(self, mock_platform):
+        expected_output = {
+            'sdk_name_version': 'skyflow-python@' + SDK_VERSION,
+            'sdk_client_device_model': platform.node(),
+            'sdk_client_os_details': sys.platform,
+            'sdk_runtime_details': "Python " + sys.version
+        }
+        actual_output = getMetrics()
+        self.assertEqual(actual_output, expected_output)
+
+    def test_getMetrics_with_runtime_details(self):
+        expected_output = {
+        'sdk_name_version': 'skyflow-python@' + SDK_VERSION,
+        'sdk_client_device_model': platform.node(),
+        'sdk_client_os_details': sys.platform,
+        'sdk_runtime_details': 'Python ' + 'mocked_version'
+        }
+
+        with mock.patch('sys.version', 'mocked_version'), \
+            mock.patch('sys.version_info', new=(3, 11, 2)):
+            actual_output = getMetrics()
+            self.assertEqual(actual_output, expected_output)