Feature flags

Create a feature flag

To create a feature flag, complete these steps:

1. In the App Configuration console, click Features flags.

2. Select the Current Environment to display the list of feature flags in that environment.

3. Click Create. The side panel opens with fields for creating a new feature flag.

   

4. Provide the feature flag details:

   • Name - name of the feature flag.
   • Feature flag ID - the feature flag ID value is auto suggested based on the entered feature name. You can modify the same, if needed. Use the Feature flag ID value as the identifier in your SDK or API code.
   • Flag type - specify the type of the feature flag. Supported type includes: Boolean, String, and Numeric. For more information about flag type and default values, see Selecting feature flag type.
   • Default value - specify the default value for the feature flag type selected. For more information about flag type and default values, see Selecting feature flag type.
   • Optionally, select a collection for applying a feature flag now. Otherwise, you need to add a collection before you toggle a feature flag. You can add the feature flag to one or more collections by selecting in the Flag availability across collections list.
   • Feature rollout - specify the Rollout percentage by using the slider. For more information about percentage rollout, see Configure feature rollout percentage.
   • Description - add a description of the feature flag, which is optional.
   • Optionally, define Tags that help you to identify the feature flag.

5. Click Create.

By default, when you create a new feature flag, the Enabled toggle switch is set to OFF.

Selecting feature flag type

You can have one of the following flag types that is associated to a feature flag:

• Boolean
• String
• Numeric

Each of the Flag type is having a default value.

• When you set the toggle switch to ON, the value for the Enabled value is required, which can be overridden when targeting to a segment.
• When you set the toggle switch to OFF, the value for the Disabled value is required, which can be overridden when targeting to a segment.

Boolean

When you select the Flag type as Boolean, the Default value details are displayed:

1. Select the Enabled value from the list. This value is returned by default when the toggle switch is set to ON for the feature flag. This value can be overridden when targeting to a segment.

2. Select the Disabled value from the list. This value is returned by default when toggle switch is set to OFF for the feature flag.

String

When you select the Flag type as String, the Default value details are displayed:

1. Select the Format of the string flag type from the list. Supported format is Text, JSON, and YAML. When JSON or YAML format is selected, provide the Enabled value and Disabled value in the selected format.

2. Specify the Enabled value. This value is returned by default when toggle switch is set to ON for the feature flag. This value can be overridden when targeting to a segment.

3. Specify the Disabled value. This value is returned by default when toggle switch is set to OFF for the feature flag.

Numeric

When you select the Flag type as Numeric, the Default value details are displayed:

1. Select the Enabled value from the list. Only integer values are supported. This value is returned by default when toggle switch is set to ON for the feature flag. This value can be overridden when targeting to a segment.

2. Select the Disabled value from the list. Only integer values are supported. This value is returned by default when toggle switch is set to OFF for the feature flag.

Target collections to feature flags

Optionally, select a collection for applying a feature flag now. Otherwise, you need to add a collection before you toggle a feature flag. You can add feature flags to one or more collections either during creation of feature flag or during editing feature flag details.

For adding collections to the feature flag, for the Flag availability across collections field, select the collection from the list.

If you try to target a feature flag that is not linked to a collection, a window is displayed to add a feature flag to a collection.

Configure feature rollout percentage

You can configure the feature flag with a rollout percentage in the range of 0 to 100, denoting the applicability of the feature to a partial set of users or devices.

Percentage rollout helps to enable a feature to a small percentage of random users or subset of entities, providing more control on the release cycle and achieve progressive delivery. When you are confident on the feature that you want to roll out is working as intended, increase the percentage over time.

Percentage rollout uses a hashing algorithm that generates a hash based on the rule set. This hash is used by the SDK to generate a percentage value for that user. The percentage value generated for that user is compared to the value set for the percentage rollout value, determines whether the user is eligible to receive that feature or not.

For example, the hash has partitions from 1 to 100,000. When you assign a feature flag, the hash assigns values from 1 to 100,000 to users in each partition. For example, when you assign 25% to a feature flag, App Configuration SDK delivers that feature to hash partitions from 1 to 25,000. If you change the percentage of users receiving that feature from 25% to 50%, partitions 25,001 to 50,000 would be added to the set of partitions already receiving that feature.

Percentage rollout capability is available for Lite and Enterprise plans.

Following are some of the percentage rollout scenarios:

• If the feature flag is disabled, then SDK returns the default Disabled value.
• If the feature flag is enabled without any segment rules and no percentage rollout is set, then the SDK returns default Enabled value.
• If the feature flag is enabled without any segment rule and percentage rollout is set to 0%, then the SDK returns Disabled value for all users.
• If the feature flag is enabled without any segment rule and percentage rollout is set to a percent, say 50%, then the SDK checks if the user belongs to the configured percentage rollout size, if the user belongs to the rollout criteria, then the SDK returns the Enabled value. If the user doesn't belong to the rollout criteria, then the SDK returns the Disabled value.
• If the feature flag is enabled with segment rules, then SDK first evaluates the user against the configured rules. If user is part of the configured rule, then the SDK evaluates if the user is eligible for percentage rollout.
  • If multiple rules are configured and the user is checked for rule match until the first match. If no match found, then the SDK evaluates against the default rollout.
  • If the user is evaluated to be part of the segment and the segment percentage rollout is 0%, then even if the user is part of the segment, user will not receive the segment value. The SDK returns the default Disabled value.
  • If the user is evaluated to be part of the segment and the segment percentage rollout is set to a percentage, say 50%, then the SDK checks if the user belongs to configured rollout size, if the user belongs to the rollout criteria, then the SDK returns the segment overriding value. If the user doesn't belongs to the rollout criteria, then the SDK returns Disabled value.

Targeting a segment with a feature flag

You can roll out feature flags to one or more target segments. You can set different flag values for different segments, if needed.

1. From the App Configuration console, go to Feature flags. This pane displays the list of feature flags available in the current environment of the App Configuration service instance.

2. Click Add targeting in the required feature flag row to display the Target flag to segments side-panel.

   

3. The Feature rollout displays the default Rollout percentage slider define when creating the feature flag. Modify the rollout percentage value, if required.

4. In the Rules section, define the rule by specifying the following:

   • In the Rollout percentage, you can define the value as an Override or Inherit from default. If the Override option is selected, then specify the Rollout percentage override value by using the slider.
   • Select Segments from the list. If no segments are available to target, click Create segment. For more information about creating a segment, see Create a segment.
   • For the Enabled value, you can select Override and modify the value or select Inherit from flag.
   • Click to Save rule

   You can define more rules by clicking Add rule.

5. Click Add targeting.

If you try to target a feature flag that is not linked to a collection, a window is displayed to add a feature flag to a collection.

Enabling a feature flag

After you target a feature flag to a segment, click the toggle (ON/OFF) to enable or disable a feature flag.

Feature flags - overflow menu

The overflow menu for each of the feature flag (three vertical dots) consists of Edit, Copy, and Delete operations and Remove targeting for those feature flags that are already targeted.

• When Edit option is selected, you can change the Name, Description, add or delete Tags, change the Flag type and Default value, and add or remove collections for the Flag availability across collections field information.
• When Copy option is selected, the feature flag information is copied, and you need to modify the Name of the feature flag. Optionally, modify the other details based on your need.
• When Delete option is selected, a confirmation window is displayed to seek confirmation to delete the selected feature flag. Deleting option permanently deletes the feature flag and the action cannot be undone.
• In the list of feature flags, in a feature flag, when Copy to clipboard icon is clicked, the feature flag's Feature flag ID value is copied to the clipboard.
• Remove targeting removes the targeting of feature flags to a segment.