Feature Flags

GitLab 11.4で導入されました。

With Feature Flags, you can deploy your application’s new features to production in smaller batches. You can toggle a feature on and off to subsets of users, helping you achieve Continuous Delivery. Feature flags help reduce risk, allowing you to do controlled testing, and separate feature delivery from customer launch.

For an example of feature flags in action, see GitLab for Deploys, Feature Flags, and Error Tracking.

どのように動作するか

GitLab uses Unleash, a feature toggle service.

By enabling or disabling a flag in GitLab, your application can determine which features to enable or disable.

You can create feature flags in GitLab and use the API from your application to get the list of feature flags and their statuses. The application must be configured to communicate with GitLab, so it’s up to developers to use a compatible client library and integrate the feature flags in your app.

Create a feature flag

To create and enable a feature flag:

Navigate to your project’s Operations > Feature Flags.
Click the New feature flag button.
Enter a name that starts with a letter and contains only lowercase letters, digits, underscores (_), or dashes (-), and does not end with a dash (-) or underscore (_).
Enter a description (optional, 255 characters max).
Enter details about how the flag should be applied:
- In GitLab 13.0 and earlier, add Environment specs. For each environment, include the Status (default enabled) and Rollout strategy (defaults to All users).
- In GitLab 13.1 and later, add Feature Flag Strategies. For each strategy, include the Type (defaults to All users) and Environments (defaults to all environments).
Click Create feature flag.

You can change these settings by clicking the (edit) button next to any feature flag in the list.

Rollout strategy (legacy)

GitLab 12.2で導入されました。

In GitLab 13.0 and earlier, the Rollout strategy setting affects which users will experience the feature as enabled. Choose the percentage of users that the feature will be enabled for. The rollout strategy will have no effect if the environment spec is disabled.

It can be set to:

All users
Percent rollout (logged in users)
- Optionally, you can click the Include additional user IDs checkbox and add a list of specific users IDs to enable the feature for.
User IDs

Feature flag strategies

GitLab 13.0から導入されました。
フィーチャーフラグで有効・無効を切り替えることができ、デフォルトでは無効になっています。
It’s enabled on GitLab.com.
GitLabのセルフマネージドインスタンスで使用するには、GitLabの管理者に有効にしてもらう必要があります。

You can apply a feature flag strategy across multiple environments, without defining the strategy multiple times.

GitLab Feature Flags use Unleash as the feature flag engine. In Unleash, there are strategies for granular feature flag controls. GitLab Feature Flags can have multiple strategies, and the supported strategies are:

All users
Percent rollout (logged in users)
User IDs
List

Strategies can be added to feature flags when creating a feature flag, or by editing an existing feature flag after creation by navigating to Operations > Feature Flags and clicking (edit).

All users

Enables the feature for all users. It uses the default Unleash activation strategy.

Percent rollout (logged in users)

Enables the feature for a percentage of authenticated users. It uses the gradualRolloutUserId Unleash activation strategy.

For example, set a value of 15% to enable the feature for 15% of authenticated users.

The rollout percentage can be from 0% to 100%.

Caution: If this strategy is selected, then the Unleash client must be given a user ID for the feature to be enabled. See the Ruby example below.

User IDs

Introduced in GitLab 12.2. Updated to be defined per environment in GitLab 12.6.

Enables the feature for a list of target users. It is implemented using the Unleash userWithId activation strategy.

Enter user IDs as a comma-separated list of values. For example, user@example.com, user2@example.com, or username1,username2,username3, and so on.

Caution: The Unleash client must be given a user ID for the feature to be enabled for target users. See the Ruby example below.

List

GitLab 13.1で導入されました。

Enables the feature for lists of users created with the Feature Flag User List API. Similar to User IDs, it uses the Unleash userWithId activation strategy.

Enable or disable feature flag strategies

This feature is under development, but is ready for testing. It’s deployed behind a feature flag that is disabled by default. GitLab administrators with access to the GitLab Rails console can enable it for your instance.

有効にするには:

Feature.enable(:feature_flags_new_version)

無効化するには:

Feature.disable(:feature_flags_new_version)

Disable a feature flag for a specific environment

