Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 4.44 KB

feature-flag.md

File metadata and controls

40 lines (32 loc) · 4.44 KB

Feature flag

Feature Flag Attributes

This document defines attributes for Feature Flags.

Attribute Type Description Examples Stability
feature_flag.context.id string The unique identifier for the flag evaluation context. For example, the targeting key. 5157782b-2203-4c80-a857-dbbd5e7761db Development
feature_flag.evaluation.error.message string A message explaining the nature of an error occurring during flag evaluation. Flag header-colorexpected typestringbut found typenumber`` Development
feature_flag.evaluation.reason string The reason code which shows how a feature flag value was determined. static; targeting_match; error; default Development
feature_flag.key string The lookup key of the feature flag. logo-color Development
feature_flag.provider_name string Identifies the feature flag provider. Flag Manager Development
feature_flag.set.id string The identifier of the flag set to which the feature flag belongs. proj-1; ab98sgs; service1/dev Development
feature_flag.variant string A semantic identifier for an evaluated flag value. [1] red; true; on Development
feature_flag.version string The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset. 1; 01ABCDEF Development

[1] feature_flag.variant: 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.


feature_flag.evaluation.reason has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
cached The resolved value was retrieved from cache. Development
default The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result). Development
disabled The resolved value was the result of the flag being disabled in the management system. Development
error The resolved value was the result of an error. Development
split The resolved value was the result of pseudorandom assignment. Development
stale The resolved value is non-authoritative or possibly out of date Development
static The resolved value is static (no dynamic evaluation). Development
targeting_match The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting. Development
unknown The reason for the resolved value could not be determined. Development