added examples to required classes for telemetry

Signed-off-by: Sai Shree Pradhan <saishree.pradhan@databricks.com>

Author: saishreeeee

examples/query_execute.py

@@ -8,8 +8,8 @@
 ) as connection:
 
     with connection.cursor() as cursor:
-        cursor.execute("SELECT * FROM main.eng_lumberjack.staging_frontend_log_sql_driver_log limit 1")
+        cursor.execute("SELECT * FROM default.diamonds LIMIT 2")
         result = cursor.fetchall()
 
         for row in result:
-            print(row)
+            print(row)

src/databricks/sql/telemetry/DriverConnectionParameters.py

@@ -22,3 +22,21 @@ class DriverConnectionParameters:
 
     def to_json(self):
         return json.dumps(asdict(self))
+    
+# Part of TelemetryEvent
+# DriverConnectionParameters connectionParams = new DriverConnectionParameters(
+#     httpPath = " /sql/1.0/endpoints/1234567890abcdef",
+#     driverMode = "THRIFT",
+#     hostDetails = new HostDetails(
+#         hostUrl = "https://my-workspace.cloud.databricks.com",
+#         port = 443
+#     ),
+#     authMech = "OAUTH",
+#     authFlow = "AZURE_MANAGED_IDENTITIES",
+#     authScope = "sql",
+#     discoveryUrl = "https://example-url",
+#     allowedVolumeIngestionPaths = "[]",
+#     enableComplexDatatypeSupport = true,
+#     azureTenantId = "1234567890abcdef",
+#     socketTimeout = 10000
+# )     

src/databricks/sql/telemetry/DriverErrorInfo.py

@@ -9,3 +9,14 @@ class DriverErrorInfo:
 
     def to_json(self):
         return json.dumps(asdict(self))
+
+# Required for ErrorLogs  
+# DriverErrorInfo errorInfo = new DriverErrorInfo(
+#     errorName="CONNECTION_ERROR",
+#     stackTrace="Connection failure while using the Databricks SQL Python connector. Failed to connect to server: https://my-workspace.cloud.databricks.com\n" +
+#               "databricks.sql.exc.OperationalError: Connection refused: connect\n" +
+#               "at databricks.sql.thrift_backend.ThriftBackend.make_request(ThriftBackend.py:329)\n" +
+#               "at databricks.sql.thrift_backend.ThriftBackend.attempt_request(ThriftBackend.py:366)\n" +
+#               "at databricks.sql.thrift_backend.ThriftBackend.open_session(ThriftBackend.py:575)\n" +
+#               "at databricks.sql.client.Connection.__init__(client.py:69)\n" +
+#               "at databricks.sql.client.connect(connection.py:123)")

src/databricks/sql/telemetry/DriverSystemConfiguration.py

@@ -1,8 +1,5 @@
 import json
 from dataclasses import dataclass, asdict
-import platform
-import sys
-import locale
 from databricks.sql import __version__
 
 
@@ -20,18 +17,20 @@ class DriverSystemConfiguration:
     driver_name: str
     char_set_encoding: str
 
-    def __init__(self):
-        self.driver_version = __version__
-        self.os_name = platform.system()
-        self.os_version = platform.version()
-        self.os_arch = platform.machine()
-        self.runtime_name = platform.python_implementation()
-        self.runtime_version = platform.python_version()
-        self.runtime_vendor = sys.implementation.name
-        self.client_app_name = "databricks-sql-python"
-        self.locale_name = locale.getdefaultlocale()[0]
-        self.driver_name = "databricks-sql-python"
-        self.char_set_encoding = "UTF-8"
-
     def to_json(self):
         return json.dumps(asdict(self))
+    
+# Part of TelemetryEvent
+# DriverSystemConfiguration systemConfig = new DriverSystemConfiguration(
+#     driver_version = "2.9.3",  
+#     os_name = "Darwin",        
+#     os_version = "24.4.0",     
+#     os_arch = "arm64",         
+#     runtime_name = "CPython",   
+#     runtime_version = "3.13.3", 
+#     runtime_vendor = "cpython",
+#     client_app_name = "databricks-sql-python", 
+#     locale_name = "en_US", 
+#     driver_name = "databricks-sql-python",     
+#     char_set_encoding = "UTF-8" 
+# )

src/databricks/sql/telemetry/DriverVolumeOperation.py

@@ -4,11 +4,16 @@
     DriverVolumeOperationType,
 )
 
-
 @dataclass
 class DriverVolumeOperation:
     volume_operation_type: DriverVolumeOperationType
     volume_path: str
 
     def to_json(self):
         return json.dumps(asdict(self))
+    
+# Part of TelemetryEvent
+# DriverVolumeOperation volumeOperation = new DriverVolumeOperation(
+#     volumeOperationType = "LIST",
+#     volumePath = "/path/to/volume"
+# )

src/databricks/sql/telemetry/FrontendLogContext.py

@@ -9,3 +9,11 @@ class FrontendLogContext:
 
     def to_json(self):
         return json.dumps(asdict(self))
+    
+# used in TelemetryFrontendLog
+# FrontendLogContext frontendLogContext = new FrontendLogContext(
+#     clientContext = new TelemetryClientContext(
+#         timestampMillis = 1716489600000,
+#         userAgent = "databricks-sql-python-test"
+#     )
+# )

src/databricks/sql/telemetry/HostDetails.py

@@ -9,3 +9,9 @@ class HostDetails:
 
     def to_json(self):
         return json.dumps(asdict(self))
+
+# Part of DriverConnectionParameters
+# HostDetails hostDetails = new HostDetails(
+#     hostUrl = "https://my-workspace.cloud.databricks.com",
+#     port = 443
+# )

src/databricks/sql/telemetry/SqlExecutionEvent.py

@@ -13,3 +13,11 @@ class SqlExecutionEvent:
 
     def to_json(self):
         return json.dumps(asdict(self))
+
+# Part of TelemetryEvent
+# SqlExecutionEvent sqlExecutionEvent = new SqlExecutionEvent(
+#     statementType = "QUERY",
+#     isCompressed = true,
+#     executionResult = "INLINE_ARROW",
+#     retryCount = 0
+# ) 

src/databricks/sql/telemetry/TelemetryClientContext.py

@@ -9,3 +9,9 @@ class TelemetryClientContext:
 
     def to_json(self):
         return json.dumps(asdict(self))
+    
+# used in FrontendLogContext
+# TelemetryClientContext clientContext = new TelemetryClientContext(
+#     timestampMillis = 1716489600000,
+#     userAgent = "databricks-sql-python-test"
+# )