Configuración del Servidor API

El servidor API de Bencher requiere una configuración JSON al iniciar. La configuración se puede proporcionar de tres maneras:

• Variable de entorno BENCHER_CONFIG: El valor debe ser la configuración JSON
• Variable de entorno BENCHER_CONFIG_PATH: El valor debe ser la ruta de un archivo que contenga la configuración JSON
• Archivo /etc/bencher/bencher.json: Un archivo en esta ubicación que contenga la configuración JSON

Si no se encuentra ninguna configuración, se cargará una configuración predeterminada.

Ejemplo de configuración 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"
    },
    "busy_timeout": 5000
  },
  "smtp": {
    "hostname": "mailbonobo.com",
    "port": 587,
    "starttls": true,
    "username": "bencher",
    "secret": "WM3F2u9cqSNdBPLfy9sJ5kk9",
    "from_name": "Bencher",
    "from_email": "[email protected]"
  },
  "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"
      },
      "upload_timeout": 3600,
      "max_body_size": 1073741824
    },
    "runners": {
      "heartbeat_timeout": 90,
      "job_timeout_grace_period": 60
    },
    "rate_limiting": {
      "window": 86400,
      "unclaimed_limit": 255,
      "claimed_limit": 65536,
      "oci_bandwidth": {
        "unclaimed": 1073741824,
        "free": 10737418240,
        "plus": 107374182400
      }
    },
    "stats": {
      "offset": 11242,
      "enabled": true
    }
  }
}

console

security

server

Esta sección se basa en la configuración del servidor Dropshot.

logging

Esta sección se basa en la configuración de registro de Dropshot.

database

smtp

Esta sección especifica una configuración de servicio SMTP. Toda la sección es opcional. Si no se especifica, todos los mensajes serán enviados a logging en su lugar.

plus

Esta sección es para las características que están cubiertas por la Licencia Bencher Plus.

plus.github

Esta sección especifica la configuración para una aplicación de GitHub utilizada para la autenticación OAuth2. Debes tener una licencia válida de Bencher Plus Enterprise para al menos una organización en el servidor. Toda la sección es opcional. Si no se especifica, la autenticación con GitHub no estará habilitada.

plus.google

Esta sección especifica la configuración para un cliente de Google utilizado para la autenticación OAuth2. Debe tener una licencia Bencher Plus Enterprise válida para al menos una organización en el servidor. Toda la sección es opcional. Si no se especifica, la autenticación con Google no se habilitará.

plus.disaster_recovery

Esta sección especifica la configuración de recuperación ante desastres. Bencher admite la replicación continua de todos los cambios en la base de datos. Para ejecutar copias de seguridad bajo demanda o programadas, consulte la sección database.data_store de la configuración.

Hay tres esquemas de replicación:

• file: Replicar a una ruta de archivo local
  • path: Ruta para replicar a
• sftp: Replicar a través de SFTP
  • host: Nombre de host del sistema de destino
  • port: Número de puerto del sistema de destino
  • user: Nombre de usuario en el sistema de destino
  • password: (Opcional) Contraseña en el sistema de destino
  • path: (Opcional) Ruta en el sistema de destino
  • key_path: (Opcional) Ruta a la clave SSH
• s3: Replicar a cualquier almacenamiento compatible con S3
  • bucket: Nombre del bucket
  • path: (Opcional) Ruta en el bucket
  • endpoint: (AWS: Opcional | No AWS: Requerido) Punto final de replicación
  • region: (Opcional) Región del bucket
  • access_key_id: Clave de acceso S3
  • secret_access_key: Clave secreta de acceso S3

Los tres esquemas de réplica tienen las siguientes opciones adicionales:

