omnata-plugin-runtime 0.7.0a185__tar.gz → 0.8.0a187__tar.gz

{omnata_plugin_runtime-0.7.0a185 → omnata_plugin_runtime-0.8.0a187}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.7.0a185
+Version: 0.8.0a187
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com
@@ -19,9 +19,11 @@ Requires-Dist: idna (<=3.7)
 Requires-Dist: jinja2 (>=3.1.2,<=3.1.4)
 Requires-Dist: markupsafe (<=2.1.3)
 Requires-Dist: numpy (<1.27.0)
+Requires-Dist: opentelemetry-api (<=1.23.0)
 Requires-Dist: packaging (<=24.1)
 Requires-Dist: pandas (<=2.2.2)
 Requires-Dist: platformdirs (<=3.10.0)
+Requires-Dist: protobuf (<=4.25.3)
 Requires-Dist: pyarrow (<=16.1.0)
 Requires-Dist: pycparser (<=2.21)
 Requires-Dist: pydantic (>=2,<=2.8.2)
@@ -34,10 +36,12 @@ Requires-Dist: requests (>=2,<=2.32.3)
 Requires-Dist: setuptools (<=72.1.0)
 Requires-Dist: snowflake-connector-python (>=3,<=3.12.0)
 Requires-Dist: snowflake-snowpark-python (==1.23.0)
+Requires-Dist: snowflake-telemetry-python (<=0.5.0)
 Requires-Dist: tenacity (>=8,<=8.2.3)
 Requires-Dist: tomlkit (<=0.11.1)
 Requires-Dist: urllib3 (<=2.2.2)
 Requires-Dist: wheel (<=0.43.0)
+Requires-Dist: wrapt (<=1.14.1)
 Description-Content-Type: text/markdown
 
 # omnata-plugin-runtime

{omnata_plugin_runtime-0.7.0a185 → omnata_plugin_runtime-0.8.0a187}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.7.0-a185"
+version = "0.8.0-a187"
 description = "Classes and common runtime components for building and running Omnata Plugins"
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"
@@ -38,6 +38,10 @@ wheel = "<=0.43.0" # latest version available on Snowflake Anaconda
 pyyaml = "<=6.0.1" # latest version available on Snowflake Anaconda
 cffi = "<=1.16.0" # latest version available on Snowflake Anaconda
 pyarrow = "<=16.1.0" # latest version available on Snowflake Anaconda
+wrapt = "<=1.14.1" # latest version available on Snowflake Anaconda
+opentelemetry-api = "<=1.23.0" # latest version available on Snowflake Anaconda
+snowflake-telemetry-python = "<=0.5.0" # latest version available on Snowflake Anaconda
+protobuf = "<=4.25.3" # latest version available on Snowflake Anaconda
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2.4"

{omnata_plugin_runtime-0.7.0a185 → omnata_plugin_runtime-0.8.0a187}/src/omnata_plugin_runtime/configuration.py

@@ -11,6 +11,7 @@ from enum import Enum
 
 from abc import ABC
 from pydantic import BaseModel, Field, PrivateAttr, SerializationInfo, TypeAdapter, field_validator, model_serializer, validator  # pylint: disable=no-name-in-module
+from .logging import logger
 
 if tuple(sys.version_info[:2]) >= (3, 9):
     # Python 3.9 and above
@@ -19,8 +20,6 @@ else:
     # Python 3.8 and below
     from typing_extensions import Annotated
 
-logger = logging.getLogger(__name__)
-
 
 class MapperType(str, Enum):
     FIELD_MAPPING_SELECTOR = "field_mapping_selector"

{omnata_plugin_runtime-0.7.0a185 → omnata_plugin_runtime-0.8.0a187}/src/omnata_plugin_runtime/logging.py

@@ -4,12 +4,38 @@ Custom logging functionality for Omnata
 import logging
 import logging.handlers
 import traceback
-from logging import Logger
+from logging import Logger, getLogger
 from typing import Dict, List, Optional
 from snowflake.snowpark import Session
 from pydantic import ValidationError
