diff --git a/.chloggen/1614.yaml b/.chloggen/1614.yaml new file mode 100644 index 0000000000..a02203c0c2 --- /dev/null +++ b/.chloggen/1614.yaml @@ -0,0 +1,4 @@ +change_type: enhancement +component: feature_flag +note: Rename `feature_flag.system` back to `feature_flag.provider_name` +issues: [1614] diff --git a/docs/attributes-registry/feature-flag.md b/docs/attributes-registry/feature-flag.md index 19cc5666fb..974d365e37 100644 --- a/docs/attributes-registry/feature-flag.md +++ b/docs/attributes-registry/feature-flag.md @@ -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. | `feature_flag.evaluation.error.message` | string | A message explaining the nature of an error occurring during flag evaluation. | `Flag `header-color` expected type `string` but found type `number`` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `feature_flag.evaluation.reason` | string | The reason code which shows how a feature flag value was determined. | `static`; `targeting_match`; `error`; `default` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `feature_flag.key` | string | The lookup key of the feature flag. | `logo-color` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `feature_flag.provider_name` | string | Identifies the feature flag provider. | `Flag Manager` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `feature_flag.set.id` | 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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `feature_flag.system` | string | Identifies the feature flag provider. | `Flag Manager` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `feature_flag.variant` | string | A semantic identifier for an evaluated flag value. [1] | `red`; `true`; `on` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `feature_flag.version` | string | The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset. | `1`; `01ABCDEF` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | @@ -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). | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `targeting_match` | The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `unknown` | The reason for the resolved value could not be determined. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | - -## Deprecated Feature Flag Attributes - -Describes deprecated Feature Flag attributes. - -| Attribute | Type | Description | Examples | Stability | -|---|---|---|---|---| -| `feature_flag.provider_name` | string | Deprecated, use `feature_flag.system` instead. | `Flag Manager` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.system`. | diff --git a/docs/feature-flags/feature-flags-logs.md b/docs/feature-flags/feature-flags-logs.md index b893a3f1a3..573e633788 100644 --- a/docs/feature-flags/feature-flags-logs.md +++ b/docs/feature-flags/feature-flags-logs.md @@ -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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`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] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| [`feature_flag.provider_name`](/docs/attributes-registry/feature-flag.md) | string | Identifies the feature flag provider. | `Flag Manager` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| [`feature_flag.system`](/docs/attributes-registry/feature-flag.md) | string | Identifies the feature flag provider. | `Flag Manager` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **[1] `error.type`:** If one of these values applies, then it MUST be used; otherwise, a custom value MAY be used. diff --git a/model/feature-flags/deprecated/registry-deprecated.yaml b/model/feature-flags/deprecated/registry-deprecated.yaml deleted file mode 100644 index 2f3a681454..0000000000 --- a/model/feature-flags/deprecated/registry-deprecated.yaml +++ /dev/null @@ -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"] diff --git a/model/feature-flags/logs.yaml b/model/feature-flags/logs.yaml index 0de7c95577..edcd75250c 100644 --- a/model/feature-flags/logs.yaml +++ b/model/feature-flags/logs.yaml @@ -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 diff --git a/model/feature-flags/registry.yaml b/model/feature-flags/registry.yaml index 76b1d5fe3c..4b2c70cfe3 100644 --- a/model/feature-flags/registry.yaml +++ b/model/feature-flags/registry.yaml @@ -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. diff --git a/schema-next.yaml b/schema-next.yaml index de73f27640..9f8ae4c451 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -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: