Skip to content

Commit 07293ed

Browse files
Liudmila MolkovadyladanAlexanderWert
authored
Rename feature_flag.system back to feature_flag.provider_name (#1614)
Co-authored-by: Daniel Dyla <[email protected]> Co-authored-by: Alexander Wert <[email protected]>
1 parent 0c17ad5 commit 07293ed

File tree

7 files changed

+8
-31
lines changed

7 files changed

+8
-31
lines changed

.chloggen/1614.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
change_type: enhancement
2+
component: feature_flag
3+
note: Rename `feature_flag.system` back to `feature_flag.provider_name`
4+
issues: [1614]

docs/attributes-registry/feature-flag.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@
66

77
# Feature Flag
88

9-
- [Feature Flag Attributes](#feature-flag-attributes)
10-
- [Deprecated Feature Flag Attributes](#deprecated-feature-flag-attributes)
11-
129
## Feature Flag Attributes
1310

1411
This document defines attributes for Feature Flags.
@@ -19,8 +16,8 @@ This document defines attributes for Feature Flags.
1916
| <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`` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
2017
| <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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
2118
| <a id="feature-flag-key" href="#feature-flag-key">`feature_flag.key`</a> | string | The lookup key of the feature flag. | `logo-color` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
19+
| <a id="feature-flag-provider-name" href="#feature-flag-provider-name">`feature_flag.provider_name`</a> | string | Identifies the feature flag provider. | `Flag Manager` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
2220
| <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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
23-
| <a id="feature-flag-system" href="#feature-flag-system">`feature_flag.system`</a> | string | Identifies the feature flag provider. | `Flag Manager` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
2421
| <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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
2522
| <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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
2623

@@ -44,11 +41,3 @@ For example, the variant `red` maybe be used for the value `#c05543`.
4441
| `static` | The resolved value is static (no dynamic evaluation). | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
4542
| `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) |
4643
| `unknown` | The reason for the resolved value could not be determined. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
47-
48-
## Deprecated Feature Flag Attributes
49-
50-
Describes deprecated Feature Flag attributes.
51-
52-
| Attribute | Type | Description | Examples | Stability |
53-
|---|---|---|---|---|
54-
| <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` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `feature_flag.system`. |

docs/feature-flags/feature-flags-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ A `feature_flag.evaluation` event SHOULD be emitted whenever a feature flag valu
6464
| [`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) |
6565
| [`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) |
6666
| [`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) |
67+
| [`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) |
6768
| [`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) |
68-
| [`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) |
6969
| [`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) |
7070

7171
**[1] `error.type`:** If one of these values applies, then it MUST be used; otherwise, a custom value MAY be used.

model/feature-flags/deprecated/registry-deprecated.yaml

Lines changed: 0 additions & 12 deletions
This file was deleted.

model/feature-flags/logs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ groups:
1717
- ref: feature_flag.variant
1818
requirement_level:
1919
conditionally_required: If feature flag provider supplies a variant or equivalent concept.
20-
- ref: feature_flag.system
20+
- ref: feature_flag.provider_name
2121
requirement_level: recommended
2222
- ref: feature_flag.context.id
2323
requirement_level: recommended

model/feature-flags/registry.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ groups:
1111
stability: experimental
1212
brief: The lookup key of the feature flag.
1313
examples: ["logo-color"]
14-
- id: feature_flag.system
14+
- id: feature_flag.provider_name
1515
type: string
1616
stability: experimental
1717
brief: Identifies the feature flag provider.

schema-next.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ versions:
1616
vcs.repository.ref.name: vcs.ref.head.name
1717
vcs.repository.ref.revision: vcs.ref.head.revision
1818
vcs.repository.ref.type: vcs.ref.head.type
19-
# https://github.com/open-telemetry/semantic-conventions/pull/1440
20-
- rename_attributes:
21-
attribute_map:
22-
feature_flag.provider_name: feature_flag.system
2319

2420
metrics:
2521
changes:

0 commit comments

Comments
 (0)