APIサーバー設定

Bencher APIサーバーは、起動時にJSON構成を必要とします。 構成は以下の3つの方法で提供可能です:

• BENCHER_CONFIG環境変数: 値はJSON構成に設定する必要があります
• BENCHER_CONFIG_PATH環境変数: 値はJSON構成を含むファイルのパスに設定する必要があります
• /etc/bencher/bencher.jsonファイル: この場所にあるJSON構成を含むファイル

構成が見つからない場合、デフォルト構成が読み込まれます。

JSON構成の例:

{
  "console": {
    "url": "https://bencher.example.com"
  },
  "security": {
    "issuer": "https://api.bencher.example.com",
    "secret_key": "UJu7Cpxb-zFaJYqXD-3mDDSDyj-ZvfxZFZs-X58xjxPy"
  },
  "server": {
    "bind_address": "0.0.0.0:6610",
    "request_body_max_bytes": 1048576,
    "tls": {
      "type": "as_file",
      "cert_file": "/path/to/cert.pem",
      "key_file": "/path/to/key.pem"
    }
  },
  "logging": {
    "name": "Bencher API",
    "log": {
      "stderr_terminal": {
        "level": "info"
      }
    },
  },
  "database": {
    "file": "/var/lib/bencher/data/bencher.db",
    "data_store": {
      "service": "aws_s3",
      "access_key_id": "ABC123DoRemMiABC123",
      "secret_access_key": "AA3Chr-JSF5sUQqKwayx-FvCfZKsMev-5BqPpcFC3m7",
      "access_point": "arn:aws:s3:some-region-1:123456789:accesspoint/my-bucket/path/to/backup/dir"
    },
    "busy_timeout": 5000,
    "cache_size": 65536
  },
  "smtp": {
    "hostname": "mailbonobo.com",
    "port": 587,
    "starttls": true,
    "username": "bencher",
    "secret": "WM3F2u9cqSNdBPLfy9sJ5kk9",
    "from_name": "Bencher",
    "from_email": "info@bencher.example.com"
  },
  "plus": {
    "disaster_recovery": {
      "replicas": [
        {
          "scheme": "s3",
          "bucket": "my-bucket",
          "path": "path/to/replicate",
          "access_key_id": "ABC123DoRemMiABC123",
          "secret_access_key": "AA3Chr-JSF5sUQqKwayx-FvCfZKsMev-5BqPpcFC3m7"
        }
      ]
    },
    "registry": {
      "url": "https://registry.bencher.example.com",
      "data_store": {
        "service": "aws_s3",
        "access_key_id": "AKIAIOSFODNN7EXAMPLE",
        "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
        "access_point": "arn:aws:s3:us-east-1:123456789012:accesspoint/my-access-point/registry",
        "chunk_size": 5242880
      },
      "upload_timeout": 3600,
      "max_body_size": 1073741824
    },
    "runners": {
      "heartbeat_timeout": 90,
      "job_timeout_grace_period": 60,
      "update_base_url": "https://github.com/bencherdev/bencher/releases/download/"
    },
    "rate_limiting": {
      "window": 86400,
      "unclaimed_limit": 255,
      "claimed_limit": 65536,
      "public": {
        "requests": {
          "minute": 1024,
          "hour": 4096,
          "day": 8192
        },
        "attempts": {
          "minute": 32,
          "hour": 64,
          "day": 128
        },
        "runs": {
          "minute": 64,
          "hour": 128,
          "day": 256
        }
      },
      "user": {
        "requests": {
          "minute": 2048,
          "hour": 8192,
          "day": 16384
        },
        "attempts": {
          "minute": 2,
          "hour": 4,
          "day": 8
        },
        "credentials": {
          "minute": 4,
          "hour": 8,
          "day": 16
        },
        "organizations": {
          "minute": 2,
          "hour": 4,
          "day": 8
        },
        "invites": {
          "minute": 8,
          "hour": 16,
          "day": 32
        },
        "runs": {
          "minute": 64,
          "hour": 1024,
          "day": 4096
        }
      },
      "project": {
        "requests": {
          "minute": 2048,
          "hour": 8192,
          "day": 16384
        },
        "runs": {
          "minute": 64,
          "hour": 1024,
          "day": 4096
        }
      },
      "runner": {
        "requests": {
          "minute": 16,
          "hour": 256,
          "day": 4096
        }
      },
      "oci_bandwidth": {
        "unclaimed": 1073741824,
        "free": 10737418240,
        "plus": 107374182400
      }
    },
    "stats": {
      "offset": 11242,
      "enabled": true
    }
  }
}