In GitLab 13.0 and earlier, to disable a feature flag for a specific environment:

Navigate to your project’s Operations > Feature Flags.
For the feature flag you want to disable, click the Pencil icon.
To disable the flag:
- In GitLab 13.0 and earlier: Slide the Status toggle for the environment. Or, to delete the environment spec, on the right, click the Remove (X) icon.
- In GitLab 13.1 and later: For each strategy it applies to, under Environments, delete the environment.
変更を保存するをクリックします。

Disable a feature flag for all environments

To disable a feature flag for all environments:

Navigate to your project’s Operations > Feature Flags.
For the feature flag you want to disable, slide the Status toggle to Disabled.

The feature flag is displayed on the Disabled tab.

Integrate feature flags with your application

To use feature flags with your application, get access credentials from GitLab. Then prepare your application with a client library.

Get access credentials

To get the access credentials that your application needs to communicate with GitLab:

Navigate to your project’s Operations > Feature Flags.
Click the Configure button to view the following:
- API URL: URL where the client (application) connects to get a list of feature flags.
- Instance ID: Unique token that authorizes the retrieval of the feature flags.
- Application name: The name of the running environment. For instance, if the application runs for a production server, the application name would be production or similar. This value is used for the environment spec evaluation.

Note: The meaning of these fields might change over time. For example, we are not sure if Instance ID will be single token or multiple tokens, assigned to the Environment. Also, Application name could describe the version of application instead of the running environment.

Choose a client library

GitLab implements a single backend that is compatible with Unleash clients.

With the Unleash client, developers can define, in the application code, the default values for flags. Each feature flag evaluation can express the desired outcome if the flag isn’t present in the provided configuration file.

Unleash currently offers many SDKs for various languages and frameworks.

Feature flags API information

For API content, see:

Golang application example

Here’s an example of how to integrate feature flags in a Golang application:

package main

import (
    "io"
    "log"
    "net/http"

    "github.com/Unleash/unleash-client-go"
)

type metricsInterface struct {
}

func init() {
    unleash.Initialize(
        unleash.WithUrl("https://gitlab.com/api/v4/feature_flags/unleash/42"),
        unleash.WithInstanceId("29QmjsW6KngPR5JNPMWx"),
        unleash.WithAppName("production"),
        unleash.WithListener(&metricsInterface{}),
    )
}

func helloServer(w http.ResponseWriter, req *http.Request) {
    if unleash.IsEnabled("my_feature_name") {
        io.WriteString(w, "Feature enabled\n")
    } else {
        io.WriteString(w, "hello, world!\n")
    }
}

func main() {
    http.HandleFunc("/", helloServer)
    log.Fatal(http.ListenAndServe(":8080", nil))
}

Ruby application example

Here’s an example of how to integrate feature flags in a Ruby application.

The Unleash client is given a user ID for use with a Percent rollout (logged in users) rollout strategy or a list of Target Users.

#!/usr/bin/env ruby

require 'unleash'
require 'unleash/context'

unleash = Unleash::Client.new({
  url: 'http://gitlab.com/api/v4/feature_flags/unleash/42',
  app_name: 'production',
  instance_id: '29QmjsW6KngPR5JNPMWx'
})

unleash_context = Unleash::Context.new
# Replace "123" with the id of an authenticated user.
# Note that the context's user id must be a string:
# https://unleash.github.io/docs/unleash_context
unleash_context.user_id = "123"

if unleash.is_enabled?("my_feature_name", unleash_context)
  puts "Feature enabled"
else
  puts "hello, world!"
end

クリエーションラインについて

私たちクリエーションラインは、日本で最も古く2017年にGitLabサービスの提供を開始し、2022年には「Asia-Pacific Partner of the Year」も獲得。GitLabのサブスクリプション販売やテクニカルサポートだけでなく、GitLab Enterpriseの導入支援やGitLabトレーニングなど多様なサービスを提供し、エンタープライズを中心に豊富な実績を誇ります。GitLabに関するお悩みがありましたら、ぜひお気軽にお問い合わせください。日本で唯一、3度にわたるMVPを獲得したGitLabエバンジェリストをはじめとしたエキスパートチームが、あなたの課題解決をご支援します。