| title | description | sidebar_position |
|---|---|---|
Glossary |
A list of terms used within the OpenFeature specification. |
1 |
This document defines some terms that are used across this specification.
Table of Contents
A mechanism that allows an Application Author to define alternative codepaths within a deployed piece of software, which is conditionally executed at runtime, based on a rule set.
A developer of an application or service which utilizes the feature flags SDK. This person writes code which calls into the SDK to make flagging decisions.
A developer who is setting up or configuring an application or service to use the feature flags SDK. They would write code like "We should speak to the open source flagging service, not $vendor" or "The way the system should handle telemetry is through $library".
The maintainer of an API-compliant provider which implements the necessary interfaces required for flag evaluation.
The maintainer of an API-compliant integration which implements additional secondary functionality besides flag evaluation.
The maintainer of a shared library which is a dependency of many applications or libraries, which utilizes the feature flags SDK to allow consumers to manage library functionality.
The libraries used by the Application Author to implement feature flags in their application or service. The interfaces defined in these libraries adhere to the Feature Flag API.
The interfaces and abstractions used by authors (Application, Integration, Provider).
Provider & Integration authors adhere to the API to add support for their feature flag implementation or integration. Application authors use it via the Feature Flag SDK.
The subset of the Feature Flag API that the Application Author uses to evaluate flags.
A source-of-truth for flag values and rules. Flag management systems may include SaaS feature flag vendors, custom "in-house" feature flag infrastructure, or open-source implementations.
An SDK-compliant implementation which resolves flag values from a particular flag management system, allowing the use of the Evaluation API as an abstraction for the system in question.
An SDK-compliant secondary function that is abstracted by the Feature Flag API, and requires only minimal configuration by the Application Author. Examples include telemetry, tracking, custom logging and monitoring.
Context object for flag evaluation, which may contain information about the runtime environment, details of the transport method encapsulating the flag evaluation, the host, the client, the subject (user), etc. This data may be used as a basis for differential evaluation of feature flags based on rules that can be defined in the flag system. Context data may be provided by merging static global context, arguments to flag evaluation, and implicit language-dependant state propagation mechanisms (thread-local storage, promise chains, continuations, etc).
The process of retrieving a feature flag value in it's entirety, including:
- any effects resulting from hooks
- resolving a flag value from a configured provider
- falling back to a supplied default, in the case of abnormal execution
The process of a provider retrieving a feature flag value from it's particular source-of-truth.
erDiagram
Flag ||--|{ variant: "has many"
variant ||--|| value: "has"
Flag ||--o{ rule: "Has zero or many"
rule }|--|{ variant : "links to many"
Flags represent a single pivot point of logic. Flags have a type, like string, boolean, json, etc. Examples: redesign_enabled or header-order
A string that logically identifies a particular flag.
A variant is a semantic identifier for a value. This allows for referral to particular values without necessarily including the value itself, which may be quite prohibitively large or otherwise unsuitable in some cases.
Individual variants have values associated with them. These values adhere to the flag's type. For the header-order variants, we may have values like:
reverse: [5,4,3,2,1]
wonky: [3,5,2,1,4]
standard: [1,2,3,4,5]
The application of rules, specific user overrides, or fractional evaluations in feature flag resolution.
A string logically identifying the subject of evaluation (end-user, service, etc).
Pseudorandomly resolve flag values using a context property, such as a targeting key, based on a configured proportion or percentage (ie: 50/50).
A rule is some criteria that's used to determine which variant a particular context should be mapped to.