Rename `feature_flag.provider_name` to `feature_flag.provider.name` (#1982)
This commit is contained in:
Daniel Dyla
GitHub
parent
e500db3ac8
commit
49d2cc452b
|
|
@ -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]
|
||||
|
|
@ -14,7 +14,7 @@ This document defines attributes for Feature Flags.
|
|||
|---|---|---|---|---|
|
||||
| <a id="feature-flag-context-id" href="#feature-flag-context-id">`feature_flag.context.id`</a> | string | The unique identifier for the flag evaluation context. For example, the targeting key. | `5157782b-2203-4c80-a857-dbbd5e7761db` |  |
|
||||
| <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-provider-name" href="#feature-flag-provider-name">`feature_flag.provider.name`</a> | string | Identifies the feature flag provider. | `Flag Manager` |  |
|
||||
| <a id="feature-flag-result-reason" href="#feature-flag-result-reason">`feature_flag.result.reason`</a> | string | The reason code which shows how a feature flag value was determined. | `static`; `targeting_match`; `error`; `default` |  |
|
||||
| <a id="feature-flag-result-variant" href="#feature-flag-result-variant">`feature_flag.result.variant`</a> | string | A semantic identifier for an evaluated flag value. [1] | `red`; `true`; `on` |  |
|
||||
| <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` |  |
|
||||
|
|
@ -49,6 +49,7 @@ Describes deprecated feature flag attributes.
|
|||
|---|---|---|---|---|
|
||||
| <a id="feature-flag-evaluation-error-message" href="#feature-flag-evaluation-error-message">`feature_flag.evaluation.error.message`</a> | string | Deprecated, use `error.message` instead. | `Flag `header-color` expected type `string` but found type `number`` | <br>Replaced by `error.message`. |
|
||||
| <a id="feature-flag-evaluation-reason" href="#feature-flag-evaluation-reason">`feature_flag.evaluation.reason`</a> | string | Deprecated, use `feature_flag.result.reason` instead. | `static`; `targeting_match`; `error`; `default` | <br>Replaced by `feature_flag.result.reason`. |
|
||||
| <a id="feature-flag-provider-name" href="#feature-flag-provider-name">`feature_flag.provider_name`</a> | string | Deprecated, use `feature_flag.provider.name` instead. | `Flag Manager` | <br>Replaced by `feature_flag.provider.name`. |
|
||||
| <a id="feature-flag-variant" href="#feature-flag-variant">`feature_flag.variant`</a> | string | Deprecated, use `feature_flag.result.variant` instead. | `red`; `true`; `on` | <br>Replaced by `feature_flag.result.variant`. |
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -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] |  |
|
||||
| [`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] |  |
|
||||
| [`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.provider_name`](/docs/attributes-registry/feature-flag.md) | string | Identifies the feature flag provider. | `Flag Manager` | `Recommended` |  |
|
||||
| [`feature_flag.provider.name`](/docs/attributes-registry/feature-flag.md) | string | Identifies the feature flag provider. | `Flag Manager` | `Recommended` |  |
|
||||
| [`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` |  |
|
||||
| [`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.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` |  |
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
Loading…
Reference in New Issue