[chore] Move Feature Flag attributes to the registry (#842)
This commit is contained in:
parent
ae4005e8a1
commit
6bbc74de66
|
|
@ -34,6 +34,7 @@ body:
|
||||||
- area:error
|
- area:error
|
||||||
- area:exception
|
- area:exception
|
||||||
- area:faas
|
- area:faas
|
||||||
|
- area:feature-flag
|
||||||
- area:host
|
- area:host
|
||||||
- area:http
|
- area:http
|
||||||
- area:k8s
|
- area:k8s
|
||||||
|
|
|
||||||
|
|
@ -27,6 +27,7 @@ body:
|
||||||
- area:error
|
- area:error
|
||||||
- area:exception
|
- area:exception
|
||||||
- area:faas
|
- area:faas
|
||||||
|
- area:feature-flag
|
||||||
- area:host
|
- area:host
|
||||||
- area:http
|
- area:http
|
||||||
- area:k8s
|
- area:k8s
|
||||||
|
|
|
||||||
|
|
@ -36,6 +36,7 @@ body:
|
||||||
- area:error
|
- area:error
|
||||||
- area:exception
|
- area:exception
|
||||||
- area:faas
|
- area:faas
|
||||||
|
- area:feature-flag
|
||||||
- area:host
|
- area:host
|
||||||
- area:http
|
- area:http
|
||||||
- area:k8s
|
- area:k8s
|
||||||
|
|
|
||||||
|
|
@ -41,6 +41,7 @@ Currently, the following namespaces exist:
|
||||||
* [Error](error.md)
|
* [Error](error.md)
|
||||||
* [Exception](exception.md)
|
* [Exception](exception.md)
|
||||||
* [FaaS](faas.md)
|
* [FaaS](faas.md)
|
||||||
|
* [Feature Flag](feature-flag.md)
|
||||||
* [Host](host.md)
|
* [Host](host.md)
|
||||||
* [HTTP](http.md)
|
* [HTTP](http.md)
|
||||||
* [K8s](k8s.md)
|
* [K8s](k8s.md)
|
||||||
|
|
|
||||||
|
|
@ -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 -->
|
||||||
|
|
@ -42,9 +42,9 @@ The event name MUST be `feature_flag`.
|
||||||
|
|
||||||
| Attribute | Type | Description | Examples | Requirement Level |
|
| Attribute | Type | Description | Examples | Requirement Level |
|
||||||
|---|---|---|---|---|
|
|---|---|---|---|---|
|
||||||
| [`feature_flag.key`](feature-flags-spans.md) | string | The unique identifier of the feature flag. | `logo-color` | Required |
|
| [`feature_flag.key`](../attributes-registry/feature-flag.md) | string | The unique identifier of the feature flag. | `logo-color` | Recommended |
|
||||||
| [`feature_flag.provider_name`](feature-flags-spans.md) | string | The name of the service provider that performs the flag evaluation. | `Flag Manager` | Recommended |
|
| [`feature_flag.provider_name`](../attributes-registry/feature-flag.md) | string | The name of the service provider that performs the flag evaluation. | `Flag Manager` | Recommended |
|
||||||
| [`feature_flag.variant`](feature-flags-spans.md) | 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` | Recommended |
|
| [`feature_flag.variant`](../attributes-registry/feature-flag.md) | 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` | Recommended |
|
||||||
|
|
||||||
**[1]:** A semantic identifier, commonly referred to as a variant, provides a means
|
**[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
|
for referring to a value without including the value itself. This can
|
||||||
|
|
|
||||||
|
|
@ -46,9 +46,9 @@ The event name MUST be `feature_flag`.
|
||||||
|
|
||||||
| Attribute | Type | Description | Examples | Requirement Level |
|
| Attribute | Type | Description | Examples | Requirement Level |
|
||||||
|---|---|---|---|---|
|
|---|---|---|---|---|
|
||||||
| `feature_flag.key` | string | The unique identifier of the feature flag. | `logo-color` | Required |
|
| [`feature_flag.key`](../attributes-registry/feature-flag.md) | string | The unique identifier of the feature flag. | `logo-color` | Required |
|
||||||
| `feature_flag.provider_name` | string | The name of the service provider that performs the flag evaluation. | `Flag Manager` | Recommended |
|
| [`feature_flag.provider_name`](../attributes-registry/feature-flag.md) | string | The name of the service provider that performs the flag evaluation. | `Flag Manager` | Recommended |
|
||||||
| `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` | Recommended |
|
| [`feature_flag.variant`](../attributes-registry/feature-flag.md) | 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` | Recommended |
|
||||||
|
|
||||||
**[1]:** A semantic identifier, commonly referred to as a variant, provides a means
|
**[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
|
for referring to a value without including the value itself. This can
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
groups:
|
groups:
|
||||||
- id: log-feature_flag
|
- id: log-feature_flag
|
||||||
type: event
|
type: event
|
||||||
prefix: feature_flag
|
name: feature_flag
|
||||||
brief: >
|
brief: >
|
||||||
This document defines attributes for feature flag evaluations
|
This document defines attributes for feature flag evaluations
|
||||||
represented using Log Records.
|
represented using Log Records.
|
||||||
|
|
|
||||||
|
|
@ -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.
|
||||||
|
|
@ -1,37 +1,14 @@
|
||||||
groups:
|
groups:
|
||||||
- id: feature_flag
|
- id: feature_flag
|
||||||
prefix: feature_flag
|
|
||||||
type: event
|
type: event
|
||||||
|
name: feature_flag
|
||||||
brief: >
|
brief: >
|
||||||
This semantic convention defines the attributes used to represent a
|
This semantic convention defines the attributes used to represent a
|
||||||
feature flag evaluation as an event.
|
feature flag evaluation as an event.
|
||||||
attributes:
|
attributes:
|
||||||
- id: key
|
- ref: feature_flag.key
|
||||||
type: string
|
|
||||||
stability: experimental
|
|
||||||
requirement_level: required
|
requirement_level: required
|
||||||
brief: The unique identifier of the feature flag.
|
- ref: feature_flag.provider_name
|
||||||
examples: ["logo-color"]
|
|
||||||
- id: provider_name
|
|
||||||
type: string
|
|
||||||
stability: experimental
|
|
||||||
requirement_level: recommended
|
requirement_level: recommended
|
||||||
brief: The name of the service provider that performs the flag evaluation.
|
- ref: feature_flag.variant
|
||||||
examples: ["Flag Manager"]
|
|
||||||
- id: variant
|
|
||||||
type: string
|
|
||||||
stability: experimental
|
|
||||||
requirement_level: recommended
|
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.
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue