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
On the first telemetry flush after provider initialization, include
a ProviderInitRate entry with labels describing the SDK configuration
(e.g. encryption: true/false). This lets the backend track which
customers have adopted encryption without tagging every metric.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: openfeature-provider/INTEGRATION_GUIDE.md
+36-3Lines changed: 36 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,10 @@ For language-specific installation and quick start instructions, see your provid
13
13
## Table of Contents
14
14
15
15
1.[Getting Your Credentials](#getting-your-credentials)
16
-
2.[Error Handling](#error-handling)
17
-
3.[Sticky Assignments](#sticky-assignments)
18
-
4.[Deferred Apply and Resolve Token Security](#deferred-apply-and-resolve-token-security)
16
+
2.[Encryption](#encryption)
17
+
3.[Error Handling](#error-handling)
18
+
4.[Sticky Assignments](#sticky-assignments)
19
+
5.[Deferred Apply and Resolve Token Security](#deferred-apply-and-resolve-token-security)
19
20
20
21
---
21
22
@@ -29,6 +30,38 @@ Before integrating any Confidence provider, you'll need a **client secret** from
29
30
30
31
---
31
32
33
+
## Encryption
34
+
35
+
The flag state downloaded by local-resolve providers contains your flag rules and targeting segments. To protect this data at rest and in transit, Confidence supports **encrypting the flag state**. The state is decrypted only when it is loaded into the resolver component inside the provider — it is never stored or transmitted in plaintext.
36
+
37
+
### Getting Your Encryption Key
38
+
39
+
The encryption key is available in the [Confidence Admin view](https://app.confidence.spotify.com/admin/clients), next to the client credentials for your integration.
40
+
41
+
### Migration
42
+
43
+
Encryption support was introduced in the following provider versions:
We strongly recommend enabling encryption now by passing the encryption key when creating your provider. See your provider's README for the exact configuration:
54
+
55
+
-[JavaScript](js/README.md#encryption)
56
+
-[Java](java/README.md#encryption)
57
+
-[Go](go/README.md#encryption)
58
+
-[Python](python/README.md#encryption)
59
+
-[Rust](rust/README.md#encryption)
60
+
61
+
> **⚠️ Upcoming change:** Encryption will be made **mandatory** in a future SDK release. We will communicate a timeline and migration path before legacy (unencrypted) provider versions are affected. Adopting encryption now ensures a smooth transition when that happens.
62
+
63
+
---
64
+
32
65
## Error Handling
33
66
34
67
All Confidence providers use a **default value fallback** pattern to ensure your application continues to function even when flag evaluation fails.
Copy file name to clipboardExpand all lines: openfeature-provider/go/README.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,6 +35,25 @@ You'll need a **client secret** from Confidence to use this provider.
35
35
- Creating a test flag for verification
36
36
- Best practices for credential storage
37
37
38
+
## Encryption
39
+
40
+
The provider supports encrypting the flag state to protect your flag rules and targeting segments at rest and in transit. The state is decrypted only when loaded into the resolver.
41
+
42
+
**📖 See the [Integration Guide: Encryption](../INTEGRATION_GUIDE.md#encryption)** for background and migration details.
EncryptionKey: "your-encryption-key", // Get from Confidence Admin view
50
+
})
51
+
```
52
+
53
+
The encryption key is available in the [Confidence Admin view](https://app.confidence.spotify.com/admin/clients), next to your client credentials.
54
+
55
+
> **⚠️ Upcoming change:** Encryption will be made **mandatory** in a future SDK release. We will communicate a timeline and migration path before legacy provider versions are affected. We strongly recommend enabling it now.
56
+
38
57
## Quick Start
39
58
40
59
```go
@@ -158,6 +177,7 @@ The `ProviderConfig` struct contains all configuration options for the provider:
158
177
#### Required Fields
159
178
160
179
-`ClientSecret` (string): The client secret used for authentication and flag evaluation
180
+
-`EncryptionKey` (string): Encryption key for decrypting the flag state. Found in the [Confidence Admin view](https://app.confidence.spotify.com/admin/clients). Will be required in a future release.
0 commit comments