API-Server-Konfiguration

Der Bencher API-Server erfordert eine JSON-Konfiguration beim Start. Die Konfiguration kann auf drei Arten bereitgestellt werden:

• BENCHER_CONFIG Umgebungsvariable: Der Wert sollte auf die JSON-Konfiguration gesetzt sein
• BENCHER_CONFIG_PATH Umgebungsvariable: Der Wert sollte auf den Pfad einer Datei gesetzt sein, die die JSON-Konfiguration enthält
• /etc/bencher/bencher.json Datei: Eine Datei an diesem Ort, die die JSON-Konfiguration enthält

Wenn keine Konfiguration gefunden wird, wird eine Standardkonfiguration geladen.

Beispiel einer JSON-Konfiguration:

{
  "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",
    "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": {
      "replica": {
        "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",
      "storage": {
        "scheme": "s3",
        "bucket": "my-bucket",
        "path": "registry",
        "endpoint": "https://s3.example.com",
        "region": "auto",
        "access_key_id": "AKIAIOSFODNN7EXAMPLE",
        "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
        "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,
      "plus_limit": 1048576,
      "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
    },
    "mcp": {
      "openai_apps_challenge": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
    },
    "oauth": {
      "issuer": "https://api.bencher.example.com",
      "resources": [
        "https://mcp.bencher.example.com/mcp",
        "https://api.bencher.example.com/mcp"
      ],
      "signing_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASC...\n-----END PRIVATE KEY-----\n"
    }
  }
}

console

security

server

Dieser Abschnitt basiert auf der Dropshot-Serverkonfiguration.

logging

Dieser Abschnitt basiert auf der Dropshot Logging Konfiguration.

database

smtp

Dieser Abschnitt spezifiziert eine SMTP-Dienstkonfiguration. Der gesamte Abschnitt ist optional. Wenn nicht angegeben, werden alle Nachrichten stattdessen an logging gesendet.

plus

Dieser Abschnitt betrifft Funktionen, die von der Bencher Plus-Lizenz abgedeckt sind.

plus.github

Dieser Abschnitt spezifiziert die Konfiguration für eine GitHub App, die für die OAuth2-Authentifizierung verwendet wird. Sie müssen eine gültige Bencher Plus Enterprise Lizenz für mindestens eine Organisation auf dem Server haben. Der gesamte Abschnitt ist optional. Wenn er nicht angegeben ist, wird die Authentifizierung mit GitHub nicht aktiviert.

plus.google

Dieser Abschnitt legt die Konfiguration für einen Google-Client zur OAuth2-Authentifizierung fest. Sie müssen für mindestens eine Organisation auf dem Server über eine gültige Bencher Plus Enterprise-Lizenz verfügen. Der gesamte Abschnitt ist optional. Wird er nicht angegeben, wird die Authentifizierung mit Google nicht aktiviert.

plus.disaster_recovery

Dieser Abschnitt spezifiziert die Konfiguration der Notfallwiederherstellung. Bencher unterstützt das kontinuierliche Replizieren aller Datenbankänderungen.

Es gibt zwei Replikations-schemes:

• file: Replikation zu einem lokalen Dateipfad
  • path: Pfad, zu dem repliziert wird
• s3: Replikation zu einem S3-kompatiblen Blob-Speicher
  • bucket: Bucket-Name
  • path: (Optional) Pfad im Bucket
  • endpoint: (AWS: Optional | Nicht-AWS: Erforderlich) Replikationsendpunkt
  • region: (Optional) Bucket-Region
  • access_key_id: S3-Zugangsschlüssel
  • secret_access_key: S3-Geheimzugangsschlüssel

Beide Replikations-schemes haben die folgenden zusätzlichen Optionen:

• snapshot.interval: (Optional) Gibt an, wie oft neue Schnappschüsse erstellt werden. Dies wird verwendet, um die Zeit für die Wiederherstellung zu verkürzen, da neuere Schnappschüsse weniger WAL-Frames zum Anwenden haben. Die Aufbewahrung gilt auch für diese Schnappschüsse. Wenn Sie kein Schnappschussintervall festlegen, wird ein neuer Schnappschuss erstellt, wann immer die Aufbewahrung durchgeführt wird. Die Aufbewahrung erfolgt standardmäßig alle 24 Stunden.
• snapshot.retention: (Optional) Die Dauer, die Schnappschuss- und WAL-Dateien aufbewahrt werden. Nach dem Ablauf der Aufbewahrungsfrist wird ein neuer Schnappschuss erstellt und der alte entfernt. WAL-Dateien, die vor dem ältesten Schnappschuss existieren, werden ebenfalls entfernt. Standardwert ist 24h.
• validation.interval: (Optional) Wenn angegeben, wird Bencher automatisch wiederherstellen und validieren, dass die Daten auf der Replik mit der lokalen Kopie übereinstimmen. Standardmäßig deaktiviert. Das Aktivieren kann die Kosten für den Betrieb von Bencher erheblich erhöhen, da die meisten Cloud-Services Gebühren für Downloads erheben.
• sync_interval: (Optional) Häufigkeit, mit der Frames zur Replik übertragen werden. Standardwert ist 1s. Eine höhere Frequenz kann die Kosten für Cloud-Speicher erheblich erhöhen.
• checkpoint.interval: (Optional) Wie häufig Litestream einen nicht-blockierenden PASSIVE-Checkpoint durchführt, unabhängig von der Seitenanzahl. Litestream überspringt den Checkpoint, wenn Leser oder Schreiber aktiv sind. Standardwert ist 1m.
• checkpoint.min_page_count: (Optional) Mindestanzahl an WAL-Seiten, bevor ein nicht-blockierender PASSIVE-Checkpoint ausgelöst wird (~4KB pro Seite). Litestream überspringt den Checkpoint, wenn Leser oder Schreiber aktiv sind. Standardwert ist 1000 (~4MB).
• checkpoint.truncate_page_n: (Optional) Schwellenwert der Seitenanzahl für einen blockierenden TRUNCATE-Checkpoint. Wenn dieser Schwellenwert erreicht wird, führt Litestream einen blockierenden Checkpoint durch, der auf den Abschluss aller Leser und Schreiber wartet, was zu database is locked-Fehlern unter Last führen kann. Standardwert ist 0 (deaktiviert). Setzen Sie diesen Wert nur dann auf einen Wert ungleich Null, wenn Sie eine Obergrenze für die WAL-Dateigröße benötigen und die Auswirkungen der Blockierung verstehen.

plus.registry

Dieser Abschnitt spezifiziert die OCI (Open Container Initiative) Registry-Speicherkonfiguration. Bencher kann als OCI-kompatible Container-/Artefakt-Registry fungieren.

Wenn dieser Abschnitt nicht konfiguriert ist, verwendet Bencher den lokalen Dateisystemspeicher in einem registry-Verzeichnis neben der Datenbankdatei. Dies ist geeignet für Entwicklung und Einzelinstanz-Deployments.

Für Produktions-Deployments mit mehreren Instanzen oder für Dauerhaftigkeit konfigurieren Sie S3-kompatiblen Speicher.

Es gibt zwei Speicher-schemes:

• file: OCI-Artefakte im lokalen Dateisystem speichern (Standard)
  • path: (Optional) Verzeichnis für Registry-Daten. Standardmäßig ein registry-Verzeichnis neben der Datenbankdatei.
• s3: OCI-Artefakte in einem S3-kompatiblen Blob-Speicher speichern
  • bucket: Bucket-Name
  • path: (Optional) Schlüsselpräfix im Bucket. Führende, abschließende und wiederholte Schrägstriche werden entfernt, sodass registry, registry/ und /registry alle unter registry speichern.
  • endpoint: (AWS: Optional | Nicht-AWS: Erforderlich) Speicherendpunkt
  • region: (Optional) Bucket-Region. Erforderlich für AWS. Standardmäßig auto, was S3-kompatible Speicher erwarten.
  • access_key_id: S3-Zugangsschlüssel
  • secret_access_key: S3-Geheimzugangsschlüssel
  • chunk_size: (Optional) Minimale Chunk-Größe in Bytes für die Pufferung von Upload-Daten vor dem Speichern. Standard: 5 MB. HTTP-Anfragekörper kommen als kleine Netzwerk-Frames an (typischerweise 8 bis 64 KB). Ohne Pufferung wird jeder Frame als separates Objekt gespeichert, was Tausende von Objekten pro Layer erzeugt. Dieser Wert entspricht auch der minimalen S3-Multipart-Upload-Teilgröße.

Legen Sie eine Bucket-Lebenszyklusregel fest, die unvollständige Multipart-Uploads abbricht. Ein Absturz während des Abschlusses eines Blob-Uploads hinterlässt einen solchen, und der Server bricht ihn nicht ab.

Wenn Sie zuvor einen path konfiguriert haben, der mit einem Schrägstrich begann oder endete, verschieben Sie die vorhandenen Objekte vor dem Upgrade auf das normalisierte Präfix. Ein path von registry/ speicherte Schlüssel unter registry//<project>/... und speichert sie jetzt unter registry/<project>/.... Jedes Segment von path wird im gespeicherten Schlüssel außerdem prozentcodiert, wo es ein ASCII-Steuerzeichen, ein Nicht-ASCII-Zeichen oder eines von \ {` `^` `} % ` ] " > [ ~ < # | * ? enthält, und ein Segment, das genau . oder .. ist, wird als %2E oder %2E%2E gespeichert. Alle anderen Zeichen, einschließlich Leerzeichen, +, =, @ und :, werden unverändert gespeichert, sodass team#1 zu team%231 wird, während team+1 als team+1 bleibt. Daten unter einem Präfix, das jetzt codiert wird, benötigen dieselbe Verschiebung. Listen Sie vor dem Verschieben von Daten die tatsächlich im Bucket gespeicherten Schlüssel auf und vergleichen Sie sie mit dem neuen Präfix.

plus.runners

Dieser Abschnitt konfiguriert das Runner-System für die Bare-Metal-Benchmark-Ausführung. Runner sind serverseitige Agenten, die Benchmark-Jobs beanspruchen und ausführen.

Wenn dieser Abschnitt nicht konfiguriert ist, verwendet Bencher die Standardwerte.

plus.rate_limiting

Dieser Abschnitt spezifiziert die Ratenbegrenzung für den API-Server. Der gesamte Abschnitt ist optional. Wenn nicht angegeben, werden die aufgelisteten Standardwerte verwendet.

Um zu verhindern, dass unclaimed Projekte erstellt werden, setzen Sie unclaimed_limit auf 0.

public

Der public-Ratenbegrenzer gilt pro IP-Adresse für nicht authentifizierte Anfragen. Jedes Unterfeld enthält minute-, hour- und day-Limits. Der gesamte Abschnitt ist optional. Wenn nicht angegeben, werden die aufgelisteten Standardwerte verwendet.

user

Der user-Ratenbegrenzer gilt pro authentifiziertem Benutzer. Jedes Unterfeld enthält minute-, hour- und day-Limits. Der gesamte Abschnitt ist optional. Wenn nicht angegeben, werden die aufgelisteten Standardwerte verwendet.

project

Der project-Ratenbegrenzer gilt pro Projekt. Jedes Unterfeld enthält minute-, hour- und day-Limits. Der gesamte Abschnitt ist optional. Wenn nicht angegeben, werden die aufgelisteten Standardwerte verwendet.

runner

Der runner-Ratenbegrenzer gilt pro Runner. Jedes Unterfeld enthält minute-, hour- und day-Limits. Der gesamte Abschnitt ist optional. Wenn nicht angegeben, werden die aufgelisteten Standardwerte verwendet.

oci_bandwidth

Der oci_bandwidth-Ratenbegrenzer gibt tägliche OCI-Registry-Bandbreitenlimits pro Organisationsstufe an. Der gesamte Abschnitt ist optional. Wenn nicht angegeben, werden die aufgelisteten Standardwerte verwendet.

plus.stats

Dieser Abschnitt gibt an, ob und wann Serverstatistiken gesammelt werden. Der gesamte Abschnitt ist optional. Wenn nicht angegeben, werden die aufgeführten Standardwerte verwendet. Das heißt, Serverstatistiken sind opt-out. Setzen Sie enabled auf false, um die Sammlung von Serverstatistiken zu deaktivieren.

plus.mcp

Dieser Abschnitt konfiguriert den Bencher MCP-Server. Der gesamte Abschnitt ist optional.

plus.oauth

Mit diesem Abschnitt können sich MCP-Clients wie ChatGPT, claude.ai und Claude Code über OAuth bei Bencher MCP anmelden. Der API-Server wird zu ihrem OAuth-Autorisierungsserver, und Benutzer genehmigen jede App in der Bencher Console unter console.url. Der gesamte Abschnitt ist optional. Wenn er nicht angegeben ist, ist OAuth deaktiviert: Seine Endpunkte geben 404 Not Found zurück, und Bencher MCP akzeptiert nur API-Schlüssel und anonyme Anfragen.

Ein JSON-String kann keinen Zeilenumbruch enthalten, schreiben Sie daher jeden Zeilenumbruch in signing_key als \n. Erzeugen Sie zum Beispiel einen Schlüssel und geben Sie ihn als JSON-String aus, ohne ihn in eine Datei zu schreiben:

openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048 | jq -Rs .

Um den Signaturschlüssel zu rotieren, ersetzen Sie ihn. Dadurch wird keine App getrennt.

Der API-Server stellt seine OAuth-Endpunkte und Metadaten an der Wurzel von issuer bereit. Wenn ein Reverse Proxy den API-Server unter einem Pfadpräfix bereitstellt, etwa https://bencher.example.com/api, setzen Sie issuer auf den Origin (https://bencher.example.com) und tragen Sie die vollständige URL des MCP-Endpunkts in resources ein (https://bencher.example.com/api/mcp). Der Proxy muss dann /oauth/, /.well-known/oauth-authorization-server und /.well-known/openid-configuration am Origin an dieselben Pfade auf dem API-Server weiterleiten, und den Metadatenpfad jeder Ressource, hier /.well-known/oauth-protected-resource/api/mcp, an /.well-known/oauth-protected-resource/mcp auf dem API-Server. Bei mehr als einer Ressource muss der Proxy außerdem den Host Header unverändert durchreichen, da der API-Server anhand dieses Headers die anzukündigende Ressource auswählt.