Usar lançamentos graduais de recursos

Neste guia, explicamos como configurar e executar um lançamento gradual de recursos usando as flags de recurso do App Lifecycle Manager. Você vai aprender a definir atributos de segmentação, configurar alocações com base em porcentagem e executar um lançamento progressivo com segurança.

Vamos usar um cenário em que você quer ativar um algoritmo enhanced-search para apenas 1% do seu tráfego, randomizado pelo atributo userID, enquanto os 99% restantes continuam usando a pesquisa padrão.

Pré-requisitos

Antes de começar, conclua um dos guias de início rápido padrão para provisionar sua infraestrutura de referência ou os recursos de flag de recurso independente:

Integrar a flag ao aplicativo

Para oferecer suporte a alocações baseadas em porcentagem com base em dados do usuário, seu aplicativo precisa anexar o valor do atributo (por exemplo, userID) ao contexto de avaliação do OpenFeature no ambiente de execução antes de chamar o método de avaliação.

Os exemplos a seguir mostram como recuperar o cliente inicializado e avaliar a flag com o contexto de segmentação anexado.

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}")

Configurar o comportamento da sinalização

Defina o parâmetro de atributo aleatório e associe-o a uma regra de alocação baseada em porcentagem no recurso de flag de recurso.

  1. Crie o atributo de segmentação: defina o recurso de atributo userID globalmente para registrá-lo na avaliação de segmentação.

    gcloud beta app-lifecycle-manager flags attributes create "user-id-attr" \
      --key="userID" \
      --attribute-value-type="STRING" \
      --location="global"
    
  2. Defina a regra de alocação da flag: crie o recurso de flag de recurso para atribuir 1% de peso à variante enabled randomizada em userID.

    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"]
      }'
    

Criar um lançamento de configuração de flag

Para distribuir a regra de alocação gradual recém-criada com segurança, siga as fases padrão de lançamento imutável.

  1. Criar uma revisão: capture um snapshot da configuração de alocação de 1%.

    gcloud beta app-lifecycle-manager flags revisions create "enhanced-search-rev-1" \
       --location="global" \
       --flag="enhanced-search"
    
  2. Criar uma versão: empacote a revisão para implantação nos tipos de unidade.

    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. Iniciar o lançamento: defina sua estratégia de orquestração e implante a configuração.

    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. Monitore o lançamento: confirme se a implantação atinge um estado SUCCEEDED.

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

Atualizar a segmentação de sinalizações

Quando o lançamento de 1% for considerado bem-sucedido e estável, aumente a porcentagem do público-alvo atualizando o peso de alocação interna da flag (por exemplo, para 50%).

  1. Atualize a especificação da flag: mude os slots alocados para 50% ativados e 50% desativados.

    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. Implantar a expansão: siga o ciclo de vida para distribuir o peso atualizado aos clientes conectados.

    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"
    

    Essa operação pode ser repetida continuamente até que o recurso atinja 100% de implantação.

Desativar uma flag

Depois que uma flag de recurso conclui o lançamento e serve como comportamento operacional padrão, ela precisa ser desativada com segurança.

  1. Remover do aplicativo: remova toda a lógica condicional de avaliação de flag da base de código do aplicativo e implante o payload atualizado na produção.
  2. Marcar para limpeza: defina o estado da flag como CLEANUP para sinalizar a intenção de desprovisionamento:

    gcloud beta app-lifecycle-manager flags update "enhanced-search" \
        --location="global" \
        --state=cleanup
    
  3. Implantar o lançamento final: crie uma versão de flag que faça referência à flag e faça o lançamento para desvincular a flag das suas unidades:

    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"
    

    Depois que o lançamento for concluído, exclua a versão, as revisões e a flag do plano de gerenciamento.