Skip to main content

Feature Toggles

Feature toggles are the central concept that we built Unleash around. In Unleash, feature toggles are organized within projects. Feature toggles can have different activation strategies for each of their project's environments, and can also be given variants to facilitate A/B testing.

Configuration options

Each feature toggle has the following configuration options

OptionRequired?Default valueDescription
nameYesN/AThe feature toggle's name. Must be URL-friendly according to section 2.3 of RFC 3986 and must be unique within your Unleash instance.
feature toggle typeYesReleaseThe feature toggle's type.
projectYesThe default project. When created from a project page in the admin UI, that project will be the default value instead.The project that should contain the feature toggle.
descriptionNoN/AA description of the feature toggle's purpose.
enable impression dataYesNoWhether to enable impression data for this toggle or not.

Environments

You probably won't want to use the same configuration to enable a toggle in development as you do in production. That's why feature toggles have different activation strategy configurations for each environment.

You can enable and disable a toggle independently in each of the project's environments. When you disable a toggle in an environment, it will always evaluate to false in that environment. When you enable a toggle in an environment, the toggle will evaluate to true or false depending on its activation strategies.

Refer to the documentation on environments for more details on how environments work.

Activation strategies

To enable a feature in an environment, you must assign it at least one activation strategy. A feature toggle's activation strategies determine whether the toggle gets enabled for a particular Unleash context (typically a user). When using multiple strategies in a single environment, only a single strategy needs to evaluate to true for the toggle to get enabled for a user. Whenever Unleash evaluates a toggle, it will evaluate strategies in the current environment until one of them resolves to true. If no strategies resolve to true, then the toggle's value is false.

Refer to the activation strategies documentation for a detailed description of all the built-in strategies.

Variants

Variants adds another dimension of flexibility to feature toggles. Each feature toggle can be assigned any number of variants which will then get distributed amongst your users based on your choice of context field. You can find out more about variants in the variants docs.

Creating toggles with payloads

While variants are most often used for A/B testing and the like, you can also use variants to assign a constant payload to a toggle. If you give a toggle only a single variant and that variant has a payload, then all users variants will receive that payload.