-
-
Notifications
You must be signed in to change notification settings - Fork 146
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create a new documentation version v1.36.1 (#2501)
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: thomaspoignant <[email protected]> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
- Loading branch information
3 people
authored
Oct 11, 2024
1 parent
b0b2dae
commit 88f848c
Showing
85 changed files
with
5,654 additions
and
184 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"maven":{"sdk":"1.12.0","providerKt":"0.1.0","providerJava":"0.3.0","android":"0.3.0"},"npm":{"core":"1.4.0","serverSDK":"1.15.1","providerServer":"0.7.3","providerWeb":"0.2.1"},"pypi":{"sdk":"0.7.1","provider":"0.2.1"},"nuget":{"sdk":"2.0.0","provider":"0.2.0"},"go":{"provider":"v0.2.1","sdk":"v1.13.0"}} | ||
| {"maven":{"sdk":"1.12.0","providerKt":"0.1.0","providerJava":"0.3.0","android":"0.3.0"},"npm":{"core":"1.4.0","serverSDK":"1.15.1","webSDK":"1.2.4","providerWeb":"0.2.1"},"pypi":{"sdk":"0.7.1","provider":"0.2.1"},"nuget":{"sdk":"2.0.0","provider":"0.2.0"},"go":{"provider":"v0.2.1","sdk":"v1.13.0"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "position": 0, | ||
| "collapsible": true, | ||
| "collapsed": false | ||
| } |
10 changes: 10 additions & 0 deletions
10
website/versioned_docs/version-v1.36.1/configure_flag/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "position": 20, | ||
| "collapsible": true, | ||
| "collapsed": true, | ||
| "label": "Configure your feature flags", | ||
| "link": { | ||
| "type": "generated-index", | ||
| "title": "Configure your feature flags" | ||
| } | ||
| } |
39 changes: 39 additions & 0 deletions
39
website/versioned_docs/version-v1.36.1/configure_flag/custom_bucketing.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| sidebar_position: 22 | ||
| description: How to bucket users based on a custom identifier | ||
| --- | ||
|
|
||
| # Custom bucketing | ||
|
|
||
| When evaluating flags, the `targetingKey` is usually given a user ID. This key ensures that a user will always be in the same group for each flag. | ||
|
|
||
| Sometimes, it is desireable to _bucket_ users based on a different value. The `bucketingKey` field in the flag configuration allows you to define a different identifier to be used instead. For example: | ||
|
|
||
| ```yaml | ||
| first-flag: | ||
| bucketingKey: "teamId" | ||
| variations: | ||
| A: false | ||
| B: true | ||
| defaultRule: # When no targeting match we use the defaultRule | ||
| percentage: | ||
| A: 50 | ||
| B: 50 | ||
| ``` | ||
| With this flag configuration, the `teamId` value will be used for hashing instead of `targetingKey`. The value must be provided to the evaluation context: | ||
|
|
||
|
|
||
| ```go | ||
| user = ffcontext.NewEvaluationContextBuilder("user126") | ||
| .AddCustom("teamId", "f74b72") | ||
| .Build() | ||
| ffclient.BoolVariation("first-flag", user, false) | ||
| ``` | ||
|
|
||
| As a result, users who are members of the same team will receive the same flag variation, consistently. A different `bucketingKey` can be used per experiment, though normally you'll only have a handful of possible values. | ||
|
|
||
| This is useful for A/B testing, permissions management and other use cases where targeting a consistent group of users is required. | ||
|
|
||
| **Note**: if a value in the corresponding `bucketingKey` is not found in the evaluation context, the flag rules will not be evaluated, and the SDK will return the default value. |
102 changes: 102 additions & 0 deletions
102
website/versioned_docs/version-v1.36.1/configure_flag/export_flags_usage.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| --- | ||
| sidebar_position: 40 | ||
| description: How to export evaluation data? | ||
| --- | ||
| import {Cards} from '@site/src/components/doc/cardv2'; | ||
| import { ConfigCardContent } from "@site/src/components/doc/configCardContent"; | ||
| import customlogo from '@site/static/docs/collectors/custom.png'; | ||
| import filelogo from '@site/static/docs/collectors/file.png'; | ||
| import googlelogo from '@site/static/docs/collectors/google.png'; | ||
| import loglogo from '@site/static/docs/collectors/log.png'; | ||
| import s3logo from '@site/static/docs/collectors/s3.png'; | ||
| import webhooklogo from '@site/static/docs/collectors/webhook.png'; | ||
| import sqslogo from '@site/static/docs/collectors/sqs.png'; | ||
| import kafkalogo from '@site/static/docs/collectors/kafka.png'; | ||
| import pubsublogo from '@site/static/docs/collectors/pubsub.png'; | ||
|
|
||
|
|
||
| # How to export evaluation data | ||
| GO Feature Flag allows for the collection of flag usage data. | ||
| During flag evaluation, the key, flag variation and other non-sensitive information used are collected and cached for a | ||
| configurable period of time. | ||
|
|
||
| The usage data is then written to a file in a chosen format (`parquet`, `JSON` or `CSV`) at a specified interval and | ||
| exported to your desired location. This provides a single source for easy processing of the data. The feature can be | ||
| configured with options for file format, flush interval, and file location. | ||
|
|
||
| To use, simply configure and use the feature flag as normal, and analyze the collected usage data. | ||
|
|
||
| ## Available exporters | ||
| <Cards cards={[ | ||
| { | ||
| logoImg: s3logo, | ||
| title:"AWS S3", | ||
| content: <ConfigCardContent | ||
| relayproxyLink={'../relay_proxy/configure_relay_proxy#s3-1'} | ||
| goModuleLink={'../go_module/data_collection/s3'} | ||
| /> | ||
| }, | ||
| { | ||
| logoImg: sqslogo, | ||
| title:"AWS SQS", | ||
| content: <ConfigCardContent | ||
| relayproxyLink={'../relay_proxy/configure_relay_proxy#sqs'} | ||
| goModuleLink={'../go_module/data_collection/sqs'} | ||
| /> | ||
| }, | ||
| { | ||
| logoImg: kafkalogo, | ||
| title:"Kafka", | ||
| content: <ConfigCardContent | ||
| relayproxyLink={'../relay_proxy/configure_relay_proxy#kafka'} | ||
| goModuleLink={'../go_module/data_collection/kafka'} | ||
| /> | ||
| }, | ||
| { | ||
| logoImg: googlelogo, | ||
| title:"Google Storage", | ||
| content: <ConfigCardContent | ||
| relayproxyLink={'../relay_proxy/configure_relay_proxy#google-storage-1'} | ||
| goModuleLink={'../go_module/data_collection/google_cloud_storage'} | ||
| /> | ||
| }, | ||
| { | ||
| logoImg: pubsublogo, | ||
| title:"Google PubSub", | ||
| content: <ConfigCardContent | ||
| relayproxyLink={'../relay_proxy/configure_relay_proxy#google-pubsub'} | ||
| goModuleLink={'../go_module/data_collection/google_pubsub'} | ||
| /> | ||
| }, | ||
| { | ||
| logoImg: webhooklogo, | ||
| title:"Webhook", | ||
| content: <ConfigCardContent | ||
| relayproxyLink={'../relay_proxy/configure_relay_proxy#webhook'} | ||
| goModuleLink={'../go_module/data_collection/webhook'} | ||
| /> | ||
| }, | ||
| { | ||
| logoImg: filelogo, | ||
| title:"Local File", | ||
| content: <ConfigCardContent | ||
| relayproxyLink={'../relay_proxy/configure_relay_proxy#file-1'} | ||
| goModuleLink={'../go_module/data_collection/file'} | ||
| /> | ||
| }, | ||
| { | ||
| logoImg: loglogo, | ||
| title:"Webhook", | ||
| content: <ConfigCardContent | ||
| relayproxyLink={'../relay_proxy/configure_relay_proxy#log'} | ||
| goModuleLink={'../go_module/data_collection/log'} | ||
| /> | ||
| }, | ||
| { | ||
| logoImg: customlogo, | ||
| title:"Custom ...", | ||
| content: <ConfigCardContent | ||
| goModuleLink={'../go_module/data_collection/custom'} | ||
| /> | ||
| }, | ||
| ]} /> |
Oops, something went wrong.