Rename `f eature_flag.system` back to `feature_flag.provider_name` (#1614)
Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com> Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
This commit is contained in:
Liudmila Molkova
GitHub
parent
0c17ad5543
commit
07293edd52
|
|
@ -0,0 +1,4 @@
|
|||
change_type: enhancement
|
||||
component: feature_flag
|
||||
note: Rename `feature_flag.system` back to `feature_flag.provider_name`
|
||||
issues: [1614]
|
||||
|
|
@ -6,9 +6,6 @@
|
|||
|
||||
# Feature Flag
|
||||
|
||||
- [Feature Flag Attributes](#feature-flag-attributes)
|
||||
- [Deprecated Feature Flag Attributes](#deprecated-feature-flag-attributes)
|
||||
|
||||
## Feature Flag Attributes
|
||||
|
||||
This document defines attributes for Feature Flags.
|
||||
|
|
@ -19,8 +16,8 @@ This document defines attributes for Feature Flags.
|
|||
| <a id="feature-flag-evaluation-error-message" href="#feature-flag-evaluation-error-message">`feature_flag.evaluation.error.message`</a> | string | A message explaining the nature of an error occurring during flag evaluation. | `Flag `header-color` expected type `string` but found type `number`` |  |
|
||||
| <a id="feature-flag-evaluation-reason" href="#feature-flag-evaluation-reason">`feature_flag.evaluation.reason`</a> | string | The reason code which shows how a feature flag value was determined. | `static`; `targeting_match`; `error`; `default` |  |
|
||||
| <a id="feature-flag-key" href="#feature-flag-key">`feature_flag.key`</a> | string | The lookup key of the feature flag. | `logo-color` |  |
|
||||
| <a id="feature-flag-provider-name" href="#feature-flag-provider-name">`feature_flag.provider_name`</a> | string | Identifies the feature flag provider. | `Flag Manager` |  |
|
||||
| <a id="feature-flag-set-id" href="#feature-flag-set-id">`feature_flag.set.id`</a> | string | The identifier of the [flag set](https://openfeature.dev/specification/glossary/#flag-set) to which the feature flag belongs. | `proj-1`; `ab98sgs`; `service1/dev` |  |
|
||||
| <a id="feature-flag-system" href="#feature-flag-system">`feature_flag.system`</a> | string | Identifies the feature flag provider. | `Flag Manager` |  |
|
||||
| <a id="feature-flag-variant" href="#feature-flag-variant">`feature_flag.variant`</a> | string | A semantic identifier for an evaluated flag value. [1] | `red`; `true`; `on` |  |
|
||||
| <a id="feature-flag-version" href="#feature-flag-version">`feature_flag.version`</a> | string | The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset. | `1`; `01ABCDEF` |  |
|
||||
|
||||
|
|
@ -44,11 +41,3 @@ For example, the variant `red` maybe be used for the value `#c05543`.
|
|||
| `static` | The resolved value is static (no dynamic evaluation). |  |
|
||||
| `targeting_match` | The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. |  |
|
||||
| `unknown` | The reason for the resolved value could not be determined. |  |
|
||||
|
||||
## Deprecated Feature Flag Attributes
|
||||
|
||||
Describes deprecated Feature Flag attributes.
|
||||
|
||||
| Attribute | Type | Description | Examples | Stability |
|
||||
|---|---|---|---|---|
|
||||
| <a id="feature-flag-provider-name" href="#feature-flag-provider-name">`feature_flag.provider_name`</a> | string | Deprecated, use `feature_flag.system` instead. | `Flag Manager` | <br>Replaced by `feature_flag.system`. |
|
||||
|
|
|
|||
|
|
@ -64,8 +64,8 @@ A `feature_flag.evaluation` event SHOULD be emitted whenever a feature flag valu
|
|||
| [`feature_flag.context.id`](/docs/attributes-registry/feature-flag.md) | string | The unique identifier for the flag evaluation context. For example, the targeting key. | `5157782b-2203-4c80-a857-dbbd5e7761db` | `Recommended` |  |
|
||||
| [`feature_flag.evaluation.error.message`](/docs/attributes-registry/feature-flag.md) | string | A message explaining the nature of an error occurring during flag evaluation. | `Flag `header-color` expected type `string` but found type `number`` | `Recommended` [5] |  |
|
||||
| [`feature_flag.evaluation.reason`](/docs/attributes-registry/feature-flag.md) | string | The reason code which shows how a feature flag value was determined. | `static`; `targeting_match`; `error`; `default` | `Recommended` |  |
|
||||
| [`feature_flag.provider_name`](/docs/attributes-registry/feature-flag.md) | string | Identifies the feature flag provider. | `Flag Manager` | `Recommended` |  |
|
||||
| [`feature_flag.set.id`](/docs/attributes-registry/feature-flag.md) | string | The identifier of the [flag set](https://openfeature.dev/specification/glossary/#flag-set) to which the feature flag belongs. | `proj-1`; `ab98sgs`; `service1/dev` | `Recommended` |  |
|
||||
| [`feature_flag.system`](/docs/attributes-registry/feature-flag.md) | string | Identifies the feature flag provider. | `Flag Manager` | `Recommended` |  |
|
||||
| [`feature_flag.version`](/docs/attributes-registry/feature-flag.md) | string | The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset. | `1`; `01ABCDEF` | `Recommended` |  |
|
||||
|
||||
**[1] `error.type`:** If one of these values applies, then it MUST be used; otherwise, a custom value MAY be used.
|
||||
|
|
|
|||
|
|
@ -1,12 +0,0 @@
|
|||
groups:
|
||||
- id: registry.feature_flag.deprecated
|
||||
type: attribute_group
|
||||
display_name: Deprecated Feature Flag Attributes
|
||||
brief: "Describes deprecated Feature Flag attributes."
|
||||
attributes:
|
||||
- id: feature_flag.provider_name
|
||||
type: string
|
||||
brief: 'Deprecated, use `feature_flag.system` instead.'
|
||||
stability: experimental
|
||||
deprecated: "Replaced by `feature_flag.system`."
|
||||
examples: ["Flag Manager"]
|
||||
|
|
@ -17,7 +17,7 @@ groups:
|
|||
- ref: feature_flag.variant
|
||||
requirement_level:
|
||||
conditionally_required: If feature flag provider supplies a variant or equivalent concept.
|
||||
- ref: feature_flag.system
|
||||
- ref: feature_flag.provider_name
|
||||
requirement_level: recommended
|
||||
- ref: feature_flag.context.id
|
||||
requirement_level: recommended
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ groups:
|
|||
stability: experimental
|
||||
brief: The lookup key of the feature flag.
|
||||
examples: ["logo-color"]
|
||||
- id: feature_flag.system
|
||||
- id: feature_flag.provider_name
|
||||
type: string
|
||||
stability: experimental
|
||||
brief: Identifies the feature flag provider.
|
||||
|
|
|
|||
|
|
@ -16,10 +16,6 @@ versions:
|
|||
vcs.repository.ref.name: vcs.ref.head.name
|
||||
vcs.repository.ref.revision: vcs.ref.head.revision
|
||||
vcs.repository.ref.type: vcs.ref.head.type
|
||||
# https://github.com/open-telemetry/semantic-conventions/pull/1440
|
||||
- rename_attributes:
|
||||
attribute_map:
|
||||
feature_flag.provider_name: feature_flag.system
|
||||
|
||||
metrics:
|
||||
changes:
|
||||
|
|
|
|||
Loading…
Reference in New Issue