console

security

server

このセクションは Dropshotサーバー設定 に基づいています。

logging

このセクションは、Dropshot logging configurationに基づいています。

database

smtp

このセクションでは、SMTPサービスの設定を指定します。セクション全体は任意です。指定しない場合、すべてのメッセージは代わりにloggingに送信されます。

plus

このセクションは、Bencher Plusライセンスでカバーされる機能について説明しています。

plus.github

このセクションでは、OAuth2認証に使用されるGitHubアプリの設定を指定します。 サーバー上の少なくとも1つの組織に対して有効なBencher Plus エンタープライズ ライセンスが必要です。 このセクション全体はオプションです。 指定しない場合、GitHubによる認証は有効になりません。

plus.google

このセクションでは、OAuth2 認証に使用される Google クライアント の設定を指定します。 サーバー上の少なくとも1つの組織に対して有効な Bencher Plus Enterprise ライセンスが必要です。 このセクションは任意です。指定しない場合、Googleによる認証は有効になりません。

plus.disaster_recovery

このセクションは、災害復旧の設定を指定します。 Bencherはデータベースの全ての変更を継続的に複製することをサポートします。 オンデマンドまたは定期バックアップを実行するには、設定の database.data_store セクションをご覧ください。

複製には3つのスキームがあります：

• file: ローカルファイルパスに複製
  • path: 複製先のパス
• sftp: SFTPを使用して複製
  • host: 目標システムのホスト名
  • port: 目標システムのポート番号
  • user: 目標システムのユーザー名
  • password: (任意) 目標システムのパスワード
  • path: (任意) 目標システムのパス
  • key_path: (任意) SSHキーのパス
• s3: S3互換の任意のブロブストレージに複製
  • bucket: バケット名
  • path: (任意) バケット内のパス
  • endpoint: (AWS: 任意 | 非AWS: 必須) 複製エンドポイント
  • region: (任意) バケットのリージョン
  • access_key_id: S3アクセスキー
  • secret_access_key: S3シークレットアクセスキー

3つの複製スキーム全てに共通の追加オプションがあります：

• snapshot.interval: (任意) 新しいスナップショットが作成される頻度を指定します。新しいスナップショットは適用されるWALフレームが少ないため、復元時間が短縮されます。保持はこれらのスナップショットにも適用されます。スナップショットの間隔を設定しない場合は、保持が行われるたびに新しいスナップショットが作成されます。保持はデフォルトで24時間ごとに行われます。
• snapshot.retention: (任意) スナップショットおよびWALファイルが保持される時間。保持期間の後、新しいスナップショットが作成され、古いものは削除されます。最も古いスナップショットよりも前に存在するWALファイルも削除されます。デフォルトは 24h です。
• validation.interval: (任意) 指定された場合、Bencherは自動的に復元し、複製データがローカルコピーと一致するかどうかを検証します。デフォルトでは無効になっています。これを有効にすると、ほとんどのクラウドサービスがダウンロードに料金を課すため、Bencherの実行コストが大幅に増加する可能性があります。
• sync_interval: (任意) フレームが複製にプッシュされる頻度。デフォルトは 1s です。頻度を上げるとクラウドストレージコストが大幅に増加する可能性があります。
• checkpoint.interval: (任意) ページ数に関係なく、Litestreamがノンブロッキングのパッシブチェックポイントを実行する頻度。リーダーまたはライターがアクティブな場合、Litestreamはチェックポイントをスキップします。デフォルトは 1m です。
• checkpoint.min_page_count: (任意) ノンブロッキングのパッシブチェックポイントがトリガーされるまでのWALページの最小数（1ページあたり約4KB）。リーダーまたはライターがアクティブな場合、Litestreamはチェックポイントをスキップします。デフォルトは 1000（約4MB）です。
• checkpoint.truncate_page_n: (任意) ブロッキングTRUNCATEチェックポイントのページ数閾値。この閾値に達すると、Litestreamはすべてのリーダーとライターの完了を待つブロッキングチェックポイントを実行し、負荷がかかっている場合は database is locked エラーが発生する可能性があります。デフォルトは 0（無効）です。 WALファイルサイズの上限が必要で、ブロッキングの影響を理解している場合にのみ、ゼロ以外の値を設定してください。

