You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-app-configuration/feature-flag-telemetry-reference.md
+19-15Lines changed: 19 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,35 +23,39 @@ In this document, you:
23
23
24
24
With telemetry enabled no other properties are added to the feature flag besides the setting enabling telemetry. The use of one of the Azure App Configuration provider libraries along with the Feature Management libraries is required to start collecting telemetry data.
25
25
26
-
### Azure App Configuration provider libraries
26
+
### Basic fields
27
27
28
-
The use of an Azure App Configuration provider library that supports telemetry is required to start collecting telemetry data. When telemetry is enabled, the Azure App Configuration provider libraries add more properties to the feature flags when they're retrieved. A new object is added to the **telemetry** section of the feature flag called **metadata**. The **metadata** object contains the following properties:
29
-
30
-
-**AllocationID**: A unique identifier for the feature flag in its current state. (preview)
31
-
-**ETag**: The current ETag for the feature flag.
32
-
-**FeatureFlagReference**: A reference to the feature flag in the format of `<your_store_endpoint>kv/<feature_flag_key>`, it also includes the label if one is present, `<your_store_endpoint>kv/<feature_flag_key>?label=<feature_flag_label>`.
33
-
34
-
The full schema can be found [here](https://github.com/microsoft/FeatureManagement/tree/main/Schema/FeatureEvaluationEvent/FeatureEvaluationEventWithAzureAppConfiguration.v1.0.0.schema.json).
35
-
36
-
### Feature Management libraries
37
-
38
-
When the Feature Management libraries and the provider libraries are used together, more properties are added to the telemetry data. This data can then be sent to locations to be viewed, such as Azure Monitor. When using our provided connections to Azure Monitor, a **custom_event** is published to Open Telemetry with the following properties whenever a telemetry enabled feature flag is evaluated:
28
+
The feature management libraries provide the following properties to telemetry data:
39
29
40
30
-**FeatureName**: The name of the feature flag.
41
31
-**Enabled**: A boolean value indicating if the feature flag is enabled.
42
32
-**Version**: The version of this schema.
43
33
-**Reason**: The reason the feature flag was enabled or disabled.
44
34
-**Variant**: The variant that was selected for the feature flag.
45
35
-**VariantAssignmentPercentage**: Specifies the percentage of the user base the assigned variant is allocated for. This field is only present for percentile-based assignments.
46
-
-**DefaultWhenEnabled** (preview): The default variant of the feature flag when it's enabled.
47
-
-**AllocationID** (preview): A unique identifier for the feature flag in its current state.
36
+
-**DefaultWhenEnabled**: The default variant of the feature flag when it's enabled.
37
+
-**AllocationID**: A unique identifier for the feature flag in its current state.
48
38
-**ETag**: The current ETag for the feature flag.
49
39
-**FeatureFlagReference**: A reference to the feature flag in the format of `<your_store_endpoint>kv/<feature_flag_key>`, it also includes the label if one is present, `<your_store_endpoint>kv/<feature_flag_key>?label=<feature_flag_label>`.
50
-
-**FeatureFlagId**: A unique identifier for the feature flag.
51
40
-**TargetingId**: The ID of the user that was assigned to the variant.
52
41
53
42
The full schema can be found [here](https://github.com/microsoft/FeatureManagement/blob/main/Schema/FeatureEvaluationEvent/FeatureEvaluationEvent.v1.0.0.schema.json).
54
43
44
+
This data can then be sent to locations to be viewed, such as Azure Monitor. When using our provided connections to Azure Monitor, a **custom_event** is published to Open Telemetry with the following properties whenever a telemetry enabled feature flag is evaluated.
45
+
46
+
### App Configuration custom fields
47
+
48
+
When the Azure App Configuration provider libraries are used, additional properties are added to the telemetry data. These properties provide more context about the feature flag and its evaluation:
49
+
50
+
-**AllocationID**: A unique identifier for the feature flag in its current state.
51
+
-**ETag**: The current ETag for the feature flag.
52
+
-**FeatureFlagReference**: A reference to the feature flag in the format of `<your_store_endpoint>kv/<feature_flag_key>`, it also includes the label if one is present, `<your_store_endpoint>kv/<feature_flag_key>?label=<feature_flag_label>`.
53
+
54
+
The full schema can be found [here](https://github.com/microsoft/FeatureManagement/tree/main/Schema/FeatureEvaluationEvent/FeatureEvaluationEventWithAzureAppConfiguration.v1.0.0.schema.json).
55
+
56
+
### Feature management libraries
57
+
58
+
55
59
## Next steps
56
60
57
61
In this document, you learned about the telemetry data available for feature flags. To learn about how to use the telemetry data in your applications, continue to the following document for your language or platform.
0 commit comments