feat: enhanced logging capabilities

Author: Abhi591

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.14.0] - 2025-11-17
+
+### Added
+
+- Enhanced Logging capabilities at VWO by sending `vwo_sdkDebug` event with additional debug properties.
 
 ## [1.13.0] - 2025-09-04
 

setup.py

@@ -121,7 +121,7 @@ def run(self):
 
 setup(
     name="vwo-fme-python-sdk",
-    version="1.13.0",
+    version="1.14.0",
     description="VWO Feature Management and Experimentation SDK for Python",
     long_description=long_description,
     long_description_content_type="text/markdown",

vwo/api/get_flag_api.py

@@ -16,9 +16,7 @@
 from typing import Dict, Any, List
 from ..models.settings.settings_model import SettingsModel
 from ..models.user.context_model import ContextModel
-from ..models.user.context_model import ContextModel
 from ..services.hooks_manager import HooksManager
-from ..packages.logger.core.log_manager import LogManager
 from ..enums.api_enum import ApiEnum
 from ..enums.campaign_type_enum import CampaignTypeEnum
 from ..utils.log_message_util import debug_messages, info_messages, error_messages
@@ -40,6 +38,10 @@
 from ..services.storage_service import StorageService
 from ..decorators.storage_decorator import StorageDecorator
 from ..utils.campaign_util import get_variation_from_campaign_key
+from ..enums.debug_category_enum import DebugCategoryEnum
+from ..packages.logger.enums.log_level_enum import LogLevelEnum
+from ..constants.Constants import Constants
+from ..utils.debugger_service_util import send_debug_event_to_vwo
 
 
 class GetFlagApi:
@@ -74,6 +76,13 @@ def get(
             "api": ApiEnum.GET_FLAG.value,
         }
 
+        debug_event_props = {
+            "an": ApiEnum.GET_FLAG.value,
+            "fk": feature_key,
+            "uuid": context.get_vwo_uuid(),
+            "sId": context.get_vwo_session_id(),
+        }
+
         storage_service = StorageService()
         stored_data = StorageDecorator().get_feature_from_storage(
             feature_key, context, storage_service
@@ -128,11 +137,7 @@ def get(
                 self._passed_rules_information.update(feature_info)
 
         if feature is None:
-            LogManager.get_instance().error(
-                error_messages.get("FEATURE_NOT_FOUND").format(
-                    featureKey=feature_key,
-                )
-            )
+            LogManager.get_instance().error_log("FEATURE_NOT_FOUND", data={"featureKey": feature_key}, debug_data = debug_event_props)
             self._get_flag_response.set_is_enabled(False)
             return self._get_flag_response
 
@@ -194,6 +199,7 @@ def get(
                         rollout_rules_to_evaluate[0].get_id(),
                         variation.get_id(),
                         context,
+                        feature_key,
                     )
 
         if not roll_out_rules:
@@ -262,6 +268,7 @@ def get(
                         experiment_rules_to_evaluate[0].get_id(),
                         variation.get_id(),
                         context,
+                        feature_key,
                     )
 
         if self._get_flag_response.is_enabled():
@@ -277,6 +284,16 @@ def get(
         hook_manager.set(decision)
         hook_manager.execute(hook_manager.get())
 
+        # send debug event, if debugger is enabled
+        if feature.get_is_debugger_enabled():
+            debug_event_props["cg"] = DebugCategoryEnum.DECISION.value
+            debug_event_props["lt"] = LogLevelEnum.INFO.value
+            debug_event_props["msg_t"] = Constants.FLAG_DECISION_GIVEN
+            
+            # update debug event props with decision keys
+            self.update_debug_event_props_with_message(debug_event_props, decision)
+            send_debug_event_to_vwo(debug_event_props);
+
         if (
             feature.get_impact_campaign()
             and feature.get_impact_campaign().get_campaign_id()
@@ -300,6 +317,7 @@ def get(
                     2 if self._get_flag_response.is_enabled() else 1
                 ),  # 2 is for Variation (flag enabled), 1 is for Control (flag disabled)
                 context,
+                feature_key,
             )
 
         return self._get_flag_response
@@ -327,3 +345,40 @@ def _update_integrations_decision_object(
                 }
             )
         decision.update(self._passed_rules_information)
+
+    def update_debug_event_props_with_message(
+        self,
+        debug_event_props: Dict[str, Any],
+        decision: Dict[str, Any],
+    ) -> None:
+        """
+        Updates the debug event props with the decision keys.
+
+        :param debug_event_props: The debug event props to update.
+        :param decision: The decision object to extract the keys from.
+        """
+        feature_key = decision.get("featureKey") or ""
+        message = f"Flag decision given for feature:{feature_key}."
+
+        rollout_key = decision.get("rolloutKey")
+        rollout_variation_id = decision.get("rolloutVariationId")
+        if rollout_key and rollout_variation_id:
+            prefix = f"{feature_key}_"
+            rollout_suffix = (
+                rollout_key[len(prefix):]
+                if isinstance(rollout_key, str) and isinstance(feature_key, str) and rollout_key.startswith(prefix)
+                else rollout_key
+            )
+            message += f" Got rollout:{rollout_suffix} with variation:{rollout_variation_id}"
+
+        experiment_key = decision.get("experimentKey")
+        experiment_variation_id = decision.get("experimentVariationId")
+        if experiment_key and experiment_variation_id:
+            prefix = f"{feature_key}_"
+            experiment_suffix = (
+                experiment_key[len(prefix):]
+                if isinstance(experiment_key, str) and isinstance(feature_key, str) and experiment_key.startswith(prefix)
+                else experiment_key
+            )
+            message += f" and experiment:{experiment_suffix} with variation:{experiment_variation_id}"
+        debug_event_props["msg"] = message

vwo/api/set_attribute_api.py

@@ -44,11 +44,9 @@ def create_and_send_impression_for_attribute(
         # Construct payload data for tracking the goal
         payload = get_attribute_payload_data(
             settings,
-            context.get_id(),
+            context,
             EventEnum.VWO_SYNC_VISITOR_PROP.value,
-            attribute_map,
-            visitor_user_agent=context.get_user_agent(),
-            ip_address=context.get_ip_address(),
+            attribute_map
         )
 
         from vwo.vwo_client import VWOClient

vwo/api/track_api.py

@@ -54,13 +54,11 @@ def track(
             self.create_and_send_impression_for_track(
                 settings, event_name, context, event_properties
             )
-            hook_manager.set({"event_name": event_name, "api": ApiEnum.TRACK.value})
+            hook_manager.set({"event_name": event_name, "api": ApiEnum.TRACK_EVENT.value})
             hook_manager.execute(hook_manager.get())
             return {event_name: True}
 
-        LogManager.get_instance().error(
-            error_messages.get("EVENT_NOT_FOUND").format(eventName=event_name)
-        )
+        LogManager.get_instance().error_log("EVENT_NOT_FOUND", data={"eventName": event_name}, debug_data={"an": ApiEnum.TRACK_EVENT.value, "uuid": context.get_vwo_uuid(), "sId": context.get_vwo_session_id()})
         return {event_name: False}
 
     def create_and_send_impression_for_track(
@@ -86,11 +84,9 @@ def create_and_send_impression_for_track(
         # Construct payload data for tracking the goal
         payload = get_track_goal_payload_data(
             settings,
-            context.get_id(),
+            context,
             event_name,
             event_properties,
-            visitor_user_agent=context.get_user_agent(),
-            ip_address=context.get_ip_address(),
         )
 
         from vwo.vwo_client import VWOClient

vwo/constants/Constants.py

@@ -17,7 +17,7 @@ class Constants:
     # TODO: read from setup.py
     sdk_meta = {
         "name": "vwo-fme-python-sdk",
-        "version": "1.13.0"
+        "version": "1.14.0"
     }
 
     # Constants
@@ -63,3 +63,12 @@ class Constants:
     MAX_RETRIES = 3
     INITIAL_WAIT_TIME = 2
     PRODUCT_NAME = "fme"
+
+    # Debugger constants
+    V2_SETTINGS = "v2-settings"
+    POLLING = "polling"
+    BROWSER_STORAGE = "browserStorage"
+    FLAG_DECISION_GIVEN = "FLAG_DECISION_GIVEN"
+    NETWORK_CALL_FAILURE_AFTER_MAX_RETRIES = "NETWORK_CALL_FAILURE_AFTER_MAX_RETRIES"
+    NETWORK_CALL_SUCCESS_WITH_RETRIES = "NETWORK_CALL_SUCCESS_WITH_RETRIES"
+    IMPACT_ANALYSIS = "IMPACT_ANALYSIS"

vwo/decorators/storage_decorator.py

@@ -20,6 +20,7 @@
 from ..services.storage_service import StorageService
 from ..packages.logger.core.log_manager import LogManager
 from ..utils.log_message_util import error_messages
+from ..enums.api_enum import ApiEnum
 
 
 class StorageDecorator:
@@ -50,45 +51,23 @@ def set_data_in_storage(
         context = data.get("context")
 
         if not feature_key:
-            LogManager.get_instance().error(
-                error_messages.get(
-                    error_messages.get("STORED_DATA_ERROR").format(key="featureKey")
-                )
-            )
+            LogManager.get_instance().error_log("ERROR_STORING_DATA_IN_STORAGE",data={"key": "featureKey"}, debug_data={"an": ApiEnum.GET_FLAG.value, "uuid": context.get_vwo_uuid(), "sId": context.get_vwo_session_id()})
             return None  # Invalid feature key, return None
 
         if not context or not context.get_id():
-            LogManager.get_instance().error(
-                error_messages.get(
-                    error_messages.get("STORED_DATA_ERROR").format(
-                        key="Context or Context.id"
-                    )
-                )
-            )
+            LogManager.get_instance().error_log("ERROR_STORING_DATA_IN_STORAGE",data={"key": "Context or Context.id"}, debug_data={"an": ApiEnum.GET_FLAG.value, "uuid": context.get_vwo_uuid(), "sId": context.get_vwo_session_id()})
             return None  # Invalid user ID, return None
 
         if (
             data.get("rolloutKey")
             and not data.get("experimentKey")
             and not data.get("rolloutVariationId")
         ):
-            LogManager.get_instance().error(
-                error_messages.get(
-                    error_messages.get("STORED_DATA_ERROR").format(
-                        key="Context or Context.id"
-                    )
-                )
-            )
+            LogManager.get_instance().error_log("ERROR_STORING_DATA_IN_STORAGE",data={"key": "rolloutKey or experimentKey or rolloutVariationId"}, debug_data={"an": ApiEnum.GET_FLAG.value, "uuid": context.get_vwo_uuid(), "sId": context.get_vwo_session_id()})
             return None  # Invalid rollout variation, return None
 
         if data.get("experimentKey") and not data.get("experimentVariationId"):
-            LogManager.get_instance().error(
-                error_messages.get(
-                    error_messages.get("STORED_DATA_ERROR").format(
-                        key="Variation:(rolloutKey, experimentKey or rolloutVariationId)"
-                    )
-                )
-            )
+            LogManager.get_instance().error_log("ERROR_STORING_DATA_IN_STORAGE",data={"key": "Variation:(rolloutKey, experimentKey or rolloutVariationId)"}, debug_data={"an": ApiEnum.GET_FLAG.value, "uuid": context.get_vwo_uuid(), "sId": context.get_vwo_session_id()})
             return None  # Invalid experiment variation, return None
 
         success = storage_service.set_data_in_storage(
@@ -101,7 +80,8 @@ def set_data_in_storage(
                 "experimentId": data.get("experimentId"),
                 "experimentKey": data.get("experimentKey"),
                 "experimentVariationId": data.get("experimentVariationId"),
-            }
+            },
+            context
         )
 
         if success:

vwo/enums/api_enum.py

@@ -17,5 +17,9 @@
 
 
 class ApiEnum(Enum):
+    INIT = "init"
     GET_FLAG = "getFlag"
-    TRACK = "track"
+    TRACK_EVENT = "trackEvent"
+    SET_ATTRIBUTE = "setAttribute"
+    UPDATE_SETTINGS = "updateSettings"
+    FLUSH_EVENTS = "flushEvents"

vwo/enums/debug_category_enum.py

@@ -0,0 +1,24 @@
+# Copyright 2024-2025 Wingify Software Pvt. Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from enum import Enum
+
+
+class DebugCategoryEnum(Enum):
+    NETWORK = "network"
+    DECISION = "decision"
+    INITIALIZATION = "initialization"
+    RETRY = "retry"
+    ERROR = "error"

vwo/enums/event_enum.py

@@ -21,4 +21,5 @@ class EventEnum(Enum):
     VWO_SYNC_VISITOR_PROP = "vwo_syncVisitorProp"
     VWO_LOG_EVENT = "vwo_log"
     VWO_SDK_INIT_EVENT = "vwo_fmeSdkInit"
-    VWO_USAGE_STATS = "vwo_sdkUsageStats"
+    VWO_USAGE_STATS = "vwo_sdkUsageStats"
+    VWO_DEBUGGER_EVENT = "vwo_sdkDebug"