diff --git a/.chloggen/feature-flag-provider-name.yaml b/.chloggen/feature-flag-provider-name.yaml new file mode 100755 index 000000000..865bbe921 --- /dev/null +++ b/.chloggen/feature-flag-provider-name.yaml @@ -0,0 +1,17 @@ +# Use this changelog template to create an entry for release notes. +# +# If your change doesn't affect end users you should instead start +# your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: breaking + +# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) +component: feature_flag + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Rename `feature_flag.provider_name` to `feature_flag.provider.name` + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. +issues: [1982] diff --git a/docs/attributes-registry/feature-flag.md b/docs/attributes-registry/feature-flag.md index 9383ce9e4..125ae78b5 100644 --- a/docs/attributes-registry/feature-flag.md +++ b/docs/attributes-registry/feature-flag.md @@ -14,7 +14,7 @@ This document defines attributes for Feature Flags. |---|---|---|---|---| | `feature_flag.context.id` | string | The unique identifier for the flag evaluation context. For example, the targeting key. | `5157782b-2203-4c80-a857-dbbd5e7761db` | ![Development](https://img.shields.io/badge/-development-blue) | | `feature_flag.key` | string | The lookup key of the feature flag. | `logo-color` | ![Development](https://img.shields.io/badge/-development-blue) | -| `feature_flag.provider_name` | string | Identifies the feature flag provider. | `Flag Manager` | ![Development](https://img.shields.io/badge/-development-blue) | +| `feature_flag.provider.name` | string | Identifies the feature flag provider. | `Flag Manager` | ![Development](https://img.shields.io/badge/-development-blue) | | `feature_flag.result.reason` | string | The reason code which shows how a feature flag value was determined. | `static`; `targeting_match`; `error`; `default` | ![Development](https://img.shields.io/badge/-development-blue) | | `feature_flag.result.variant` | string | A semantic identifier for an evaluated flag value. [1] | `red`; `true`; `on` | ![Development](https://img.shields.io/badge/-development-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` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -49,6 +49,7 @@ Describes deprecated feature flag attributes. |---|---|---|---|---| | `feature_flag.evaluation.error.message` | string | Deprecated, use `error.message` instead. | `Flag `header-color` expected type `string` but found type `number`` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `error.message`. | | `feature_flag.evaluation.reason` | string | Deprecated, use `feature_flag.result.reason` instead. | `static`; `targeting_match`; `error`; `default` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.result.reason`. | +| `feature_flag.provider_name` | string | Deprecated, use `feature_flag.provider.name` instead. | `Flag Manager` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.provider.name`. | | `feature_flag.variant` | string | Deprecated, use `feature_flag.result.variant` instead. | `red`; `true`; `on` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `feature_flag.result.variant`. | --- diff --git a/docs/feature-flags/feature-flags-logs.md b/docs/feature-flags/feature-flags-logs.md index ab7f25b2b..0b3f1dc33 100644 --- a/docs/feature-flags/feature-flags-logs.md +++ b/docs/feature-flags/feature-flags-logs.md @@ -63,7 +63,7 @@ A `feature_flag.evaluation` event SHOULD be emitted whenever a feature flag valu | [`feature_flag.result.variant`](/docs/attributes-registry/feature-flag.md) | string | A semantic identifier for an evaluated flag value. [3] | `red`; `true`; `on` | `Conditionally Required` [4] | ![Development](https://img.shields.io/badge/-development-blue) | | [`error.message`](/docs/attributes-registry/error.md) | string | A message providing more detail about an error in human-readable form. [5] | `Unexpected input type: string`; `The user has exceeded their storage quota` | `Recommended` [6] | ![Development](https://img.shields.io/badge/-development-blue) | | [`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` | ![Development](https://img.shields.io/badge/-development-blue) | -| [`feature_flag.provider_name`](/docs/attributes-registry/feature-flag.md) | string | Identifies the feature flag provider. | `Flag Manager` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) | +| [`feature_flag.provider.name`](/docs/attributes-registry/feature-flag.md) | string | Identifies the feature flag provider. | `Flag Manager` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) | | [`feature_flag.result.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` | ![Development](https://img.shields.io/badge/-development-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` | ![Development](https://img.shields.io/badge/-development-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` | ![Development](https://img.shields.io/badge/-development-blue) | diff --git a/model/feature-flags/deprecated/registry-deprecated.yaml b/model/feature-flags/deprecated/registry-deprecated.yaml index 89806f476..e9521db80 100644 --- a/model/feature-flags/deprecated/registry-deprecated.yaml +++ b/model/feature-flags/deprecated/registry-deprecated.yaml @@ -4,6 +4,15 @@ groups: 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.provider.name` instead.' + stability: development + deprecated: "Replaced by `feature_flag.provider.name`." + annotations: + code_generation: + exclude: true + examples: ["Flag Manager"] - id: feature_flag.evaluation.reason type: members: diff --git a/model/feature-flags/events.yaml b/model/feature-flags/events.yaml index 91a95caba..9ecf488ef 100644 --- a/model/feature-flags/events.yaml +++ b/model/feature-flags/events.yaml @@ -18,7 +18,7 @@ groups: - ref: feature_flag.result.variant requirement_level: conditionally_required: If feature flag provider supplies a variant or equivalent concept. - - ref: feature_flag.provider_name + - 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 de949aaf2..5745b866d 100644 --- a/model/feature-flags/registry.yaml +++ b/model/feature-flags/registry.yaml @@ -11,7 +11,7 @@ groups: stability: development brief: The lookup key of the feature flag. examples: ["logo-color"] - - id: feature_flag.provider_name + - id: feature_flag.provider.name type: string stability: development brief: Identifies the feature flag provider. diff --git a/schema-next.yaml b/schema-next.yaml index d8bfb2846..686543fbb 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -4,6 +4,10 @@ versions: next: all: changes: + # https://github.com/open-telemetry/semantic-conventions/pull/1982 + - rename_attributes: + attribute_map: + feature_flag.provider_name: feature_flag.provider.name # https://github.com/open-telemetry/semantic-conventions/pull/1994 - rename_attributes: attribute_map: