feat: support exporter metadata in python provider (#2976)

Signed-off-by: Thomas Poignant <[email protected]>

Author: thomaspoignant

openfeature/providers/python-provider/gofeatureflag_python_provider/data_collector_hook.py

@@ -1,19 +1,17 @@
 import datetime
 import threading
 import time
-from http import HTTPStatus
-from typing import Optional
-from urllib.parse import urljoin
-
 import urllib3
-from openfeature.flag_evaluation import FlagEvaluationDetails, Reason
-from openfeature.hook import Hook, HookContext
-
 from gofeatureflag_python_provider.options import GoFeatureFlagOptions
 from gofeatureflag_python_provider.request_data_collector import (
     FeatureEvent,
     RequestDataCollector,
 )
+from http import HTTPStatus
+from openfeature.flag_evaluation import FlagEvaluationDetails, Reason
+from openfeature.hook import Hook, HookContext
+from typing import Optional
+from urllib.parse import urljoin
 
 default_targeting_key = "undefined-targetingKey"
 
@@ -31,6 +29,8 @@ class DataCollectorHook(Hook):
     _http_client: urllib3.PoolManager = None
     # _data_event_queue is the list of data to collect
     _event_queue: list[FeatureEvent] = []
+    # _exporter_metadata is the metadata we send to the GO Feature Flag relay proxy when we report the evaluation data usage.
+    _exporter_metadata: dict = {}
 
     def __init__(self, options: GoFeatureFlagOptions, http_client: urllib3.PoolManager):
         self._http_client = http_client
@@ -39,6 +39,9 @@ def __init__(self, options: GoFeatureFlagOptions, http_client: urllib3.PoolManag
         self._data_collector_endpoint = urljoin(
             str(self._options.endpoint), "/v1/data/collector"
         )
+        self._exporter_metadata = options.exporter_metadata
+        self._exporter_metadata["provider"] = "python"
+        self._exporter_metadata["openfeature"] = True
 
     def after(
         self, hook_context: HookContext, details: FlagEvaluationDetails, hints: dict
@@ -106,7 +109,7 @@ def _collect_data(self):
         if len(self._event_queue) > 0:
             try:
                 goff_request = RequestDataCollector(
-                    meta={"provider": "open-feature-python-sdk"},
+                    meta=self._exporter_metadata,
                     events=self._event_queue,
                 )
                 headers = {"Content-Type": "application/json"}

openfeature/providers/python-provider/gofeatureflag_python_provider/options.py

@@ -50,3 +50,10 @@ class GoFeatureFlagOptions(BaseModel):
     # an API Key to the provider. Please ask the administrator of the relay proxy to provide an API Key.
     # Default: None
     api_key: typing.Optional[str] = None
+
+    # ExporterMetadata (optional) is the metadata we send to the GO Feature Flag relay proxy when we report the
+    # evaluation data usage.
+    #
+    # ‼️Important: If you are using a GO Feature Flag relay proxy before version v1.41.0, the information of this
+    # field will not be added to your feature events.
+    exporter_metadata: typing.Optional[dict] = {}

openfeature/providers/python-provider/gofeatureflag_python_provider/request_data_collector.py

@@ -1,8 +1,6 @@
-from typing import Optional, Any
-
-from pydantic import Field, SkipValidation
-
 from gofeatureflag_python_provider.options import BaseModel
+from pydantic import Field, SkipValidation
+from typing import Optional, Any, Union
 
 
 class FeatureEvent(BaseModel):
@@ -47,7 +45,7 @@ class FeatureEvent(BaseModel):
 
 class RequestDataCollector(BaseModel):
     # Meta are the extra information added to identify who is calling the endpoint.
-    meta: Optional[dict[str, str]] = None
+    meta: Optional[dict[str, Union[str, int, float, bool]]] = None
 
     # Events is the list of the event we send in the payload
     events: list[FeatureEvent] = []