Configuração do Servidor API

O Bencher API Server requer uma configuração JSON no momento da inicialização. A configuração pode ser fornecida de três maneiras:

• Variável de ambiente BENCHER_CONFIG: O valor deve ser definido para a configuração JSON
• Variável de ambiente BENCHER_CONFIG_PATH: O valor deve ser definido para o caminho de um arquivo que contenha a configuração JSON
• Arquivo /etc/bencher/bencher.json: Um arquivo neste local contendo a configuração JSON

Se nenhuma configuração for encontrada, uma configuração padrão será carregada.

Exemplo de configuração 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

Esta seção é baseada na configuração do servidor Dropshot.

logging

Esta seção é baseada na configuração de logging do Dropshot.

database

smtp

Esta seção especifica uma configuração de serviço SMTP. Toda a seção é opcional. Se não for especificada, todas as mensagens serão enviadas para logging.

plus

Esta seção é para recursos que são cobertos pela Licença Bencher Plus.

plus.github

Esta seção especifica a configuração para um aplicativo GitHub usado para autenticação OAuth2. Você deve ter uma licença Enterprise válida do Bencher Plus para pelo menos uma organização no servidor. A seção inteira é opcional. Se não especificada, a autenticação com o GitHub não será ativada.

plus.google

Esta seção especifica a configuração para um cliente Google usado para autenticação OAuth2. Você deve ter uma licença Bencher Plus Enterprise válida para pelo menos uma organização no servidor. Toda a seção é opcional. Se não for especificada, a autenticação com o Google não será ativada.

plus.disaster_recovery

Esta seção especifica a configuração de recuperação de desastres. O Bencher suporta a replicação contínua de todas as alterações no banco de dados. Para backups sob demanda ou agendados, consulte a seção database.data_store da configuração.

Existem três schemes de replicação:

• file: Replicar para um caminho de arquivo local
  • path: Caminho para replicar
• sftp: Replicar via SFTP
  • host: Nome do host do sistema de destino
  • port: Número da porta do sistema de destino
  • user: Nome de usuário no sistema de destino
  • password: (Opcional) Senha no sistema de destino
  • path: (Opcional) Caminho no sistema de destino
  • key_path: (Opcional) Caminho para a chave SSH
• s3: Replicar para qualquer armazenamento de blob compatível com S3
  • bucket: Nome do bucket
  • path: (Opcional) Caminho no bucket
  • endpoint: (AWS: Opcional | Não-AWS: Obrigatório) Endpoint de replicação
  • region: (Opcional) Região do bucket
  • access_key_id: Chave de acesso do S3
  • secret_access_key: Chave de acesso secreta do S3

Todos os três schemes de replicação têm as seguintes opções adicionais:

• snapshot.interval: (Opcional) Especifica com que frequência novos snapshots serão criados. Isso é usado para reduzir o tempo de restauração, já que snapshots mais novos terão menos frames WAL para aplicar. A retenção ainda se aplica a esses snapshots. Se você não definir um intervalo de snapshot, um novo snapshot será criado sempre que a retenção for realizada. A retenção ocorre a cada 24 horas por padrão.
• snapshot.retention: (Opcional) A quantidade de tempo que os arquivos de snapshot e WAL serão mantidos. Após o período de retenção, um novo snapshot será criado e o antigo será removido. Arquivos WAL que existirem antes do snapshot mais antigo também serão removidos. O padrão é 24h.
• validation.interval: (Opcional) Quando especificado, o Bencher restaurará automaticamente e validará que os dados na réplica correspondem à cópia local. Desativado por padrão. Habilitar isso pode aumentar significativamente o custo de execução do Bencher, já que a maioria dos serviços em nuvem cobra pelos downloads.
• sync_interval: (Opcional) Frequência com que os frames são enviados para a réplica. O padrão é 1s. Aumentar a frequência pode aumentar significativamente os custos de armazenamento em nuvem.
• checkpoint.interval: (Opcional) Com que frequência o Litestream realiza um checkpoint PASSIVE não bloqueante independentemente da contagem de páginas. O Litestream pula o checkpoint se leitores ou escritores estiverem ativos. O padrão é 1m.
• checkpoint.min_page_count: (Opcional) Número mínimo de páginas WAL antes de um checkpoint PASSIVE não bloqueante ser acionado (~4KB por página). O Litestream pula o checkpoint se leitores ou escritores estiverem ativos. O padrão é 1000 (~4MB).
• checkpoint.truncate_page_n: (Opcional) Limite de páginas para um checkpoint TRUNCATE bloqueante. Quando este limite é atingido, o Litestream realiza um checkpoint bloqueante que aguarda a conclusão de todos os leitores e escritores, o que pode causar erros database is locked sob carga. O padrão é 0 (desativado). Defina um valor diferente de zero apenas se precisar de um limite superior no tamanho do arquivo WAL e compreender as implicações do bloqueio.

