段階的な機能のロールアウトを使用する

このガイドでは、App Lifecycle Manager のフィーチャー トグルを使用して、段階的な機能ロールアウトを構成して実行する方法について説明します。ターゲティング属性の定義、割合ベースの割り当ての構成、プログレッシブ ロールアウトの安全な実行の方法を学びます。

このシナリオでは、userID 属性でランダム化されたトラフィックの 1% のみに enhanced-search アルゴリズムを有効にし、残りの 99% は通常の検索を引き続き使用します。

前提条件

始める前に、標準のクイックスタートのいずれかを完了して、ベースライン インフラストラクチャまたはスタンドアロンのフィーチャー トグル リソースをプロビジョニングしていることを確認してください。

アプリケーションにフラグを統合する

ユーザーデータに基づく割合ベースの割り当てをサポートするには、評価メソッドを呼び出す前に、アプリケーションで実行時に属性値(userID など)を OpenFeature 評価コンテキストにアタッチする必要があります。

次の例は、初期化されたクライアントを取得し、ターゲティング コンテキストをアタッチしてフラグを評価する方法を示しています。

Go

import (
    "context"
    "fmt"
    "log"

    "github.com/open-feature/go-sdk/openfeature"
)

// Example userID - in a real application, this would come from the request context.
var userID = "example-user-123"

// 1. Get client
client := openfeature.NewClient("simple-api")

// 2. Create Evaluation Context with user data
evalCtx := openfeature.NewEvaluationContext(
    userID,
    map[string]interface{}{
        "userID": userID, // Ensure userID is passed dynamically
    },
)

// 3. Evaluate flag (defaults to false if unreachable)
isEnhanced, err := client.BooleanValue(context.Background(), "enhanced-search", false, evalCtx)
if err != nil {
    log.Printf("Flag evaluation failed: %v", err)
}

// 4. Execute business logic
if isEnhanced {
    log.Printf("Enhanced search algorithm for user %s", userID)
} else {
    log.Printf("Standard search algorithm for user %s", userID)
}

Java

// 1. Get client
var client = OpenFeatureAPI.getInstance().getClient("simple-api");

// 2. Create Evaluation Context with user data
var context = new dev.openfeature.sdk.MutableContext();
context.add("userID", userID);

// 3. Evaluate flag
boolean isEnhanced = client.getBooleanValue("enhanced-search", false, context);

// 4. Execute business logic
if (isEnhanced) {
    System.out.println("Executing enhanced search algorithm...");
} else {
    System.out.println("Executing standard search algorithm...");
}

Python

import openfeature
from openfeature.evaluation_context import EvaluationContext

# 1. Get client
client = openfeature.api.get_client()

# 2. Create Evaluation Context with user data
eval_ctx = EvaluationContext(
    targeting_key=str(user_id),
    attributes={
        "userID": user_id,
    }
)

# 3. Evaluate flag
is_enhanced = client.get_boolean_value(
    "enhanced-search",
    False,
    eval_ctx
)

# 4. Execute business logic
if is_enhanced:
    print(f"Executing enhanced search for user {user_id}")
else:
    print(f"Executing standard search for user {user_id}")

フラグの動作を構成する

ランダム化属性パラメータを定義し、フィーチャー トグル リソースの割合ベースの割り当てルールに関連付けます。

  1. ターゲティング属性を作成する: userID 属性リソースをグローバルに定義して、ターゲティング評価に登録します。

    gcloud beta app-lifecycle-manager flags attributes create "user-id-attr" \
      --key="userID" \
      --attribute-value-type="STRING" \
      --location="global"
    
  2. フラグ割り当てルールを定義する: userID でランダム化された enabled バリアントに 1% の重みを割り当てるように、フィーチャー トグル リソースを構築します。

    gcloud beta app-lifecycle-manager flags create "enhanced-search" \
      --key="enhanced-search" \
      --flag-value-type=bool \
      --location="global" \
      --unit-kind="demo-test-unitkind" \
      --variants='[ { "id": "disabled", "booleanValue": false }, { "id": "enabled", "booleanValue": true } ]' \
      --evaluation-spec='{
        "allocations": [{
          "id": "percentage-rollout",
          "randomizedOn": "userID",
          "slots": [
            {"variant": "disabled", "weight": 99},
            {"variant": "enabled", "weight": 1}
          ]
        }],
        "defaultAllocation": "percentage-rollout",
        "attributes": ["projects/PROJECT_ID/locations/global/flagAttributes/user-id-attr"]
      }'
    

