-
Notifications
You must be signed in to change notification settings - Fork 167
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[chore] Move Feature Flag attributes to the registry (#842)
- Loading branch information
1 parent
ae4005e
commit 6bbc74d
Showing
10 changed files
with
67 additions
and
34 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
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
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 |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Feature Flag | ||
|
||
## Feature Flag Attributes | ||
<!-- semconv registry.feature_flag(omit_requirement_level) --> | ||
| Attribute | Type | Description | Examples | | ||
|---|---|---|---| | ||
| `feature_flag.key` | string | The unique identifier of the feature flag. | `logo-color` | | ||
| `feature_flag.provider_name` | string | The name of the service provider that performs the flag evaluation. | `Flag Manager` | | ||
| `feature_flag.variant` | string | SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used. [1] | `red`; `true`; `on` | | ||
|
||
**[1]:** A semantic identifier, commonly referred to as a variant, provides a means | ||
for referring to a value without including the value itself. This can | ||
provide additional context for understanding the meaning behind a value. | ||
For example, the variant `red` maybe be used for the value `#c05543`. | ||
|
||
A stringified version of the value can be used in situations where a | ||
semantic identifier is unavailable. String representation of the value | ||
should be determined by the implementer. | ||
<!-- endsemconv --> |
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
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 |
---|---|---|
@@ -0,0 +1,33 @@ | ||
groups: | ||
- id: registry.feature_flag | ||
prefix: feature_flag | ||
type: attribute_group | ||
brief: > | ||
This document defines attributes for Feature Flags. | ||
attributes: | ||
- id: key | ||
type: string | ||
stability: experimental | ||
brief: The unique identifier of the feature flag. | ||
examples: ["logo-color"] | ||
- id: provider_name | ||
type: string | ||
stability: experimental | ||
brief: The name of the service provider that performs the flag evaluation. | ||
examples: ["Flag Manager"] | ||
- id: variant | ||
type: string | ||
stability: experimental | ||
examples: ["red", "true", "on"] | ||
brief: > | ||
SHOULD be a semantic identifier for a value. If one is unavailable, a | ||
stringified version of the value can be used. | ||
note: |- | ||
A semantic identifier, commonly referred to as a variant, provides a means | ||
for referring to a value without including the value itself. This can | ||
provide additional context for understanding the meaning behind a value. | ||
For example, the variant `red` maybe be used for the value `#c05543`. | ||
A stringified version of the value can be used in situations where a | ||
semantic identifier is unavailable. String representation of the value | ||
should be determined by the implementer. |
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,37 +1,14 @@ | ||
groups: | ||
- id: feature_flag | ||
prefix: feature_flag | ||
type: event | ||
name: feature_flag | ||
brief: > | ||
This semantic convention defines the attributes used to represent a | ||
feature flag evaluation as an event. | ||
attributes: | ||
- id: key | ||
type: string | ||
stability: experimental | ||
- ref: feature_flag.key | ||
requirement_level: required | ||
brief: The unique identifier of the feature flag. | ||
examples: ["logo-color"] | ||
- id: provider_name | ||
type: string | ||
stability: experimental | ||
- ref: feature_flag.provider_name | ||
requirement_level: recommended | ||
brief: The name of the service provider that performs the flag evaluation. | ||
examples: ["Flag Manager"] | ||
- id: variant | ||
type: string | ||
stability: experimental | ||
- ref: feature_flag.variant | ||
requirement_level: recommended | ||
examples: ["red", "true", "on"] | ||
brief: > | ||
SHOULD be a semantic identifier for a value. If one is unavailable, a | ||
stringified version of the value can be used. | ||
note: |- | ||
A semantic identifier, commonly referred to as a variant, provides a means | ||
for referring to a value without including the value itself. This can | ||
provide additional context for understanding the meaning behind a value. | ||
For example, the variant `red` maybe be used for the value `#c05543`. | ||
A stringified version of the value can be used in situations where a | ||
semantic identifier is unavailable. String representation of the value | ||
should be determined by the implementer. |