+from opentelemetry import trace
 
 
+class CustomLoggerAdapter(logging.LoggerAdapter):
+    """
+    A logger adapter which attaches current trace and span IDs to log messages, so that they can be correlated to traces.
+    Also offers the ability to add static extras.
+    """
+    def __init__(self, logger:logging.Logger, extra):
+        super(CustomLoggerAdapter, self).__init__(logger, extra)
+        self.extra_extras = {}
+    
+    def add_extra(self, key, value):
+        self.extra_extras[key] = value
+
+    def process(self, msg, kwargs):
+        extra = kwargs.get("extra", {})
+        current_span = trace.get_current_span()
+        context = current_span.get_span_context() if current_span is not None else None
+        if context is not None:
+            extra["trace_id"] = format(context.trace_id, 'x') # format as hex string to be consistent with Snowflake's handler
+            extra["span_id"] = format(context.span_id, 'x')
+        extra.update(self.extra_extras)
+        kwargs["extra"] = extra
+        return msg, kwargs
+
+logger = CustomLoggerAdapter(getLogger("omnata_plugin"), {})
+
 def log_exception(exception: Exception, logger_instance: Logger):
     """
     Logs an exception to a logger

{omnata_plugin_runtime-0.7.0a185 → omnata_plugin_runtime-0.8.0a187}/src/omnata_plugin_runtime/plugin_entrypoints.py

@@ -24,7 +24,7 @@ from .configuration import (
     ConnectivityOption
 )
 from .forms import ConnectionMethod, FormInputField, FormOption
-from .logging import OmnataPluginLogHandler
+from .logging import OmnataPluginLogHandler, logger
 from .omnata_plugin import (
     SnowflakeBillingEvent,
     BillingEventRequest,
@@ -37,9 +37,6 @@ from .omnata_plugin import (
 from pydantic import TypeAdapter
 from .rate_limiting import ApiLimits, RateLimitState
 
-# set the logger class to our custom logger so that pydantic errors are handled correctly
-logger = logging.getLogger(__name__)
-
 IMPORT_DIRECTORY_NAME = "snowflake_import_directory"
 
 
@@ -93,6 +90,14 @@ class PluginEntrypoint:
             connection_id=request.connection_id,
             sync_run_id=request.run_id,
         )
+        logger.add_extra('omnata.operation', 'sync')
+        logger.add_extra('omnata.sync.id', request.sync_id)
+        logger.add_extra('omnata.sync.direction', request.sync_direction)
+        logger.add_extra('omnata.connection.id', request.connection_id)
+        logger.add_extra('omnata.sync.run_id', request.run_id)
+        logger.add_extra('omnata.sync_branch.id', request.sync_branch_id)
+        logger.add_extra('omnata.sync_branch.name', request.sync_branch_name)
+
         omnata_log_handler.register(
             request.logging_level, self._plugin_instance.additional_loggers()
         )
@@ -283,6 +288,12 @@ class PluginEntrypoint:
         sync_parameters: Dict,
         current_form_parameters: Optional[Dict],
     ):
+        logger.add_extra('omnata.operation', 'configuration_form')
+        logger.add_extra('omnata.connection.connectivity_option', connectivity_option)
+        logger.add_extra('omnata.connection.connection_method', connection_method)
+        logger.add_extra('omnata.configuration_form.function_name', function_name)
+        logger.add_extra('omnata.sync.direction', sync_direction)
+
         logger.info("Entered configuration_form method")
         sync_strategy = normalise_nulls(sync_strategy)
         oauth_secret_name = normalise_nulls(oauth_secret_name)
@@ -342,6 +353,10 @@ class PluginEntrypoint:
         sync_parameters: Dict,
         selected_streams: Optional[List[str]], # None to return all streams without requiring schema
     ):
+        logger.add_extra('omnata.operation', 'list_streams')
+        logger.add_extra('omnata.connection.connectivity_option', connectivity_option)
+        logger.add_extra('omnata.connection.connection_method', connection_method)
+        logger.add_extra('omnata.sync.direction', 'inbound')
         logger.debug("Entered list_streams method")
         oauth_secret_name = normalise_nulls(oauth_secret_name)
         other_secrets_name = normalise_nulls(other_secrets_name)
@@ -393,6 +408,8 @@ class PluginEntrypoint:
         return results
 
     def connection_form(self,connectivity_option: str):
+        logger.add_extra('omnata.operation', 'connection_form')
+        logger.add_extra('omnata.connection.connectivity_option', connectivity_option)
         connectivity_option = TypeAdapter(ConnectivityOption).validate_python(connectivity_option)
         logger.info("Entered connection_form method")
         if self._plugin_instance.connection_form.__code__.co_argcount==1:
@@ -402,6 +419,7 @@ class PluginEntrypoint:
         return [f.model_dump() for f in form]
 
     def create_billing_events(self, session, event_request: Dict):
+        logger.add_extra('omnata.operation', 'create_billing_events')
         logger.info("Entered create_billing_events method")
         request = TypeAdapter(BillingEventRequest).validate_python(event_request)
         events: List[SnowflakeBillingEvent] = self._plugin_instance.create_billing_events(
@@ -474,6 +492,9 @@ class PluginEntrypoint:
         oauth_secret_name: Optional[str],
         other_secrets_name: Optional[str],
     ):
+        logger.add_extra('omnata.operation', 'connection_test')
+        logger.add_extra('omnata.connection.connectivity_option', connectivity_option)
+        logger.add_extra('omnata.connection.connection_method', method)
         logger.info("Entered connect method")
         logger.info(f"Connection parameters: {connection_parameters}")
         connection_secrets = get_secrets(oauth_secret_name, other_secrets_name)
@@ -524,6 +545,9 @@ class PluginEntrypoint:
                     connection_parameters: Dict,
                     oauth_secret_name: Optional[str],
                     other_secrets_name: Optional[str]):
+        logger.add_extra('omnata.operation', 'api_limits')
+        logger.add_extra('omnata.connection.connectivity_option', connectivity_option)
+        logger.add_extra('omnata.connection.connection_method', method)
         logger.info("Entered api_limits method")
         connection_secrets = get_secrets(oauth_secret_name, other_secrets_name)
         from omnata_plugin_runtime.omnata_plugin import (

{omnata_plugin_runtime-0.7.0a185 → omnata_plugin_runtime-0.8.0a187}/src/omnata_plugin_runtime/rate_limiting.py

@@ -15,12 +15,11 @@ import logging
 from pydantic import Field, root_validator, PrivateAttr, field_serializer
 from pydantic_core import to_jsonable_python
 from .configuration import SubscriptableBaseModel
+from .logging import logger
 import pytz
 from requests.adapters import HTTPAdapter
 from urllib3.util.retry import Retry
 
-logger = getLogger(__name__)
-
 TimeUnitType = Literal["second", "minute", "hour", "day"]
 
 HttpMethodType = Literal[