Feature flag

• 功能标志属性
• 已弃用的功能标志属性

功能标志属性

本文档定义了功能标志的属性。

Attributes

键	Stability	Value Type	描述	Example Values
feature_flag.context.id		字符串	标志评估上下文的唯一标识符。例如，目标设置键。	5157782b-2203-4c80-a857-dbbd5e7761db
feature_flag.key		字符串	功能标志的查找键。	logo-color
feature_flag.provider.name		字符串	标识功能标志提供商。	Flag Manager
feature_flag.result.reason		字符串	用于显示功能标志值如何确定的原因代码。	static; targeting_match; error; default
feature_flag.result.value		any	功能标志的评估值。[1]	#ff0000; true; 3
feature_flag.result.variant		字符串	评估标志值的语义标识符。[2]	red; true; on
feature_flag.set.id		字符串	功能标志所属的标志集的标识符。	proj-1; ab98sgs; service1/dev
feature_flag.version		字符串	评估过程中使用的规则集的版本。这可以是唯一标识规则集的任何稳定值。	1; 01ABCDEF

[1] feature_flag.result.value: 对于某些功能标志提供商，功能标志结果可能很大，或包含私密或敏感详细信息。因此，如果可用，feature_flag.result.variant 通常是首选属性。

如果可能，最好对 feature_flag.result.value 进行脱敏或限制其大小和范围。由于评估的标志值是非结构化的，并且可以是任何类型，因此由仪器作者决定如何最好地实现这一点。

[2] feature_flag.result.variant: 语义标识符，通常称为变体，提供了一种引用值而不包含该值本身的方法。这可以提供更多上下文来理解值背后的含义。例如，变体 red 可以用于值 #c05543。

feature_flag.result.reason 具有以下已知值列表。如果其中一个适用，则必须使用相应的值；否则，可以使用自定义值。

值	描述	Stability
cached	解析值已从缓存中检索。
default	解析值已回退到预先配置的值（未发生动态评估，或动态评估未产生结果）。
disabled	解析值是由于标志在管理系统中被禁用而产生的。
错误	解析值是由于错误而产生的。
split	解析值是伪随机分配的结果。
stale	解析值不是权威的或可能是过时的。
static	解析值是静态的（无动态评估）。
targeting_match	解析值是由于动态评估（例如规则或特定用户定位）而产生的。
unknown	无法确定解析值的原因。

已弃用的功能标志属性

描述已弃用的功能标志属性。

Attributes

键	Stability	Value Type	描述	Example Values
feature_flag.evaluation.error.message	已替换为 error.message。	字符串	已弃用，请改用 error.message。	Flag header-color 期望类型string但找到类型number``
feature_flag.evaluation.reason	已替换为 feature_flag.result.reason。	字符串	已弃用，请改用 feature_flag.result.reason。	static; targeting_match; error; default
feature_flag.provider_name	已替换为 feature_flag.provider.name。	字符串	已弃用，请改用 feature_flag.provider.name。	Flag Manager
feature_flag.variant	已替换为 feature_flag.result.variant。	字符串	已弃用，请改用 feature_flag.result.variant。	red; true; on

feature_flag.evaluation.reason 具有以下已知值列表。如果其中一个适用，则必须使用相应的值；否则，可以使用自定义值。

值	描述	Stability
cached	解析值已从缓存中检索。
default	解析值已回退到预先配置的值（未发生动态评估，或动态评估未产生结果）。
disabled	解析值是由于标志在管理系统中被禁用而产生的。
错误	解析值是由于错误而产生的。
split	解析值是伪随机分配的结果。
stale	解析值不是权威的或可能是过时的。
static	解析值是静态的（无动态评估）。
targeting_match	解析值是由于动态评估（例如规则或特定用户定位）而产生的。
unknown	无法确定解析值的原因。