OpenTelemetry PHP

FeatureFlagIncubatingAttributes

Semantic attributes and corresponding values for feature_flag.

Tags
see
https://opentelemetry.io/docs/specs/semconv/registry/attributes/feature_flag/

May contain @experimental Semantic Conventions which may change or be removed in the future.

Table of Contents

Constants

FEATURE_FLAG_CONTEXT_ID  : mixed = 'feature_flag.context.id'
The unique identifier for the flag evaluation context. For example, the targeting key.
FEATURE_FLAG_ERROR_MESSAGE  : mixed = 'feature_flag.error.message'
A message providing more detail about an error that occurred during feature flag evaluation in human-readable form.
FEATURE_FLAG_KEY  : mixed = 'feature_flag.key'
The lookup key of the feature flag.
FEATURE_FLAG_PROVIDER_NAME  : mixed = 'feature_flag.provider.name'
Identifies the feature flag provider.
FEATURE_FLAG_RESULT_REASON  : mixed = 'feature_flag.result.reason'
The reason code which shows how a feature flag value was determined.
FEATURE_FLAG_RESULT_REASON_VALUE_CACHED  : mixed = 'cached'
The resolved value was retrieved from cache.
FEATURE_FLAG_RESULT_REASON_VALUE_DEFAULT  : mixed = 'default'
The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result).
FEATURE_FLAG_RESULT_REASON_VALUE_DISABLED  : mixed = 'disabled'
The resolved value was the result of the flag being disabled in the management system.
FEATURE_FLAG_RESULT_REASON_VALUE_ERROR  : mixed = 'error'
The resolved value was the result of an error.
FEATURE_FLAG_RESULT_REASON_VALUE_SPLIT  : mixed = 'split'
The resolved value was the result of pseudorandom assignment.
FEATURE_FLAG_RESULT_REASON_VALUE_STALE  : mixed = 'stale'
The resolved value is non-authoritative or possibly out of date
FEATURE_FLAG_RESULT_REASON_VALUE_STATIC  : mixed = 'static'
The resolved value is static (no dynamic evaluation).
FEATURE_FLAG_RESULT_REASON_VALUE_TARGETING_MATCH  : mixed = 'targeting_match'
The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting.
FEATURE_FLAG_RESULT_REASON_VALUE_UNKNOWN  : mixed = 'unknown'
The reason for the resolved value could not be determined.
FEATURE_FLAG_RESULT_VALUE  : mixed = 'feature_flag.result.value'
The evaluated value of the feature flag.
FEATURE_FLAG_RESULT_VARIANT  : mixed = 'feature_flag.result.variant'
A semantic identifier for an evaluated flag value.
FEATURE_FLAG_SET_ID  : mixed = 'feature_flag.set.id'
The identifier of the [flag set](https://openfeature.dev/specification/glossary/#flag-set) to which the feature flag belongs.
FEATURE_FLAG_VERSION  : mixed = 'feature_flag.version'
The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset.

Constants

FEATURE_FLAG_CONTEXT_ID

The unique identifier for the flag evaluation context. For example, the targeting key.

public mixed FEATURE_FLAG_CONTEXT_ID = 'feature_flag.context.id'
Tags
experimental

FEATURE_FLAG_ERROR_MESSAGE

A message providing more detail about an error that occurred during feature flag evaluation in human-readable form.

public mixed FEATURE_FLAG_ERROR_MESSAGE = 'feature_flag.error.message'
Tags
experimental

FEATURE_FLAG_PROVIDER_NAME

Identifies the feature flag provider.

public mixed FEATURE_FLAG_PROVIDER_NAME = 'feature_flag.provider.name'
Tags
experimental

FEATURE_FLAG_RESULT_REASON

The reason code which shows how a feature flag value was determined.

public mixed FEATURE_FLAG_RESULT_REASON = 'feature_flag.result.reason'
Tags
experimental

FEATURE_FLAG_RESULT_REASON_VALUE_CACHED

The resolved value was retrieved from cache.

public mixed FEATURE_FLAG_RESULT_REASON_VALUE_CACHED = 'cached'
Tags
experimental

FEATURE_FLAG_RESULT_REASON_VALUE_DEFAULT

The resolved value fell back to a pre-configured value (no dynamic evaluation occurred or dynamic evaluation yielded no result).

public mixed FEATURE_FLAG_RESULT_REASON_VALUE_DEFAULT = 'default'
Tags
experimental

FEATURE_FLAG_RESULT_REASON_VALUE_DISABLED

The resolved value was the result of the flag being disabled in the management system.

public mixed FEATURE_FLAG_RESULT_REASON_VALUE_DISABLED = 'disabled'
Tags
experimental

FEATURE_FLAG_RESULT_REASON_VALUE_ERROR

The resolved value was the result of an error.

public mixed FEATURE_FLAG_RESULT_REASON_VALUE_ERROR = 'error'
Tags
experimental

FEATURE_FLAG_RESULT_REASON_VALUE_SPLIT

The resolved value was the result of pseudorandom assignment.

public mixed FEATURE_FLAG_RESULT_REASON_VALUE_SPLIT = 'split'
Tags
experimental

FEATURE_FLAG_RESULT_REASON_VALUE_STALE

The resolved value is non-authoritative or possibly out of date

public mixed FEATURE_FLAG_RESULT_REASON_VALUE_STALE = 'stale'
Tags
experimental

FEATURE_FLAG_RESULT_REASON_VALUE_STATIC

The resolved value is static (no dynamic evaluation).

public mixed FEATURE_FLAG_RESULT_REASON_VALUE_STATIC = 'static'
Tags
experimental

FEATURE_FLAG_RESULT_REASON_VALUE_TARGETING_MATCH

The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting.

public mixed FEATURE_FLAG_RESULT_REASON_VALUE_TARGETING_MATCH = 'targeting_match'
Tags
experimental

FEATURE_FLAG_RESULT_REASON_VALUE_UNKNOWN

The reason for the resolved value could not be determined.

public mixed FEATURE_FLAG_RESULT_REASON_VALUE_UNKNOWN = 'unknown'
Tags
experimental

FEATURE_FLAG_RESULT_VALUE

The evaluated value of the feature flag.

public mixed FEATURE_FLAG_RESULT_VALUE = '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.

It may be desirable to redact or otherwise limit the size and scope of feature_flag.result.value if possible. Because the evaluated flag value is unstructured and may be any type, it is left to the instrumentation author to determine how best to achieve this.

Tags
experimental

FEATURE_FLAG_RESULT_VARIANT

A semantic identifier for an evaluated flag value.

public mixed FEATURE_FLAG_RESULT_VARIANT = 'feature_flag.result.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.

Tags
experimental

FEATURE_FLAG_SET_ID

The identifier of the [flag set](https://openfeature.dev/specification/glossary/#flag-set) to which the feature flag belongs.

public mixed FEATURE_FLAG_SET_ID = 'feature_flag.set.id'
Tags
experimental

FEATURE_FLAG_VERSION

The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset.

public mixed FEATURE_FLAG_VERSION = 'feature_flag.version'
Tags
experimental
On this page

Search results