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 로깅 설정에 기반합니다.

database

smtp

이 섹션은 SMTP 서비스 설정을 지정합니다. 전체 섹션은 선택 사항입니다. 지정되지 않으면 모든 메시지가 대신 logging으로 전송됩니다.

plus

이 섹션은 Bencher Plus 라이센스에서 다루는 기능에 대한 것입니다.

plus.github

이 섹션은 OAuth2 인증을 위해 사용되는 GitHub 앱의 설정을 지정합니다. 서버에 최소 한 개의 조직이 Bencher Plus Enterprise 라이센스를 유효하게 가져야 합니다. 전체 섹션은 선택 사항입니다. 지정되지 않으면 GitHub을 사용한 인증이 활성화되지 않습니다.

plus.disaster_recovery

이 섹션은 재해 복구 구성을 지정합니다. Bencher는 모든 데이터베이스 변경 사항을 지속적으로 복제하는 기능을 지원합니다. 요청 시 실행하거나 예약된 백업을 실행하려면 구성의 database.data_store 섹션을 참조하십시오.

네 가지 복제 scheme가 있습니다:

• 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 비밀 액세스 키
• abs: Azure Blob Storage에 복제
  • account_name: 계정 이름
  • bucket: 버킷 이름
  • path: (선택사항) 버킷 내 경로
  • account_key: Azure 계정 키
• gcs: Google Cloud Storage로 복제
  • 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

이 섹션은 서버 통계가 수집되는 조건과 시간을 지정합니다. 전체 섹션은 선택 사항입니다. 지정되지 않으면 나열된 기본값이 사용됩니다. 즉, 서버 통계는 opt-out 형태입니다. 서버 통계를 비활성화하려면 enabled를 false로 설정합니다.