plus.registry

Esta seção especifica a configuração de armazenamento do registro OCI (Open Container Initiative). O Bencher pode funcionar como um registro de contêineres/artefatos compatível com OCI.

Se esta seção não estiver configurada, o Bencher usará armazenamento em sistema de arquivos local em um diretório oci adjacente ao arquivo de banco de dados. Isso é adequado para desenvolvimento e implantações de instância única.

Para implantações de produção com múltiplas instâncias ou para durabilidade, configure o armazenamento baseado em S3.

Há duas opções de service de armazenamento:

• local: Armazenar artefatos OCI no sistema de arquivos local (padrão)
• aws_s3: Armazenar artefatos OCI no AWS S3
  • access_key_id: ID da chave de acesso AWS
  • secret_access_key: Chave de acesso secreta AWS
  • access_point: ARN do ponto de acesso S3 com prefixo de caminho opcional. Formato: arn:aws:s3:<region>:<account-id>:accesspoint/<access-point-name>[/<path-prefix>]
  • chunk_size: Tamanho mínimo do fragmento em bytes para armazenamento em buffer dos dados de upload antes de salvar no S3 (padrão: 5 MB). Os corpos de requisição HTTP chegam como pequenos frames de rede (tipicamente 8–64 KB). Sem armazenamento em buffer, cada frame se torna um objeto S3 separado, criando milhares de objetos por camada. Este valor também corresponde ao tamanho mínimo de parte para uploads multipart do S3.

plus.runners

Esta seção configura o sistema de runners para execução de benchmarks em bare metal. Runners são agentes de escopo de servidor que reivindicam e executam trabalhos de benchmark.

Se esta seção não estiver configurada, o Bencher usará os valores padrão.

plus.rate_limiting

Esta seção especifica o limite de taxa para o servidor da API. Toda a seção é opcional. Se não especificado, os valores padrão listados serão usados.

Para evitar que projetos unclaimed sejam criados, defina unclaimed_limit como 0.

public

O limitador de taxa public se aplica por endereço IP para solicitações não autenticadas. Cada subcampo contém limites de minute, hour e day. Toda a seção é opcional. Se não especificado, os valores padrão listados serão usados.

user

O limitador de taxa user se aplica por usuário autenticado. Cada subcampo contém limites de minute, hour e day. Toda a seção é opcional. Se não especificado, os valores padrão listados serão usados.

project

O limitador de taxa project se aplica por projeto. Cada subcampo contém limites de minute, hour e day. Toda a seção é opcional. Se não especificado, os valores padrão listados serão usados.

runner

O limitador de taxa runner se aplica por runner. Cada subcampo contém limites de minute, hour e day. Toda a seção é opcional. Se não especificado, os valores padrão listados serão usados.

oci_bandwidth

O oci_bandwidth especifica os limites diários de largura de banda do registro OCI por nível de organização. Toda a seção é opcional. Se não especificado, os valores padrão listados serão usados.

plus.stats

Esta seção especifica se e quando as estatísticas do servidor são coletadas. A seção inteira é opcional. Se não especificado, os valores padrão listados serão usados. Ou seja, as estatísticas do servidor são opt-out. Defina enabled como false para desabilitar as estatísticas do servidor.