plus.registry

このセクションでは、OCI（Open Container Initiative）レジストリストレージの設定を指定します。 BencherはOCI準拠のコンテナ/アーティファクトレジストリとして機能できます。

このセクションが設定されていない場合、Bencherはデータベースファイルと同じ階層の ociディレクトリにローカルファイルシステムストレージを使用します。 これは開発や単一インスタンスのデプロイメントに適しています。

複数インスタンスの本番デプロイメントや耐久性のためには、 S3ベースのストレージを設定してください。

2つのストレージserviceオプションがあります：

• local：ローカルファイルシステムにOCIアーティファクトを保存（デフォルト）
• aws_s3：AWS S3にOCIアーティファクトを保存
  • access_key_id：AWSアクセスキーID
  • secret_access_key：AWSシークレットアクセスキー
  • access_point：オプションのパスプレフィックス付きS3アクセスポイントARN。 形式：arn:aws:s3:<region>:<account-id>:accesspoint/<access-point-name>[/<path-prefix>]
  • chunk_size：S3に保存する前のアップロードデータのバッファリング用最小チャンクサイズ（バイト）（デフォルト：5 MB）。 HTTPリクエストボディは小さなネットワークフレーム（通常8–64 KB）として到着します。バッファリングなしでは、各フレームが個別のS3オブジェクトとして保存され、レイヤーごとに数千のオブジェクトが作成されます。この値はS3マルチパートアップロードの最小パートサイズにも対応しています。

plus.runners

このセクションでは、ベアメタルベンチマーク実行のためのランナーシステムを設定します。 ランナーはサーバースコープのエージェントで、ベンチマークジョブを要求して実行します。

このセクションが設定されていない場合、Bencherはデフォルト値を使用します。

plus.rate_limiting

このセクションでは、APIサーバーのレート制限を指定します。 このセクション全体はオプションです。 指定しない場合、リストされたデフォルト値が使用されます。

unclaimedプロジェクトの作成を防ぐには、 unclaimed_limitを0に設定します。

public

publicレートリミッターは、未認証リクエストに対してIPアドレスごとに適用されます。 各サブフィールドにはminute、hour、dayの制限が含まれます。 このセクション全体はオプションです。 指定しない場合、リストされたデフォルト値が使用されます。

user

userレートリミッターは、認証済みユーザーごとに適用されます。 各サブフィールドにはminute、hour、dayの制限が含まれます。 このセクション全体はオプションです。 指定しない場合、リストされたデフォルト値が使用されます。

project

projectレートリミッターは、プロジェクトごとに適用されます。 各サブフィールドにはminute、hour、dayの制限が含まれます。 このセクション全体はオプションです。 指定しない場合、リストされたデフォルト値が使用されます。

runner

runnerレートリミッターは、ランナーごとに適用されます。 各サブフィールドにはminute、hour、dayの制限が含まれます。 このセクション全体はオプションです。 指定しない場合、リストされたデフォルト値が使用されます。

oci_bandwidth

oci_bandwidthは、組織ティアごとの日次OCIレジストリ帯域幅制限を指定します。 このセクション全体はオプションです。 指定しない場合、リストされたデフォルト値が使用されます。

plus.stats

このセクションは、サーバー統計がどのくらいの頻度で収集されるのかを指定します。 このセクション全体は任意です。 何も指定されない場合は、リストされたデフォルト値が使用されます。 つまり、サーバー統計はオプトアウトです。 サーバー統計を無効にするには、enabledをfalseに設定します。