https://github.com/splitio/split-openfeature-provider-go
Split OpenFeature Provider for GoLang
https://github.com/splitio/split-openfeature-provider-go
feature-flags feature-toggles featureflags golang openfeature splitio
Last synced: 25 days ago
JSON representation
Split OpenFeature Provider for GoLang
- Host: GitHub
- URL: https://github.com/splitio/split-openfeature-provider-go
- Owner: splitio
- License: other
- Created: 2022-09-15T17:05:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-03-20T14:25:11.000Z (about 1 month ago)
- Last Synced: 2026-03-21T06:34:18.266Z (about 1 month ago)
- Topics: feature-flags, feature-toggles, featureflags, golang, openfeature, splitio
- Language: Go
- Homepage: https://split.io
- Size: 57.6 KB
- Stars: 21
- Watchers: 5
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- License: LICENSE
Awesome Lists containing this project
README
# Split OpenFeature Provider for Go
[](https://twitter.com/intent/follow?screen_name=splitsoftware)
## Overview
This Provider is designed to allow the use of OpenFeature with Split, the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.
## Compatibility
This SDK is compatible with Go 1.21 and higher.
## Getting started
Below is a simple example that describes the instantiation of the Split Provider. Please see the [OpenFeature Documentation](https://docs.openfeature.dev/docs/reference/concepts/evaluation-api) for details on how to use the OpenFeature SDK.
```go
import (
"github.com/open-feature/go-sdk/openfeature"
splitProvider "github.com/splitio/split-openfeature-provider-go"
)
provider, err := splitProvider.NewProviderSimple("YOUR_SDK_API_KEY")
if err != nil {
// Provider creation error
}
openfeature.SetProviderAndWait(provider)
```
If you are more familiar with Split or want access to other initialization options, you can provide a `SplitClient` to the constructor. See the [Split Go SDK Documentation](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK#initialization) for more information.
```go
import (
"github.com/open-feature/go-sdk/openfeature"
"github.com/splitio/go-client/v6/splitio/client"
"github.com/splitio/go-client/v6/splitio/conf"
splitProvider "github.com/splitio/split-openfeature-provider-go"
)
cfg := conf.Default()
factory, err := client.NewSplitFactory("YOUR_SDK_API_KEY", cfg)
if err != nil {
// SDK initialization error
}
splitClient := factory.Client()
if err := splitClient.BlockUntilReady(10); err != nil {
// SDK timeout error
}
provider, err := splitProvider.NewProvider(splitClient)
if err != nil {
// Provider creation error
}
_ = openfeature.SetProviderAndWait(provider)
```
## Use of OpenFeature with Split
After the initial setup you can use OpenFeature according to their [documentation](https://docs.openfeature.dev/docs/reference/concepts/evaluation-api/).
One important note is that the Split Provider **requires a targeting key** to be set. Often times this should be set when evaluating the value of a flag by [setting an EvaluationContext](https://docs.openfeature.dev/docs/reference/concepts/evaluation-context) which contains the targeting key. An example flag evaluation is
```go
import "context"
client := openfeature.NewClient("CLIENT_NAME")
ctx := context.Background()
evaluationContext := openfeature.NewEvaluationContext("TARGETING_KEY", nil)
boolValue, err := client.BooleanValue(ctx, "boolFlag", false, evaluationContext)
```
If the same targeting key is used repeatedly, the evaluation context may be set at the client level
```go
evaluationContext := openfeature.NewEvaluationContext("TARGETING_KEY", nil)
client.SetEvaluationContext(evaluationContext)
```
or at the OpenFeatureAPI level
```go
evaluationContext := openfeature.NewEvaluationContext("TARGETING_KEY", nil)
openfeature.SetEvaluationContext(evaluationContext)
```
If the context was set at the client or api level, it is not required to provide it during flag evaluation.
## Evaluate with details
Use the `*ValueDetails` APIs to get the value and rich context (variant, reason, error code, metadata). This provider includes the Split treatment config as a raw JSON string under `FlagMetadata["config"]`.
```go
details, err := client.StringValueDetails(ctx, "my-flag", "fallback", evalCtx)
if err == nil && details.FlagMetadata != nil {
if config, ok := details.FlagMetadata["config"].(string); ok {
// use config (Split treatment config JSON)
}
}
```
## Tracking
To use `Track(ctx, eventName, evalCtx, details)` you must provide:
- **targetingKey** on the EvaluationContext (non-blank).
- **trafficType** in the context attributes (e.g. `"user"` or `"account"`).
- A non-blank **eventName**.
Optional: use `openfeature.NewTrackingEventDetails(value)` for a numeric event value and `.Add(key, value)` for attributes.
Example:
```go
evalCtx := openfeature.NewEvaluationContext("user-123", map[string]any{"trafficType": "user"})
details := openfeature.NewTrackingEventDetails(19.99).Add("plan", "pro").Add("coupon", "WELCOME10")
client.Track(ctx, "checkout.completed", evalCtx, details)
```
## Submitting issues
The Split team monitors all issues submitted to this [issue tracker](https://github.com/splitio/split-openfeature-provider-go/issues). We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.
## Contributing
Please see [Contributors Guide](CONTRIBUTORS-GUIDE.md) to find all you need to submit a Pull Request (PR).
## License
Licensed under the Apache License, Version 2.0. See: [Apache License](http://www.apache.org/licenses/).
## About Split
Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.
To learn more about Split, contact hello@split.io, or get started with feature flags for free at https://www.split.io/signup.
Split has built and maintains SDKs for:
* Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
* Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
* PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
* Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](http://help.split.io) for more detailed information.