Config Serveur API

Le serveur API Bencher nécessite une configuration JSON au démarrage. La configuration peut être fournie de trois manières :

• Variable d’environnement BENCHER_CONFIG : La valeur doit être définie sur la configuration JSON
• Variable d’environnement BENCHER_CONFIG_PATH : La valeur doit être définie sur le chemin d’un fichier contenant la configuration JSON
• Fichier /etc/bencher/bencher.json : Un fichier à cet emplacement contenant la configuration JSON

Si aucune configuration n’est trouvée, une configuration par défaut est chargée.

Exemple de configuration 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

Cette section se base sur la configuration du serveur Dropshot.

logging

Cette section est basée sur la configuration de logging Dropshot.

database

smtp

Cette section spécifie une configuration du service SMTP. Toute la section est optionnelle. Si elle n’est pas spécifiée, tous les messages seront envoyés à logging à la place.

plus

Cette section concerne les fonctionnalités couvertes par la Licence Bencher Plus.

plus.github

Cette section spécifie la configuration pour une application GitHub utilisée pour l’authentification OAuth2. Vous devez avoir une licence Bencher Plus Enterprise valide pour au moins une organisation sur le serveur. La totalité de la section est optionnelle. Si elle n’est pas spécifiée, alors l’authentification avec GitHub ne sera pas activée.

plus.google

Cette section spécifie la configuration pour un client Google utilisé pour l’authentification OAuth2. Vous devez disposer d’une licence Bencher Plus Entreprise valide pour au moins une organisation sur le serveur. Toute la section est facultative. Si elle n’est pas spécifiée, l’authentification via Google ne sera pas activée.

plus.disaster_recovery

Cette section spécifie la configuration de la récupération en cas de sinistre. Bencher prend en charge la réplication continue de tous les changements de base de données. Pour exécuter des sauvegardes à la demande ou programmées, consultez la section database.data_store de la configuration.

Il existe trois schémas de réplication :

• file: Répliquer vers un chemin de fichier local
  • path: Chemin de réplication
• sftp: Répliquer via SFTP
  • host: Nom d’hôte du système cible
  • port: Numéro de port du système cible
  • user: Nom d’utilisateur sur le système cible
  • password: (Optionnel) Mot de passe sur le système cible
  • path: (Optionnel) Chemin sur le système cible
  • key_path: (Optionnel) Chemin vers la clé SSH
• s3: Répliquer vers un stockage de blob compatible S3
  • bucket: Nom du bucket
  • path: (Optionnel) Chemin dans le bucket
  • endpoint: (AWS: Optionnel | Non-AWS: Requis) Point de terminaison de réplication
  • region: (Optionnel) Région du bucket
  • access_key_id: Clé d’accès S3
  • secret_access_key: Clé d’accès secret S3

Les trois schémas de réplique ont les options supplémentaires suivantes :

• snapshot.interval: (Optionnel) Spécifie la fréquence de création des nouveaux snapshots. Cela permet de réduire le temps de restauration car les snapshots plus récents auront moins de trames WAL à appliquer. La rétention s’applique toujours à ces snapshots. Si vous ne définissez pas d’intervalle de snapshot, un nouveau snapshot sera créé chaque fois que la rétention sera effectuée. La rétention se produit toutes les 24 heures par défaut.
• snapshot.retention: (Optionnel) La durée pendant laquelle les fichiers snapshot & WAL seront conservés. Après la période de rétention, un nouveau snapshot sera créé et l’ancien sera supprimé. Les fichiers WAL existants avant le snapshot le plus ancien seront également supprimés. La valeur par défaut est 24h.
• validation.interval: (Optionnel) Lorsqu’il est spécifié, Bencher restaurera automatiquement et validera que les données sur la réplique correspondent à la copie locale. Désactivé par défaut. Activer cela peut augmenter considérablement le coût d’exécution de Bencher car la plupart des services cloud facturent les téléchargements.
• sync_interval: (Optionnel) Fréquence à laquelle les trames sont poussées vers la réplique. La valeur par défaut est 1s. Augmenter la fréquence peut augmenter considérablement les coûts de stockage cloud.
• checkpoint.interval: (Optionnel) Fréquence à laquelle Litestream effectue un checkpoint PASSIVE non bloquant indépendamment du nombre de pages. Litestream ignore le checkpoint si des lecteurs ou écrivains sont actifs. La valeur par défaut est 1m.
• checkpoint.min_page_count: (Optionnel) Nombre minimum de pages WAL avant qu’un checkpoint PASSIVE non bloquant ne soit déclenché (~4Ko par page). Litestream ignore le checkpoint si des lecteurs ou écrivains sont actifs. La valeur par défaut est 1000 (~4Mo).
• checkpoint.truncate_page_n: (Optionnel) Seuil de pages pour un checkpoint TRUNCATE bloquant. Lorsque ce seuil est atteint, Litestream effectue un checkpoint bloquant qui attend la fin de tous les lecteurs et écrivains, ce qui peut provoquer des erreurs database is locked en cas de charge. La valeur par défaut est 0 (désactivé). Ne définissez une valeur non nulle que si vous avez besoin d’une limite supérieure sur la taille du fichier WAL et comprenez les implications du blocage.

