|
| 1 | +--- |
| 2 | +title: Introducing Exporter Metadata in the GO Feature Flag Provider for OpenFeature. |
| 3 | +description: Exporter metadata in the GO Feature Flag provider for OpenFeature allows enriching evaluation events with static context data like environment or app version for improved observability and analysis. |
| 4 | +authors: [thomaspoignant] |
| 5 | +tags: [openfeature,exporter] |
| 6 | +--- |
| 7 | + |
| 8 | +# Introducing Exporter Metadata in the GO Feature Flag Provider for OpenFeature |
| 9 | + |
| 10 | +This blog post dives into a new functionality introduced in the GO Feature Flag provider for OpenFeature: exporter metadata. We'll explore how it works and how you can leverage it to enrich your evaluation events with valuable static information. |
| 11 | + |
| 12 | +## What is Exporter Metadata? |
| 13 | +Exporter metadata is an object you can configure when initializing your GO Feature Flag provider for OpenFeature. |
| 14 | + |
| 15 | +It allows you to specify a set of static information that you want to consistently include with all your evaluation events. |
| 16 | +A good example of information you might include in exporter metadata is the environment in which your application is running, |
| 17 | +the version of the application or anything that helps you when you analyze your evaluation data. |
| 18 | + |
| 19 | +This data is then forwarded to the exporter and incorporated into your feature events as a new field called `metadata`. |
| 20 | +<!--truncate--> |
| 21 | +## Why Use Exporter Metadata? |
| 22 | + |
| 23 | +Including exporter metadata in your evaluation events offers several advantages: |
| 24 | +- **Enhanced Context**: By adding static information to your events, you can provide richer context for analysis. This can include details about the environment (e.g., development, staging, production), the application version, or any other relevant data that sheds light on feature usage patterns. |
| 25 | +- **Improved Observability**: With exporter metadata, you gain a more comprehensive view of feature evaluation across different contexts. This can be particularly useful for debugging purposes or identifying trends in feature adoption for specific environments or application versions. |
| 26 | +- **Simplified Data Enrichment**: Exporter metadata eliminates the need to manually inject context information into every evaluation event. This streamlines your code and ensures consistency in the data you collect. |
| 27 | + |
| 28 | +## How to Use Exporter Metadata |
| 29 | + |
| 30 | +In all providers that support exporter metadata, you can pass a map of key-value pairs to the `ExporterMetadata` field in the provider's configuration. |
| 31 | +Value can be a `string`, a `bool`, an `int` or a `float64`. |
| 32 | + |
| 33 | +This map will be included in all evaluation events sent to the exporter and added to the `metadata` field by the exporter. |
| 34 | + |
| 35 | +Here's an example of how you can configure exporter metadata in the Kotlin provider: |
| 36 | +```kotlin |
| 37 | +val options = |
| 38 | + GoFeatureFlagOptions( |
| 39 | + endpoint = "https://mygoffserver.com/", |
| 40 | + exporterMetadata = mapOf("device" to "Pixel 4", "appVersion" to "1.0.0") |
| 41 | + ) |
| 42 | + |
| 43 | +val provider = GoFeatureFlagProvider(options) |
| 44 | +``` |
| 45 | +In this example, we're passing some information that can help to understand the context of the evaluation events such as the device type and the appVersion. |
| 46 | + |
| 47 | +With this configuration, all evaluation events sent to the exporter will include the `metadata` field with the specified key-value pairs. |
| 48 | +And it will look like this: |
| 49 | + |
| 50 | +```json |
| 51 | +{"kind":"feature","contextKind":"user","userKey":"4f433951-4c8c-42b3-9f18-8c9a5ed8e9eb","creationDate":1737465936,"key":"REDIRECTION","variation":"on","value":true,"default":false,"version":"","source":"PROVIDER_CACHE", "metadata": {"device": "Pixel 4", "appVersion":"1.0.0", "openfeature": true, "provider": "android"}} |
| 52 | +``` |
| 53 | + |
| 54 | +## Which Providers Support Exporter Metadata? |
| 55 | +To be able to use exporter metadata, you need to use the relay-proxy in version `v1.41.0` or above and as minimum the following version of the providers: |
| 56 | +- **GO**: `v0.2.2` |
| 57 | +- **Kotlin**: `v0.3.0` |
| 58 | +- **Java**: `v0.4.1` |
| 59 | +- **NodeJS**: `v0.7.4` |
| 60 | +- **Web**: `v0.2.4` |
| 61 | +- **Python**: `v0.4.0` |
| 62 | +- **Swift**: `v0.3.0` |
| 63 | + |
| 64 | +## Conclusion |
| 65 | +Exporter metadata provides a powerful mechanism to enrich your evaluation events with static information in the GO Feature Flag provider for OpenFeature. |
| 66 | +By incorporating this functionality, you can gain deeper insights into feature usage patterns and streamline your data collection process. |
| 67 | + |
| 68 | +This blog post has provided a brief introduction to exporter metadata. |
| 69 | +We encourage you to experiment with this feature and explore its potential to enhance your feature flag evaluation practices. |
0 commit comments