フラグ構成のロールアウトを作成する

新しく作成した段階的割り当てルールを安全に配布するには、標準の不変ロールアウト フェーズを進めます。

  1. リビジョンを作成する: 1% の割り当て構成のスナップショットをキャプチャします。

    gcloud beta app-lifecycle-manager flags revisions create "enhanced-search-rev-1" \
       --location="global" \
       --flag="enhanced-search"
    
  2. リリースを作成する: ユニットの種類に対してデプロイするリビジョンをパッケージ化します。

    gcloud beta app-lifecycle-manager flags releases create "release-of-enhanced-search" \
       --location="global" \
       --unit-kind="demo-test-unitkind" \
       --revisions="enhanced-search-rev-1"
    
  3. ロールアウトを開始する: オーケストレーション戦略を定義し、構成をデプロイします。

    gcloud beta app-lifecycle-manager rollout-kinds create "rollout-kind-of-enhanced-search" \
       --unit-kind="demo-test-unitkind" \
       --rollout-orchestration-strategy="Google.Cloud.Simple.AllAtOnce" \
       --location="global"
    
    gcloud beta app-lifecycle-manager rollouts create "rollout-of-enhanced-search" \
       --flag-release="release-of-enhanced-search" \
       --rollout-kind="rollout-kind-of-enhanced-search" \
       --location="global"
    
  4. ロールアウトをモニタリングする: デプロイが SUCCEEDED 状態に達していることを確認します。

    gcloud beta app-lifecycle-manager rollouts describe "rollout-of-enhanced-search" \
       --location="global"
    

フラグ ターゲティングを更新する

1% のロールアウトが成功し、安定していると判断されたら、フラグの内部割り当ての重みを更新して(例: 50%)、ロールアウトの対象となるオーディエンスの割合を拡大します。

  1. フラグ仕様を更新する: 割り当てスロットを有効 50%、無効 50% に変更します。

    gcloud beta app-lifecycle-manager flags update "enhanced-search" \
      --location="global" \
      --evaluation-spec='{
        "allocations": [{
          "id": "percentage-rollout",
          "randomizedOn": "userID",
          "slots": [
            {"variant": "disabled", "weight": 50},
            {"variant": "enabled", "weight": 50}
          ]
        }],
        "defaultAllocation": "percentage-rollout",
        "attributes": ["projects/PROJECT_ID/locations/global/flagAttributes/user-id-attr"]
      }'
    
  2. 拡張をデプロイする: ライフサイクルに沿って、更新された重みを接続されたクライアントに配布します。

    gcloud beta app-lifecycle-manager flags revisions create "enhanced-search-rev-2" \
       --location="global" \
       --flag="enhanced-search"
    
    gcloud beta app-lifecycle-manager flags releases create "enhanced-search-50pct" \
       --location="global" \
       --unit-kind="demo-test-unitkind" \
       --revisions="enhanced-search-rev-2"
    
    gcloud beta app-lifecycle-manager rollouts create "rollout-of-enhanced-search-50pct" \
       --flag-release="enhanced-search-50pct" \
       --rollout-kind="rollout-kind-of-enhanced-search" \
       --location="global"
    

    この操作は、機能のデプロイが 100% に達するまで継続的に繰り返すことができます。

フラグを廃止する

フィーチャー トグルのロールアウトが完了し、標準の運用動作として機能するようになったら、安全に廃止する必要があります。

  1. アプリケーションから削除する: アプリケーション コードベースからすべてのフラグ評価条件ロジックを削除し、更新されたペイロードを本番環境にデプロイします。
  2. クリーンアップ対象としてマークする: フラグの状態を CLEANUP に設定して、デプロビジョニングの意図を示します。

    gcloud beta app-lifecycle-manager flags update "enhanced-search" \
        --location="global" \
        --state=cleanup
    
  3. 最終ロールアウトをデプロイする: フラグを参照するフラグリリースを作成し、ロールアウトして、ユニットからフラグをデタッチします。

    gcloud beta app-lifecycle-manager flags releases create "cleanup-enhanced-search" \
        --location="global" \
        --unit-kind="demo-test-unitkind" \
        --flags="enhanced-search"
    
    gcloud beta app-lifecycle-manager rollouts create "rollout-of-cleanup-enhanced-search" \
        --flag-release="cleanup-enhanced-search" \
        --rollout-kind="rollout-kind-of-enhanced-search" \
        --location="global"
    

    ロールアウトが完了したら、管理プレーンからフラグ リリース、フラグ リビジョン、フラグを削除します。