plus.registry

Cette section spécifie la configuration du stockage du registre OCI (Open Container Initiative). Bencher peut fonctionner comme un registre de conteneurs/artefacts compatible OCI.

Si cette section n’est pas configurée, Bencher utilisera le stockage du système de fichiers local dans un répertoire oci adjacent au fichier de base de données. Ceci est adapté au développement et aux déploiements à instance unique.

Pour les déploiements de production avec plusieurs instances ou pour la durabilité, configurez le stockage basé sur S3.

Il existe deux options de service de stockage :

• local : Stocker les artefacts OCI sur le système de fichiers local (par défaut)
• aws_s3 : Stocker les artefacts OCI dans AWS S3
  • access_key_id : ID de clé d’accès AWS
  • secret_access_key : Clé d’accès secrète AWS
  • access_point : ARN du point d’accès S3 avec préfixe de chemin optionnel. Format : arn:aws:s3:<region>:<account-id>:accesspoint/<access-point-name>[/<path-prefix>]
  • chunk_size : Taille minimale de fragment en octets pour la mise en tampon des données d’upload avant le stockage dans S3 (par défaut : 5 Mo). Les corps de requête HTTP arrivent sous forme de petites trames réseau (typiquement 8–64 Ko). Sans mise en tampon, chaque trame devient un objet S3 séparé, créant des milliers d’objets par couche. Cette valeur correspond également à la taille minimale de partie pour les uploads multipart S3.

plus.runners

Cette section configure le système de runners pour l’exécution de benchmarks sur bare metal. Les runners sont des agents à l’échelle du serveur qui réclament et exécutent des tâches de benchmark.

Si cette section n’est pas configurée, Bencher utilisera les valeurs par défaut.

plus.rate_limiting

Cette section spécifie la limitation de débit pour le serveur API. Toute la section est facultative. Si elle n’est pas spécifiée, les valeurs par défaut énumérées seront utilisées.

Pour empêcher la création de projets unclaimed, définissez la unclaimed_limit à 0.

public

Le limiteur de débit public s’applique par adresse IP pour les requêtes non authentifiées. Chaque sous-champ contient des limites minute, hour et day. Toute la section est facultative. Si elle n’est pas spécifiée, les valeurs par défaut énumérées seront utilisées.

user

Le limiteur de débit user s’applique par utilisateur authentifié. Chaque sous-champ contient des limites minute, hour et day. Toute la section est facultative. Si elle n’est pas spécifiée, les valeurs par défaut énumérées seront utilisées.

project

Le limiteur de débit project s’applique par projet. Chaque sous-champ contient des limites minute, hour et day. Toute la section est facultative. Si elle n’est pas spécifiée, les valeurs par défaut énumérées seront utilisées.

runner

Le limiteur de débit runner s’applique par runner. Chaque sous-champ contient des limites minute, hour et day. Toute la section est facultative. Si elle n’est pas spécifiée, les valeurs par défaut énumérées seront utilisées.

oci_bandwidth

Le oci_bandwidth spécifie les limites quotidiennes de bande passante du registre OCI par niveau d’organisation. Toute la section est facultative. Si elle n’est pas spécifiée, les valeurs par défaut énumérées seront utilisées.

plus.stats

Cette section spécifie si et quand les statistiques du serveur sont collectées. L’ensemble de la section est facultatif. Si non spécifié, les valeurs par défaut énumérées seront utilisées. C’est-à-dire que les statistiques du serveur sont opt-out. Mettez enabled sur false pour désactiver les statistiques du serveur.