• retention: (Opcional) Cantidad de tiempo que se conservarán los archivos de snapshot y WAL. Después del período de retención, se creará una nueva instantánea y se eliminará la antigua. Los archivos WAL que existan antes de la instantánea más antigua también se eliminarán. Por defecto es 24h.
• retention_check_interval: (Opcional) Especifica con qué frecuencia Bencher comprobará si necesita aplicar la retención. Por defecto es 1h.
• snapshot_interval: (Opcional) Especifica con qué frecuencia se crearán nuevas instantáneas. Esto se utiliza para reducir el tiempo de restauración, ya que las instantáneas más nuevas tendrán menos marcos WAL que aplicar. La retención aún se aplica a estas instantáneas. Si no establece un intervalo de instantáneas, se creará una nueva instantánea siempre que se realice la retención. Por defecto, la retención ocurre cada 24 horas.
• validation_interval: (Opcional) Cuando se especifica, Bencher restaurará automáticamente y validará que los datos en la réplica coincidan con la copia local. Deshabilitado por defecto. Habilitar esto puede aumentar significativamente el costo de ejecutar Bencher, ya que la mayoría de los servicios en la nube cobran por las descargas.
• sync_interval: (Opcional) Frecuencia en la que se envían marcos a la réplica. Por defecto es 1s. Aumentar la frecuencia puede aumentar significativamente los costos de almacenamiento en la nube.
• checkpoint.interval: (Opcional) Con qué frecuencia Litestream realiza un checkpoint PASSIVE no bloqueante independientemente del número de páginas. Litestream omite el checkpoint si hay lectores o escritores activos. Por defecto es 1m.
• checkpoint.min_page_count: (Opcional) Número mínimo de páginas WAL antes de que se active un checkpoint PASSIVE no bloqueante (~4KB por página). Litestream omite el checkpoint si hay lectores o escritores activos. Por defecto es 1000 (~4MB).
• checkpoint.truncate_page_n: (Opcional) Umbral de páginas para un checkpoint TRUNCATE bloqueante. Cuando se alcanza este umbral, Litestream realiza un checkpoint bloqueante que espera a que todos los lectores y escritores finalicen, lo que puede causar errores database is locked bajo carga. Por defecto es 0 (deshabilitado). Solo establezca un valor distinto de cero si necesita un límite superior en el tamaño del archivo WAL y comprende las implicaciones del bloqueo.

plus.registry

Esta sección especifica la configuración de almacenamiento del registro OCI (Open Container Initiative). Bencher puede funcionar como un registro de contenedores/artefactos compatible con OCI.

Si esta sección no está configurada, Bencher usará almacenamiento en el sistema de archivos local en un directorio oci junto al archivo de base de datos. Esto es adecuado para desarrollo y despliegues de instancia única.

Para despliegues de producción con múltiples instancias o para durabilidad, configure almacenamiento basado en S3.

Hay dos opciones de service de almacenamiento:

• local: Almacenar artefactos OCI en el sistema de archivos local (predeterminado)
• aws_s3: Almacenar artefactos OCI en AWS S3
  • access_key_id: ID de clave de acceso de AWS
  • secret_access_key: Clave de acceso secreta de AWS
  • access_point: ARN del punto de acceso S3 con prefijo de ruta opcional. Formato: arn:aws:s3:<region>:<account-id>:accesspoint/<access-point-name>[/<path-prefix>]

plus.runners

Esta sección configura el sistema de runners para la ejecución de benchmarks en bare metal. Los runners son agentes de ámbito de servidor que reclaman y ejecutan trabajos de benchmark.

Si esta sección no está configurada, Bencher usará los valores predeterminados.

plus.rate_limiting

Esta sección especifica la limitación de tasa para el servidor API. Toda la sección es opcional. Si no se especifica, se utilizarán los valores predeterminados enumerados.

Para evitar que se creen proyectos unclaimed, establezca el unclaimed_limit en 0.

plus.stats

Esta sección especifica si y cuándo se recogen las estadísticas del servidor. Toda la sección es opcional. Si no se especifica, se utilizarán los valores predeterminados listados. Es decir, las estadísticas del servidor son de opt-out. Establece enabled en false para desactivar las estadísticas del servidor.