go-feature-flag

GO Feature Flag

ファイルベースの設定とOpenFeature統合に対応したオープンソースのフィーチャーフラグソリューションです。セルフホスト可能なフィーチャーフラグの設定、フラグファイルの構成、リレープロキシのデプロイ時に使用します。

使用するタイミング

自動的に有効になる条件：

• ユーザーが「GO Feature Flag」、「GOFF」、「gofeatureflag」に言及した場合
• プロジェクトに@openfeature/go-feature-flag-provider依存関係がある場合
• プロジェクトにflags.goff.yamlなどのフラグ設定ファイルがある場合
• ユーザーがセルフホスト可能なフィーチャーフラグについて尋ねた場合
• Docker／K8sの設定にgofeatureflag/go-feature-flagイメージが含まれている場合

関連スキル：

• openfeature - OpenFeature SDKの使用パターン
• container-development - Docker／K8sのデプロイ

アーキテクチャの概要

┌─────────────────────────────────────────────────────────────┐
│                     Application                              │
│                         │                                    │
│                   OpenFeature SDK                            │
│                         │                                    │
│              GO Feature Flag Provider                        │
└─────────────────────────────────────────────────────────────┘
                          │
                          ▼
┌─────────────────────────────────────────────────────────────┐
│                 GO Feature Flag Relay Proxy                  │
│  ┌─────────────────────────────────────────────────────────┐│
│  │                    Retriever                            ││
│  │  (File, S3, GitHub, HTTP, K8s ConfigMap, etc.)         ││
│  └─────────────────────────────────────────────────────────┘│
│  ┌─────────────────────────────────────────────────────────┐│
│  │                    Exporter                             ││
│  │  (Webhook, S3, Kafka, PubSub, etc.)                    ││
│  └─────────────────────────────────────────────────────────┘│
│  ┌─────────────────────────────────────────────────────────┐│
│  │                   Notifier                              ││
│  │  (Slack, Discord, Teams, Webhook)                      ││
│  └─────────────────────────────────────────────────────────┘│
└─────────────────────────────────────────────────────────────┘
                          │
                          ▼
┌─────────────────────────────────────────────────────────────┐
│                   Flag Configuration                         │
│                    (flags.goff.yaml)                         │
└─────────────────────────────────────────────────────────────┘

フラグ設定形式

基本構造

# flags.goff.yaml
flag-name:
  variations:       # All possible values
    variation1: value1
    variation2: value2
  defaultRule:      # Rule when no targeting matches
    variation: variation1
  targeting:        # Optional: targeting rules
    - name: rule-name
      query: 'expression'
      variation: variation2

ブール値フラグ

# Simple on/off flag
new-feature:
  variations:
    enabled: true
    disabled: false
  defaultRule:
    variation: disabled

String、Number、Object／JSONフラグの例については、REFERENCE.mdを参照してください。

ターゲティングルール

クエリ構文

GO Feature Flagでは、ターゲティングにCELに似たクエリ構文を使用します。

targeting:
  - name: beta-users
    query: 'groups co "beta"'  # contains
    variation: enabled

  - name: specific-user
    query: 'targetingKey eq "user-123"'  # equals
    variation: enabled

  - name: email-domain
    query: 'email ew "@company.com"'  # ends with
    variation: enabled

  - name: premium-tier
    query: 'plan in ["pro", "enterprise"]'  # in list
    variation: enabled

演算子

演算子	説明	例
eq	等しい	email eq "[email protected]"
ne	等しくない	plan ne "free"
co	含む	groups co "admin"
sw	～で始まる	email sw "admin"
ew	～で終わる	email ew "@company.com"
in	リスト内にある	country in ["US", "CA"]
gt、ge、lt、le	比較	age gt 18
and、or	論理演算	plan eq "pro" and country eq "US"

優先順位

ルールは上から順に評価されます。最初に一致したルールが適用されます。

targeting:
  # Highest priority: specific user override
  - name: test-user
    query: 'targetingKey eq "test-user-id"'
    variation: enabled

  # Second: admin group
  - name: admins
    query: 'groups co "admin"'
    variation: enabled

  # Third: beta users
  - name: beta
    query: 'groups co "beta"'
    variation: enabled

  # Fallback is defaultRule
defaultRule:
  variation: disabled

ロールアウト戦略

パーセンテージロールアウト

new-checkout:
  variations:
    enabled: true
    disabled: false
  defaultRule:
    percentage:
      enabled: 20   # 20% of users
      disabled: 80  # 80% of users

プログレッシブロールアウト、スケジュールされた変更、A/Bテストのパターンについては、REFERENCE.mdを参照してください。

リレープロキシの設定

Docker Compose（開発用）

