semantic-conventions/model/registry/feature-flag.yaml

35 lines
1.4 KiB
YAML

groups:
- id: registry.feature_flag
prefix: feature_flag
type: attribute_group
display_name: Feature Flag Attributes
brief: >
This document defines attributes for Feature Flags.
attributes:
- id: key
type: string
stability: experimental
brief: The unique identifier of the feature flag.
examples: ["logo-color"]
- id: provider_name
type: string
stability: experimental
brief: The name of the service provider that performs the flag evaluation.
examples: ["Flag Manager"]
- id: variant
type: string
stability: experimental
examples: ["red", "true", "on"]
brief: >
SHOULD be a semantic identifier for a value. If one is unavailable, a
stringified version of the value can be used.
note: |-
A semantic identifier, commonly referred to as a variant, provides a means
for referring to a value without including the value itself. This can
provide additional context for understanding the meaning behind a value.
For example, the variant `red` maybe be used for the value `#c05543`.
A stringified version of the value can be used in situations where a
semantic identifier is unavailable. String representation of the value
should be determined by the implementer.