Mark feature flag semantic conventions as release candidate (#2277)
This commit is contained in:
Daniel Dyla
GitHub
parent
cab0665e71
commit
ab88f2a4ed
|
|
@ -0,0 +1,22 @@
|
|||
# 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: enhancement
|
||||
|
||||
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
|
||||
component: feature_flags
|
||||
|
||||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
|
||||
note: Mark feature flag semantic convention as release candidate.
|
||||
|
||||
# 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: [2277]
|
||||
|
||||
# (Optional) One or more lines of additional information to render under the primary note.
|
||||
# These lines will be padded with 2 spaces and then inserted directly into the document.
|
||||
# Use pipe (|) for multiline entries.
|
||||
subtext:
|
||||
|
|
@ -7,7 +7,7 @@ linkTitle: Feature flags
|
|||
**Status**: [Development][DocumentStatus]
|
||||
|
||||
This document defines semantic conventions for recording dynamic feature flag
|
||||
evaluations in spans and logs.
|
||||
evaluations in logs.
|
||||
|
||||
Semantic conventions for feature flags are defined for the following signals:
|
||||
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ The table below indicates which attributes should be added to the
|
|||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
**Status:** 
|
||||
**Status:** 
|
||||
|
||||
The event name MUST be `feature_flag.evaluation`.
|
||||
|
||||
|
|
@ -58,29 +58,29 @@ A `feature_flag.evaluation` event SHOULD be emitted whenever a feature flag valu
|
|||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`feature_flag.key`](/docs/registry/attributes/feature-flag.md) | string | The lookup key of the feature flag. | `logo-color` | `Required` |  |
|
||||
| [`feature_flag.key`](/docs/registry/attributes/feature-flag.md) | string | The lookup key of the feature flag. | `logo-color` | `Required` |  |
|
||||
| [`error.type`](/docs/registry/attributes/error.md) | string | Describes a class of error the operation ended with. [1] | `provider_not_ready`; `targeting_key_missing`; `provider_fatal`; `general` | `Conditionally Required` [2] |  |
|
||||
| [`feature_flag.result.value`](/docs/registry/attributes/feature-flag.md) | any | The evaluated value of the feature flag. [3] | `#ff0000`; `true`; `3` | `Conditionally Required` [4] |  |
|
||||
| [`feature_flag.result.variant`](/docs/registry/attributes/feature-flag.md) | string | A semantic identifier for an evaluated flag value. [5] | `red`; `true`; `on` | `Conditionally Required` [6] |  |
|
||||
| [`feature_flag.result.value`](/docs/registry/attributes/feature-flag.md) | any | The evaluated value of the feature flag. [3] | `#ff0000`; `true`; `3` | `Conditionally Required` [4] |  |
|
||||
| [`feature_flag.result.variant`](/docs/registry/attributes/feature-flag.md) | string | A semantic identifier for an evaluated flag value. [5] | `red`; `true`; `on` | `Conditionally Required` [6] |  |
|
||||
| [`error.message`](/docs/registry/attributes/error.md) | string | A message providing more detail about an error in human-readable form. [7] | `Unexpected input type: string`; `The user has exceeded their storage quota` | `Recommended` [8] |  |
|
||||
| [`feature_flag.context.id`](/docs/registry/attributes/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/registry/attributes/feature-flag.md) | string | Identifies the feature flag provider. | `Flag Manager` | `Recommended` |  |
|
||||
| [`feature_flag.result.reason`](/docs/registry/attributes/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/registry/attributes/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/registry/attributes/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` |  |
|
||||
| [`feature_flag.context.id`](/docs/registry/attributes/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/registry/attributes/feature-flag.md) | string | Identifies the feature flag provider. | `Flag Manager` | `Recommended` |  |
|
||||
| [`feature_flag.result.reason`](/docs/registry/attributes/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/registry/attributes/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/registry/attributes/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.
|
||||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `flag_not_found` | The flag could not be found. |  |
|
||||
| `invalid_context` | The evaluation context does not meet provider requirements. |  |
|
||||
| `parse_error` | An error was encountered parsing data, such as a flag configuration. |  |
|
||||
| `provider_fatal` | The provider has entered an irrecoverable error state. |  |
|
||||
| `provider_not_ready` | The value was resolved before the provider was initialized. |  |
|
||||
| `targeting_key_missing` | The provider requires a targeting key and one was not provided in the evaluation context. |  |
|
||||
| `type_mismatch` | The type of the flag value does not match the expected type. |  |
|
||||
| `general` | The error was for a reason not enumerated above. |  |
|
||||
| `flag_not_found` | The flag could not be found. |  |
|
||||
| `invalid_context` | The evaluation context does not meet provider requirements. |  |
|
||||
| `parse_error` | An error was encountered parsing data, such as a flag configuration. |  |
|
||||
| `provider_fatal` | The provider has entered an irrecoverable error state. |  |
|
||||
| `provider_not_ready` | The value was resolved before the provider was initialized. |  |
|
||||
| `targeting_key_missing` | The provider requires a targeting key and one was not provided in the evaluation context. |  |
|
||||
| `type_mismatch` | The type of the flag value does not match the expected type. |  |
|
||||
| `general` | The error was for a reason not enumerated above. |  |
|
||||
|
||||
**[2] `error.type`:** If and only if an error occurred during flag evaluation.
|
||||
|
||||
|
|
@ -117,15 +117,15 @@ For example, the variant `red` maybe be used for the value `#c05543`.
|
|||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `cached` | The resolved value was retrieved from cache. |  |
|
||||
| `default` | The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result). |  |
|
||||
| `disabled` | The resolved value was the result of the flag being disabled in the management system. |  |
|
||||
| `error` | The resolved value was the result of an error. |  |
|
||||
| `split` | The resolved value was the result of pseudorandom assignment. |  |
|
||||
| `stale` | The resolved value is non-authoritative or possibly out of date |  |
|
||||
| `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. |  |
|
||||
| `cached` | The resolved value was retrieved from cache. |  |
|
||||
| `default` | The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result). |  |
|
||||
| `disabled` | The resolved value was the result of the flag being disabled in the management system. |  |
|
||||
| `error` | The resolved value was the result of an error. |  |
|
||||
| `split` | The resolved value was the result of pseudorandom assignment. |  |
|
||||
| `stale` | The resolved value is non-authoritative or possibly out of date |  |
|
||||
| `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. |  |
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
|
|
|||
|
|
@ -12,14 +12,14 @@ This document defines attributes for Feature Flags.
|
|||
|
||||
| Attribute | Type | Description | Examples | Stability |
|
||||
|---|---|---|---|---|
|
||||
| <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-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-value" href="#feature-flag-result-value">`feature_flag.result.value`</a> | any | The evaluated value of the feature flag. [1] | `#ff0000`; `true`; `3` |  |
|
||||
| <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. [2] | `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` |  |
|
||||
| <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` |  |
|
||||
| <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-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-value" href="#feature-flag-result-value">`feature_flag.result.value`</a> | any | The evaluated value of the feature flag. [1] | `#ff0000`; `true`; `3` |  |
|
||||
| <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. [2] | `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` |  |
|
||||
| <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` |  |
|
||||
|
||||
**[1] `feature_flag.result.value`:** With some feature flag providers, feature flag results can be quite large or contain private or sensitive details.
|
||||
Because of this, `feature_flag.result.variant` is often the preferred attribute if it is available.
|
||||
|
|
@ -38,15 +38,15 @@ For example, the variant `red` maybe be used for the value `#c05543`.
|
|||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `cached` | The resolved value was retrieved from cache. |  |
|
||||
| `default` | The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result). |  |
|
||||
| `disabled` | The resolved value was the result of the flag being disabled in the management system. |  |
|
||||
| `error` | The resolved value was the result of an error. |  |
|
||||
| `split` | The resolved value was the result of pseudorandom assignment. |  |
|
||||
| `stale` | The resolved value is non-authoritative or possibly out of date |  |
|
||||
| `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. |  |
|
||||
| `cached` | The resolved value was retrieved from cache. |  |
|
||||
| `default` | The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result). |  |
|
||||
| `disabled` | The resolved value was the result of the flag being disabled in the management system. |  |
|
||||
| `error` | The resolved value was the result of an error. |  |
|
||||
| `split` | The resolved value was the result of pseudorandom assignment. |  |
|
||||
| `stale` | The resolved value is non-authoritative or possibly out of date |  |
|
||||
| `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
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ groups:
|
|||
- id: event.feature_flag.evaluation
|
||||
type: event
|
||||
name: feature_flag.evaluation
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
brief: >
|
||||
Defines feature flag evaluation as an event.
|
||||
note: >
|
||||
|
|
@ -43,14 +43,14 @@ groups:
|
|||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `flag_not_found` | The flag could not be found. |  |
|
||||
| `invalid_context` | The evaluation context does not meet provider requirements. |  |
|
||||
| `parse_error` | An error was encountered parsing data, such as a flag configuration. |  |
|
||||
| `provider_fatal` | The provider has entered an irrecoverable error state. |  |
|
||||
| `provider_not_ready` | The value was resolved before the provider was initialized. |  |
|
||||
| `targeting_key_missing` | The provider requires a targeting key and one was not provided in the evaluation context. |  |
|
||||
| `type_mismatch` | The type of the flag value does not match the expected type. |  |
|
||||
| `general` | The error was for a reason not enumerated above. |  |
|
||||
| `flag_not_found` | The flag could not be found. |  |
|
||||
| `invalid_context` | The evaluation context does not meet provider requirements. |  |
|
||||
| `parse_error` | An error was encountered parsing data, such as a flag configuration. |  |
|
||||
| `provider_fatal` | The provider has entered an irrecoverable error state. |  |
|
||||
| `provider_not_ready` | The value was resolved before the provider was initialized. |  |
|
||||
| `targeting_key_missing` | The provider requires a targeting key and one was not provided in the evaluation context. |  |
|
||||
| `type_mismatch` | The type of the flag value does not match the expected type. |  |
|
||||
| `general` | The error was for a reason not enumerated above. |  |
|
||||
- ref: error.message
|
||||
requirement_level:
|
||||
recommended: If and only if an error occurred during flag evaluation and `error.type` does not sufficiently describe the error.
|
||||
|
|
|
|||
|
|
@ -1,24 +1,24 @@
|
|||
groups:
|
||||
- id: registry.feature_flag
|
||||
type: attribute_group
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
display_name: Feature Flag Attributes
|
||||
brief: >
|
||||
This document defines attributes for Feature Flags.
|
||||
attributes:
|
||||
- id: feature_flag.key
|
||||
type: string
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
brief: The lookup key of the feature flag.
|
||||
examples: ["logo-color"]
|
||||
- id: feature_flag.provider.name
|
||||
type: string
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
brief: Identifies the feature flag provider.
|
||||
examples: ["Flag Manager"]
|
||||
- id: feature_flag.result.variant
|
||||
type: string
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
examples: ["red", "true", "on"]
|
||||
brief: >
|
||||
A semantic identifier for an evaluated flag value.
|
||||
|
|
@ -29,19 +29,19 @@ groups:
|
|||
For example, the variant `red` maybe be used for the value `#c05543`.
|
||||
- id: feature_flag.context.id
|
||||
type: string
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
examples: ["5157782b-2203-4c80-a857-dbbd5e7761db"]
|
||||
brief: >
|
||||
The unique identifier for the flag evaluation context. For example, the targeting key.
|
||||
- id: feature_flag.version
|
||||
type: string
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
examples: ["1", "01ABCDEF"]
|
||||
brief: >
|
||||
The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset.
|
||||
- id: feature_flag.set.id
|
||||
type: string
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
examples: ["proj-1", "ab98sgs", "service1/dev"]
|
||||
brief: >
|
||||
The identifier of the [flag set](https://openfeature.dev/specification/glossary/#flag-set) to which the feature flag belongs.
|
||||
|
|
@ -51,46 +51,46 @@ groups:
|
|||
- id: static
|
||||
value: "static"
|
||||
brief: The resolved value is static (no dynamic evaluation).
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
- id: default
|
||||
value: "default"
|
||||
brief: The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result).
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
- id: targeting_match
|
||||
value: "targeting_match"
|
||||
brief: The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting.
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
- id: split
|
||||
value: "split"
|
||||
brief: The resolved value was the result of pseudorandom assignment.
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
- id: cached
|
||||
value: "cached"
|
||||
brief: The resolved value was retrieved from cache.
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
- id: disabled
|
||||
value: "disabled"
|
||||
brief: The resolved value was the result of the flag being disabled in the management system.
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
- id: unknown
|
||||
value: "unknown"
|
||||
brief: The reason for the resolved value could not be determined.
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
- id: stale
|
||||
value: "stale"
|
||||
brief: The resolved value is non-authoritative or possibly out of date
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
- id: error
|
||||
value: "error"
|
||||
brief: The resolved value was the result of an error.
|
||||
stability: development
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
stability: release_candidate
|
||||
examples: ["static", "targeting_match", "error", "default"]
|
||||
brief: >
|
||||
The reason code which shows how a feature flag value was determined.
|
||||
- id: feature_flag.result.value
|
||||
type: any
|
||||
stability: development
|
||||
stability: release_candidate
|
||||
examples: ["#ff0000", true, 3]
|
||||
brief: The evaluated value of the feature flag.
|
||||
note: |
|
||||
|
|
|
|||
Loading…
Reference in New Issue