# docker-compose.yaml
services:
  goff-relay:
    image: gofeatureflag/go-feature-flag:latest
    ports:
      - "1031:1031"  # API
      - "1032:1032"  # Health/metrics
    volumes:
      - ./flags.goff.yaml:/goff/flags.yaml:ro
    environment:
      # Retriever configuration
      - RETRIEVER_KIND=file
      - RETRIEVER_PATH=/goff/flags.yaml

      # Polling interval (ms)
      - POLLING_INTERVAL_MS=10000

      # Logging
      - LOG_LEVEL=info
    healthcheck:
      test: ["CMD", "wget", "-q", "--spider", "http://localhost:1032/health"]
      interval: 10s
      timeout: 5s
      retries: 3

環境変数

# Retriever (choose one)
RETRIEVER_KIND=file|s3|http|github|gitlab|googlecloud|azureblob|k8s

# File retriever
RETRIEVER_PATH=/path/to/flags.yaml

# S3 retriever
RETRIEVER_BUCKET=my-bucket
RETRIEVER_ITEM=flags/production.yaml
AWS_REGION=us-east-1

# GitHub retriever
RETRIEVER_REPOSITORY_SLUG=owner/repo
RETRIEVER_FILE_PATH=flags/production.yaml
RETRIEVER_BRANCH=main
GITHUB_TOKEN=ghp_xxxx

# HTTP retriever
RETRIEVER_URL=https://api.example.com/flags.yaml
RETRIEVER_HEADERS=Authorization=Bearer xxx

# Polling
POLLING_INTERVAL_MS=30000

# Server
HTTP_PORT=1031
ADMIN_PORT=1032
LOG_LEVEL=info|debug|warn|error

Kubernetesのデプロイ設定については、REFERENCE.mdを参照してください。

エクスポーター

分析用にフラグ評価データをエクスポートします。サポートされている種類：webhook、s3、googlecloud、kafka、pubsub、log。

エクスポーターの環境変数設定の詳細については、REFERENCE.mdを参照してください。

通知機能

フラグの変更時に通知を送信します。サポート対象：Slack、Discord、Microsoft Teams、Webhook。

Webhook URLの設定については、REFERENCE.mdを参照してください。

CLIツール

設定の検証

# Install CLI
go install github.com/thomaspoignant/go-feature-flag/cmd/goff@latest

# Validate flag file
goff lint --config flags.goff.yaml

# Output format
goff lint --config flags.goff.yaml --format json

フラグのローカルテスト

# Start relay in foreground
docker run -p 1031:1031 -p 1032:1032 \
  -v $(pwd)/flags.goff.yaml:/goff/flags.yaml:ro \
  -e RETRIEVER_KIND=file \
  -e RETRIEVER_PATH=/goff/flags.yaml \
  gofeatureflag/go-feature-flag:latest

# Test flag evaluation
curl -X POST http://localhost:1031/v1/feature/new-feature/eval \
  -H "Content-Type: application/json" \
  -d '{"evaluationContext": {"targetingKey": "user-123"}}'

ベストプラクティス

1. フラグの命名規則

# Namespace by feature/team
checkout.new-payment-form
dashboard.beta-widgets
api.v2-endpoints

# Use consistent suffixes
*.enabled      # boolean toggles
*.config       # object/JSON config
*.percentage   # rollout percentage

2. フラグのライフサイクルを管理する

# Add metadata comments (YAML supports comments)
new-feature:
  # Created: 2024-11-01
  # Owner: team-checkout
  # Jira: PROJ-123
  # Target removal: 2025-01-15
  variations:
    enabled: true
    disabled: false

3. 監視とクリーンアップ

• 評価データをエクスポートして使用状況を追跡する
• 100%になったフラグ（削除可能な状態）に対するアラートを設定する
• 四半期ごとにフラグを見直し、不要なものを削除する

GitOps CI/CDワークフローと環境固有のフラグパターンについては、REFERENCE.mdを参照してください。

トラブルシューティング

フラグが正しく評価されない

# Check relay logs
docker logs goff-relay

# Test evaluation directly
curl -X POST http://localhost:1031/v1/feature/my-flag/eval \
  -H "Content-Type: application/json" \
  -d '{"evaluationContext": {"targetingKey": "test", "email": "[email protected]"}}'

プロバイダー接続の問題

// Check provider initialization
const provider = new GoFeatureFlagProvider({
  endpoint: process.env.GOFF_RELAY_URL,
  timeout: 5000, // Increase timeout
});

// Handle events
provider.on('PROVIDER_READY', () => console.log('Provider ready'));
provider.on('PROVIDER_ERROR', (e) => console.error('Provider error', e));

設定が更新されない

# Check polling interval
POLLING_INTERVAL_MS=10000  # 10 seconds

# Verify file is readable
docker exec goff-relay cat /goff/flags.yaml

# Check retriever status
curl http://localhost:1032/info

ドキュメント

• 公式ドキュメント：https://gofeatureflag.org/docs
• フラグ形式：https://gofeatureflag.org/docs/configure_flag/flag_format
• リレープロキシ：https://gofeatureflag.org/docs/relay-proxy
• OpenFeature SDK：https://gofeatureflag.org/docs/sdk

関連コマンド

• /configure:feature-flags - フィーチャーフラグのインフラストラクチャ一式をセットアップする
• /configure:dockerfile - コンテナー設定のベストプラクティス