feat: usage stats during initialization

Author: sakshamg1304

CHANGELOG.md

@@ -4,6 +4,12 @@ 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.12.0] - 2025-09-02
+
+### Added
+
+- Sends usage statistics to VWO servers automatically during SDK initialization
+
 ## [1.11.0] - 2025-07-21
 
 ### Added

setup.py

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

vwo/constants/Constants.py

@@ -17,7 +17,7 @@ class Constants:
     # TODO: read from setup.py
     sdk_meta = {
         "name": "vwo-fme-python-sdk",
-        "version": "1.11.0"
+        "version": "1.12.0"
     }
 
     # Constants
@@ -62,3 +62,4 @@ class Constants:
 
     MAX_RETRIES = 3
     INITIAL_WAIT_TIME = 2
+    PRODUCT_NAME = "fme"

vwo/enums/event_enum.py

@@ -20,4 +20,5 @@ class EventEnum(Enum):
     VWO_VARIATION_SHOWN = "vwo_variationShown"
     VWO_SYNC_VISITOR_PROP = "vwo_syncVisitorProp"
     VWO_LOG_EVENT = "vwo_log"
-    VWO_SDK_INIT_EVENT = "vwo_fmeSdkInit"
+    VWO_SDK_INIT_EVENT = "vwo_fmeSdkInit"
+    VWO_USAGE_STATS = "vwo_sdkUsageStats"

vwo/utils/event_util.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 from typing import Optional
-from .network_util import get_events_base_properties, get_sdk_init_event_payload, send_event
+from .network_util import get_events_base_properties, get_sdk_init_event_payload, get_sdk_usage_stats_event_payload, send_event
 from ..enums.event_enum import EventEnum
 from ..vwo_client import VWOClient
 from ..packages.logger.core.log_manager import LogManager
@@ -50,4 +50,29 @@ def send_sdk_init_event(settings_fetch_time: Optional[int] = None, sdk_init_time
                 err=str(e)
             )
         )
-        pass 
+        pass
+
+
+def send_sdk_usage_stats_event(usage_stats_account_id: int) -> None:
+    """
+    Sends a usage stats event to VWO.
+    This event is triggered when the SDK is initialized.
+    
+    :param usage_stats_account_id: Account ID for usage stats event
+    """
+    # Create the query parameters
+    properties = get_events_base_properties(EventEnum.VWO_USAGE_STATS.value, "", "", True, usage_stats_account_id)
+
+    # Create the payload with required fields
+    payload = get_sdk_usage_stats_event_payload(EventEnum.VWO_USAGE_STATS.value, usage_stats_account_id)
+
+    vwo_instance = VWOClient.get_instance()
+
+    # Check if batch events are enabled
+    if vwo_instance.batch_event_queue is not None and vwo_instance.batch_event_queue.is_enabled():
+        # Enqueue the event to the batch queue
+        vwo_instance.batch_event_queue.enqueue(payload)
+    else:
+        # Send the event immediately if batch events are not enabled
+        send_event(properties, payload, EventEnum.VWO_USAGE_STATS.value)
+    

vwo/utils/network_util.py

@@ -59,7 +59,7 @@ def get_event_batching_query_params(account_id: str) -> Dict[str, Any]:
 
 # Function to build generic properties for tracking events
 def get_events_base_properties(
-    event_name: str, visitor_user_agent: str = "", ip_address: str = ""
+    event_name: str, visitor_user_agent: str = "", ip_address: str = "", is_usage_stats_event: bool = False, usage_stats_account_id: int = None
 ) -> Dict[str, Any]:
 
     # Get the instance of SettingsManager
