Add Config Version to Exposure Metadata (#365)

kong test: statsig-io/kong#2842

Author: sroyal-statsig

statsig/config_evaluation.py

@@ -7,6 +7,7 @@ def __init__(self,
                  boolean_value=False,
                  json_value=None,
                  rule_id="",
+                 version=None,
                  secondary_exposures=None,
                  allocated_experiment=None,
                  explicit_parameters=None,
@@ -41,3 +42,4 @@ def __init__(self,
         self.sample_rate = sample_rate
         self.user = user
         self.forward_all_exposures = forward_all_exposures
+        self.version = version

statsig/dynamic_config.py

@@ -7,7 +7,7 @@
 class DynamicConfig:
     def __init__(self, data, name, rule, user: Optional[StatsigUser] = None, group_name=None,
                  evaluation_details: Optional[EvaluationDetails] = None,
-                 secondary_exposures=None):
+                 secondary_exposures=None, passed_rule=None, version=None):
         if data is None:
             data = {}
         self.value = data
@@ -25,6 +25,8 @@ def __init__(self, data, name, rule, user: Optional[StatsigUser] = None, group_n
             secondary_exposures = []
         self.secondary_exposures = secondary_exposures
         self.user = user
+        self.passed_rule = passed_rule
+        self.version = version
 
     def get(self, key, default=None):
         """Returns the value of the config at the given key

statsig/evaluator.py

@@ -203,7 +203,7 @@ def check_gate(self, user, gate, end_result=None, is_nested=False):
             globals.logger.debug(f"Gate {gate} not found in the store. Are you sure the gate name is correct?")
             return self.unsupported_or_unrecognized(gate)
         if end_result is None:
-            end_result = _ConfigEvaluation()
+            end_result = _ConfigEvaluation(version=eval_gate.get("version", None))
         self.__eval_config(user, eval_gate, end_result, is_nested)
         return end_result
 
@@ -222,7 +222,7 @@ def get_config(self, user, config_name, is_exp=False):
                 f"{'Config' if is_exp else 'Experiment'} {config_name} not found in the store. Are you sure the config name is correct?"
             )
             return self.unsupported_or_unrecognized(config_name)
-        result = _ConfigEvaluation()
+        result = _ConfigEvaluation(version=eval_config.get("version", None))
         self.__eval_config(user, eval_config, result)
         return result
 
@@ -239,7 +239,7 @@ def get_layer(self, user, layer_name):
         if eval_layer is None:
             globals.logger.debug(f"Layer {layer_name} not found in the store. Are you sure the layer name is correct?")
             return self.unsupported_or_unrecognized(layer_name)
-        result = _ConfigEvaluation()
+        result = _ConfigEvaluation(version=eval_layer.get("version", None))
         self.__eval_config(user, eval_layer, result)
         return result
 

statsig/statsig_logger.py

@@ -80,6 +80,7 @@ def log_gate_exposure(
             gate,
             value,
             rule_id,
+            version,
             secondary_exposures,
             evaluation_details: EvaluationDetails,
             is_manual_exposure=False,
@@ -93,6 +94,9 @@ def log_gate_exposure(
             "gateValue": "true" if value else "false",
             "ruleID": rule_id,
         }
+
+        if version is not None:
+            event.metadata["configVersion"] = version
         event.statsigMetadata = {}
         if not self._is_unique_exposure(user, _GATE_EXPOSURE_EVENT, event.metadata):
             return
@@ -118,6 +122,8 @@ def log_config_exposure(
             user,
             config,
             rule_id,
+            passed_rule,
+            version,
             secondary_exposures,
             evaluation_details: EvaluationDetails,
             is_manual_exposure=False,
@@ -129,7 +135,10 @@ def log_config_exposure(
         event.metadata = {
             "config": config,
             "ruleID": rule_id,
+            "rulePassed": "true" if passed_rule else "false",
         }
+        if version is not None:
+            event.metadata["configVersion"] = version
         event.statsigMetadata = {}
 
         if not self._is_unique_exposure(user, _CONFIG_EXPOSURE_EVENT, event.metadata):
@@ -177,6 +186,8 @@ def log_layer_exposure(
             "parameterName": parameter_name,
             "isExplicitParameter": "true" if is_explicit else "false",
         }
+        if config_evaluation.version is not None:
+            metadata["configVersion"] = config_evaluation.version
         if not self._is_unique_exposure(user, _LAYER_EXPOSURE_EVENT, metadata):
             return
         event.metadata = metadata

statsig/statsig_server.py

@@ -234,6 +234,7 @@ def manually_log_gate_exposure(self, user: StatsigUser, gate_name: str):
             gate_name,
             result.boolean_value,
             result.rule_id,
+            result.version,
             result.secondary_exposures,
             result.evaluation_details,
             is_manual_exposure=True,
@@ -255,7 +256,9 @@ def task():
                 result.user,
                 group_name=result.group_name,
                 evaluation_details=result.evaluation_details,
-                secondary_exposures=result.secondary_exposures
+                secondary_exposures=result.secondary_exposures,
+                passed_rule=result.boolean_value,
+                version=result.version,
             )
             self.safe_eval_callback(dynamicConfig)
             return dynamicConfig
@@ -274,6 +277,8 @@ def manually_log_config_exposure(self, user: StatsigUser, config_name: str):
             user,
             config_name,
             result.rule_id,
+            result.boolean_value,
+            result.version,
             result.secondary_exposures,
             result.evaluation_details,
             is_manual_exposure=True,
@@ -285,6 +290,8 @@ def log_exposure_for_config(self, config_eval: DynamicConfig):
             user,
             config_eval.name,
             config_eval.rule_id,
+            config_eval.passed_rule,
+            config_eval.version,
             config_eval.secondary_exposures,
             config_eval.evaluation_details,
             is_manual_exposure=True,
@@ -308,6 +315,8 @@ def task():
                 group_name=result.group_name,
                 evaluation_details=result.evaluation_details,
                 secondary_exposures=result.secondary_exposures,
+                passed_rule=result.boolean_value,
+                version=result.version,
             )
             self.safe_eval_callback(dynamicConfig)
             return dynamicConfig
@@ -326,6 +335,8 @@ def manually_log_experiment_exposure(self, user: StatsigUser, experiment_name: s
             user,
             experiment_name,
             result.rule_id,
+            result.boolean_value,
+            result.version,
             result.secondary_exposures,
             result.evaluation_details,
             is_manual_exposure=True,
@@ -569,6 +580,7 @@ def __check_gate(self, user: StatsigUser, gate_name: str, log_exposure=True):
                 gate_name,
                 result.boolean_value,
                 result.rule_id,
+                result.version,
                 result.secondary_exposures,
                 result.evaluation_details,
                 sampling_rate=logged_sampling_rate,
@@ -590,6 +602,8 @@ def __get_config(self, user: StatsigUser, config_name: str, log_exposure=True):
                 user,
                 config_name,
                 result.rule_id,
+                result.boolean_value,
+                result.version,
                 result.secondary_exposures,
                 result.evaluation_details,
                 sampling_rate=logged_sampling_rate,