add exp telemetry fields

Author: zhiyuanliang-ms

sdk/feature-management-applicationinsights-node/src/telemetry.ts

@@ -1,8 +1,19 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { EvaluationResult } from "@microsoft/feature-management";
+import { EvaluationResult, VariantAssignmentReason } from "@microsoft/feature-management";
 import { TelemetryClient, Contracts } from "applicationinsights";
+import { EVALUATION_EVENT_VERSION } from "./version.js";
+
+const VERSION = "Version";
+const FEATURE_NAME = "FeatureName";
+const ENABLED = "Enabled";
+const TARGETING_ID = "TargetingId";
+const VARIANT = "Variant";
+const VARIANT_ASSIGNMENT_REASON = "VariantAssignmentReason";
+const DEFAULT_WHEN_ENABLED = "DefaultWhenEnabled";
+const VARIANT_ASSIGNMENT_PERCENTAGE = "VariantAssignmentPercentage";
+const FEATURE_EVALUATION_EVENT_NAME = "FeatureEvaluation";
 
 /**
  * Creates a telemetry publisher that sends feature evaluation events to Application Insights.
@@ -11,16 +22,46 @@ import { TelemetryClient, Contracts } from "applicationinsights";
  */
 export function createTelemetryPublisher(client: TelemetryClient): (event: EvaluationResult) => void {
     return (event: EvaluationResult) => {
+        if (event.feature === undefined) {
+            return;
+        }
+
         const eventProperties = {
-            "FeatureName": event.feature ? event.feature.id : "",
-            "Enabled": event.enabled.toString(),
+            [VERSION]: EVALUATION_EVENT_VERSION,
+            [FEATURE_NAME]: event.feature ? event.feature.id : "",
+            [ENABLED]: event.enabled.toString(),
             // Ensure targetingId is string so that it will be placed in customDimensions
-            "TargetingId": event.targetingId ? event.targetingId.toString() : "",
-            "Variant": event.variant ? event.variant.name : "",
-            "VariantAssignmentReason": event.variantAssignmentReason,
+            [TARGETING_ID]: event.targetingId ? event.targetingId.toString() : "",
+            [VARIANT]: event.variant ? event.variant.name : "",
+            [VARIANT_ASSIGNMENT_REASON]: event.variantAssignmentReason,
         };
 
-        const metadata = event.feature?.telemetry?.metadata;
+        if (event.feature.allocation?.default_when_enabled) {
+            eventProperties[DEFAULT_WHEN_ENABLED] = event.feature.allocation.default_when_enabled;
+        }
+
+        if (event.variantAssignmentReason === VariantAssignmentReason.DefaultWhenEnabled) {
+            let percentileAllocationPercentage = 0;
+            if (event.variant !== undefined && event.feature.allocation !== undefined && event.feature.allocation.percentile !== undefined) {
+                for (const percentile of event.feature.allocation.percentile) {
+                    percentileAllocationPercentage += percentile.to - percentile.from;
+                }
+            }
+            eventProperties[VARIANT_ASSIGNMENT_PERCENTAGE] = (100 - percentileAllocationPercentage).toString();
+        }
+        else if (event.variantAssignmentReason === VariantAssignmentReason.Percentile) {
+            let percentileAllocationPercentage = 0;
+            if (event.variant !== undefined && event.feature.allocation !== undefined && event.feature.allocation.percentile !== undefined) {
+                for (const percentile of event.feature.allocation.percentile) {
+                    if (percentile.variant === event.variant.name) {
+                        percentileAllocationPercentage += percentile.to - percentile.from;
+                    }
+                }
+            }
+            eventProperties[VARIANT_ASSIGNMENT_PERCENTAGE] = percentileAllocationPercentage.toString();
+        }
+
+        const metadata = event.feature.telemetry?.metadata;
         if (metadata) {
             for (const key in metadata) {
                 if (!(key in eventProperties)) {
@@ -29,7 +70,7 @@ export function createTelemetryPublisher(client: TelemetryClient): (event: Evalu
             }
         }
 
-        client.trackEvent({ name: "FeatureEvaluation", properties: eventProperties });
+        client.trackEvent({ name: FEATURE_EVALUATION_EVENT_NAME, properties: eventProperties });
     };
 }
 
@@ -45,7 +86,7 @@ export function createTelemetryPublisher(client: TelemetryClient): (event: Evalu
 export function trackEvent(client: TelemetryClient, targetingId: string, event: Contracts.EventTelemetry): void {
     event.properties = {
         ...event.properties,
-        TargetingId: targetingId ? targetingId.toString() : ""
+        [TARGETING_ID]: targetingId ? targetingId.toString() : ""
     };
     client.trackEvent(event);
 }

sdk/feature-management-applicationinsights-node/src/version.ts

@@ -2,3 +2,4 @@
 // Licensed under the MIT license.
 
 export const VERSION = "2.0.0-preview.2";
+export const EVALUATION_EVENT_VERSION = "1.0.0";