API 服务器配置

Bencher API 服务器在启动时需要一个 JSON 配置。 这个配置可以通过以下三种方式提供：

• BENCHER_CONFIG 环境变量：该值应设置为 JSON 配置
• BENCHER_CONFIG_PATH 环境变量：该值应设置为包含 JSON 配置文件的路径
• /etc/bencher/bencher.json 文件：此位置的文件包含 JSON 配置

如果没有找到配置，则加载默认配置。

要在服务器运行时更新配置， 管理员可以使用 CLI bencher server config update 命令， 它访问 PUT /v0/server/config 端点。 所有更新后的配置都会保存到 BENCHER_CONFIG 环境变量中， 并且在磁盘上的 BENCHER_CONFIG_PATH。

示例 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:61016",
    "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"
    }
  },
  "smtp": {
    "hostname": "mailbonobo.com",
    "port": 587,
    "starttls": true,
    "username": "bencher",
    "secret": "WM3F2u9cqSNdBPLfy9sJ5kk9",
    "from_name": "Bencher",
    "from_email": "info@bencher.example.com"
  },
  "plus": {
    "disaster_recovery": {
      "busy_timeout": 5000,
      "replicas": [
        {
          "scheme": "s3",
          "bucket": "my-bucket",
          "path": "path/to/replicate",
          "access_key_id": "ABC123DoRemMiABC123",
          "secret_access_key": "AA3Chr-JSF5sUQqKwayx-FvCfZKsMev-5BqPpcFC3m7"
        }
      ]
    },
    "stats": {
      "offset": 11242,
      "enabled": true
    }
  }
}

console

security

server

此部分基于Dropshot服务器配置。

logging

本节基于 Dropshot logging 配置。

database

smtp

本节指定了一个 SMTP 服务配置。 整个部分是可选的。 如果未指定，则所有消息将发送到 logging。

plus

此部分用于介绍由Bencher Plus License覆盖的特性。

plus.github

此部分指定了用于 OAuth2 认证的 GitHub 应用的配置。 服务器上至少有一个组织必须拥有有效的 Bencher Plus 企业 许可证。 整个部分是可选的。 如果未指定，则不会启用与 GitHub 的认证。

plus.disaster_recovery

此部分指定了灾难恢复配置。 Bencher支持连续复制所有数据库更改。 欲了解按需运行或计划备份，请参阅配置中的database.data_store部分。

有四种复制scheme：

• file: 复制到本地文件路径
  • path: 复制路径
• sftp: 通过SFTP复制
  • host: 目标系统主机名
  • port: 目标系统端口号
  • user: 目标系统的用户名
  • password: （可选）目标系统的密码
  • path: （可选）目标系统中的路径
  • key_path: （可选）SSH密钥路径
• s3: 复制到任何S3兼容的Blob存储
  • bucket: 存储桶名称
  • path: （可选）存储桶中的路径
  • endpoint: （AWS：可选 | 非AWS：必需）复制端点
  • region: （可选）存储桶区域
  • access_key_id: S3访问密钥
  • secret_access_key: S3密钥
• abs: 复制到Azure Blob存储
  • account_name: 账户名称
  • bucket: 存储桶名称
  • path: （可选）存储桶中的路径
  • account_key: Azure账户密钥
• gcs: 复制到Google云存储
  • bucket: 存储桶名称
  • path: （可选）存储桶中的路径
  • GOOGLE_APPLICATION_CREDENTIALS: 环境变量设置为指向服务账户凭据文件的路径

以上四种复制scheme均有以下附加选项：

• retention: （可选）快照和WAL文件保留的时间。保留期过后，会创建新的快照并删除旧的。在最旧快照之前存在的WAL文件也将被删除。默认值为24h。
• retention_check_interval: （可选）指定Bencher检查是否需要执行保留的频率。默认值为1h。
• snapshot_interval: （可选）指定创建新快照的频率。这用于减少恢复时间，因为较新的快照将有较少的WAL帧需要应用。保留仍然适用于这些快照。如果未设置快照间隔，则每次执行保留时都会创建新快照。 默认情况下，每24小时进行一次保留。
• validation_interval: （可选）如果指定，Bencher将自动恢复并验证副本上的数据与本地副本是否匹配。默认情况下禁用。启用此选项可能会显著增加运行Bencher的成本，因为大多数云服务会为下载收费。
• sync_interval: （可选）将帧推送到副本的频率。默认值为1s。增加频率可能显著增加云存储成本。

plus.stats

该部分指定是否以及何时收集服务器统计信息。 整个部分是可选的。 如果未指定，将使用列出的默认值。 也就是说，服务器统计信息是默认启用的。 设置enabled为false以禁用服务器统计。