@@ -69,10 +69,9 @@ def get_events_base_properties(
     sdk_key = settings.get_sdk_key()
     account_id = settings.get_account_id()
 
-    return {
+    properties = {
         "en": event_name,
         "a": account_id,
-        "env": sdk_key,
         "eTime": get_current_unix_timestamp_in_millis(),
         "random": get_random_number(),
         "p": "FS",
@@ -83,6 +82,14 @@ def get_events_base_properties(
         + UrlEnum.EVENTS.value,
     }
 
+    if not is_usage_stats_event:
+        # set env key for standard sdk events
+        properties["env"] = sdk_key
+    else:
+        # set account id for internal usage stats event
+        properties["a"] = str(usage_stats_account_id)
+    return properties
+
 
 # Function to build payload for tracking events
 def _get_event_base_payload(
@@ -91,10 +98,27 @@ def _get_event_base_payload(
     event_name: str,
     visitor_user_agent: str = "",
     ip_address: str = "",
+    is_usage_stats_event: bool = False,
+    usage_stats_account_id: int = None,
 ) -> Dict[str, Any]:
 
-    uuid_value = get_uuid(user_id, SettingsManager.get_instance().get_account_id())
+    account_id = SettingsManager.get_instance().get_account_id()
+    if is_usage_stats_event:
+        # set account id for internal usage stats event
+        account_id = usage_stats_account_id
+
+    uuid_value = get_uuid(str(user_id), str(account_id))
     sdk_key = SettingsManager.get_instance().get_sdk_key()
+
+    props = {
+        "vwo_sdkName": Constants.SDK_NAME,
+        "vwo_sdkVersion": Constants.SDK_VERSION,
+    }
+
+    if not is_usage_stats_event:
+        # set env key for standard sdk events
+        props["vwo_envKey"] = sdk_key
+
     properties = {
         "d": {
             "msgId": f"{uuid_value}-{get_current_unix_timestamp_in_millis()}",
@@ -103,18 +127,21 @@ def _get_event_base_payload(
             "visitor_ua": visitor_user_agent,
             "visitor_ip": ip_address,
             "event": {
-                "props": {
-                    "vwo_sdkName": Constants.SDK_NAME,
-                    "vwo_sdkVersion": Constants.SDK_VERSION,
-                    "vwo_envKey": sdk_key,
-                },
+                "props": props,
                 "name": event_name,
                 "time": get_current_unix_timestamp_in_millis(),
             },
-            "visitor": {"props": {Constants.VWO_FS_ENVIRONMENT: sdk_key}},
         }
     }
 
+    if not is_usage_stats_event:
+        # set visitor props for standard sdk events
+        properties["d"]["visitor"] = {
+            "props": {
+                Constants.VWO_FS_ENVIRONMENT: sdk_key,
+            },
+        }
+
     return properties
 
 
@@ -136,10 +163,6 @@ def get_track_user_payload_data(
     properties["d"]["event"]["props"]["variation"] = str(variation_id)
     properties["d"]["event"]["props"]["isFirst"] = 1
 
-    usage_stats_data = UsageStatsUtil().get_usage_stats()
-    if len(usage_stats_data) > 0:
-        properties["d"]["event"]["props"]["vwoMeta"] = usage_stats_data
-
     LogManager.get_instance().debug(
         debug_messages.get("IMPRESSION_FOR_TRACK_USER").format(
             accountId=settings.get_account_id(), userId=user_id, campaignId=campaign_id
@@ -352,7 +375,7 @@ def get_messaging_event_payload(
     properties["d"]["event"]["props"]["vwo_envKey"] = settings.get_sdk_key()
     properties["d"]["event"]["props"][
         "product"
-    ] = "fme"  # Assuming 'product' is a required field
+    ] = Constants.PRODUCT_NAME
 
     # Set the message data
     data = {
@@ -392,7 +415,7 @@ def get_sdk_init_event_payload(
 
     # Set the required fields as specified
     properties["d"]["event"]["props"][Constants.VWO_FS_ENVIRONMENT] = settings.get_sdk_key()
-    properties["d"]["event"]["props"]["product"] = "fme"
+    properties["d"]["event"]["props"]["product"] = Constants.PRODUCT_NAME
 
     data = {
         "isSDKInitialized": True,
@@ -404,12 +427,37 @@ def get_sdk_init_event_payload(
     return properties
 
 
+def get_sdk_usage_stats_event_payload(
+    event_name: str, usage_stats_account_id: int
+) -> Dict[str, Any]:
+    """
+    Constructs the payload for sdk usage stats event.
+    
+    Args:
+        event_name: The name of the event.
+        usage_stats_account_id: Account ID for usage stats event.
+        
+    Returns:
+        The constructed payload with required fields.
+    """
+    # Get user ID and properties
+    settings = SettingsManager.get_instance()
+    user_id = f"{settings.get_account_id()}_{settings.get_sdk_key()}"
+    properties = _get_event_base_payload(None, user_id, event_name, None, None, True, usage_stats_account_id)
+
+    # Set the required fields as specified
+    properties["d"]["event"]["props"]["product"] = Constants.PRODUCT_NAME
+    properties["d"]["event"]["props"]["vwoMeta"] = UsageStatsUtil().get_usage_stats()
+
+    return properties
+
+
 def send_event(
     properties: Dict[str, Any], payload: Dict[str, Any], event_name: str
 ) -> Dict[str, Any]:
     try:
         #if event_name is not VWO_LOG_EVENT, then set base url to constants.hostname
-        if event_name == EventEnum.VWO_LOG_EVENT.value:
+        if event_name == EventEnum.VWO_LOG_EVENT.value or event_name == EventEnum.VWO_USAGE_STATS.value:
             base_url = Constants.HOST_NAME
             protocol = Constants.HTTPS_PROTOCOL
             port = 443

vwo/utils/usage_stats_util.py

@@ -16,7 +16,7 @@
 import sys
 from ..constants.Constants import Constants
 from ..packages.logger.enums.log_level_number_enum import LogLevelNumberEnum
-
+from ..services.settings_manager import SettingsManager
 
 class UsageStatsUtil:
     """
@@ -45,17 +45,19 @@ def set_usage_stats(self, options: Dict[str, Any]) -> None:
             options (Dict[str, Any]): Configuration options for the SDK containing:
                 - storage: Storage service configuration
                 - logger: Logger configuration
-                - batch_events: Event batching configuration
+                - batch_event_data: Event batching configuration
                 - integrations: Integrations configuration
                 - polling_interval: Polling interval configuration
                 - sdk_name: SDK name configuration
         """
         data: Dict[str, Union[str, int]] = {}
+        data["a"] = SettingsManager.get_instance().get_account_id()
+        data["env"] = SettingsManager.get_instance().get_sdk_key()
 
         # Map configuration options to usage stats flags
         if options.get("integrations"):
             data["ig"] = 1  # Integration enabled
-        if options.get("batch_events"):
+        if options.get("batch_event_data"):
             data["eb"] = 1  # Event batching enabled
 
         if options.get("gateway_service"):

vwo/vwo.py

@@ -18,7 +18,7 @@
 from vwo.vwo_builder import VWOBuilder
 from vwo.vwo_client import VWOClient
 from vwo.enums.url_enum import UrlEnum
-from vwo.utils.event_util import send_sdk_init_event
+from vwo.utils.event_util import send_sdk_init_event, send_sdk_usage_stats_event
 
 
 class VWO:
@@ -83,6 +83,15 @@ def init(options: Dict[str, Any]) -> Optional["VWOClient"]:
         if instance.is_settings_valid_on_init and not was_initialized:
             send_sdk_init_event(instance.settings_fetch_time, sdk_init_time)
 
+        # send sdk usage stats event
+        # get usage stats account id from settings
+        usage_stats_account_id = None
+        if instance.original_settings is not None:
+            usage_stats_account_id = instance.original_settings.get("usageStatsAccountId")
+        
+        if usage_stats_account_id:
+            send_sdk_usage_stats_event(usage_stats_account_id)
+
         return instance
     except Exception as e:
         print("VWO initialization failed. Error:", e)