Konfiguration - AppSignal Documentation

Die CLI liest ihre Einstellungen aus einer TOML-Konfigurationsdatei. Es gibt zwei Arten: eine globale Konfiguration, die mit Ihrem Konto verknüpft ist, und eine optionale projektlokale .appsignal.toml, die innerhalb eines Projekts die Oberhand gewinnt. Diese Seite behandelt den project-Befehl, wo jede Datei lebt und jeden Schlüssel, den Sie festlegen können.

Der `project`-Befehl

appsignal-cli project init erstellt oder aktualisiert eine projektlokale .appsignal.toml:

Shell

appsignal-cli project init

Wenn Sie ihn innerhalb eines Git-Checkouts ausführen, schreibt die CLI .appsignal.toml in das Repository-Stammverzeichnis. Außerhalb eines Git-Checkouts verwendet sie das aktuelle Verzeichnis. Sie können die Standard-Organisation des Projekts beim Erstellen der Datei festlegen:

Shell

appsignal-cli project init --org <YOUR_ORG_SLUG>

project init akzeptiert diese Flags:

Flag	Beschreibung
`--org <slug>`	Standard-Organisation für das Projekt festlegen
`--endpoint <url>`	Das Projekt auf einen Nicht-Produktions-AppSignal-Server verweisen
`--rest-endpoint <url>`	Das Projekt auf eine Nicht-Produktions-REST- oder Public-API-Basis-URL verweisen
`--oauth-client-id <id>`	OAuth-Client-ID für das Projekt überschreiben

project init kopiert Ihre globalen OAuth-Anmeldedaten nicht in die Projektdatei. Führen Sie nach dem Erstellen appsignal-cli auth login innerhalb des Projekts aus, um projektspezifische Anmeldedaten einzurichten.

Committen Sie .appsignal.toml nicht in die Versionskontrolle. Nach der Authentifizierung enthält sie Ihre OAuth-Tokens. Fügen Sie sie zu Ihrer .gitignore hinzu.

Wo die Konfiguration lebt

Die globale Konfiguration lebt im Standard-Konfigurationsverzeichnis Ihres Betriebssystems; ihr genauer Pfad variiert je nach Betriebssystem. Führen Sie appsignal-cli auth status aus, um zu sehen, wo Ihre ist. Sie enthält Ihre kontoweiten Anmeldedaten und die Standard-Organisation. Eine projektlokale .appsignal.toml kann überall in einem Projekt leben. Wenn die CLI innerhalb dieses Projekts oder eines Unterverzeichnisses ausgeführt wird, verwendet sie die nächstliegende .appsignal.toml als einzige Konfiguration für dieses Projekt. Wenn eine projektlokale Konfiguration aktiv ist, liest und schreibt die CLI nur diese Datei. Andernfalls verwendet sie die globale Konfiguration. Der org-Wert wird automatisch gespeichert, wenn Sie appsignal-cli apps list oder appsignal-cli apps set-org --org <slug> ausführen, in welche Konfiguration auch immer aktiv ist. Führen Sie zuerst project init aus, wenn diese Schreibvorgänge lokal im Projekt bleiben sollen.

Konfigurationsschlüssel

Beide Dateien verwenden dieselben Schlüssel:

Schlüssel	Beschreibung
`org`	Standard-Organisations-Slug, der verwendet wird, wenn ein Befehl `--org` auslässt.
`[oauth]`-Tabelle	OAuth-Anmeldedaten (`access_token`, `refresh_token`, `expires_at`). Automatisch von `appsignal-cli auth login` gesetzt.

Eine globale Konfiguration sieht so aus:

Global config

org = "<YOUR_ORG_SLUG>"

# Set automatically by `auth login`:
[oauth]
access_token = "..."
refresh_token = "..."
expires_at = 1742324400

Eine projektlokale .appsignal.toml verwendet dasselbe Format. OAuth-Tokens werden vor API-Aufrufen automatisch erneuert, sodass Sie sich nicht erneut anmelden müssen. OAuth verwendet immer den integrierten lokalen Callback unter http://127.0.0.1:9789/callback.

Telemetrie

Die CLI sendet ein minimales Best-Effort-Telemetrie-Event für jede Befehlsausführung, um AppSignal dabei zu helfen, die CLI-Nutzung und -Zuverlässigkeit zu messen. Jedes Event enthält nur den Befehlspfad, ob er erfolgreich war oder fehlgeschlagen ist, wie lange er gedauert hat, die CLI-Version und das Ausgabeformat. Es enthält keine Ihrer AppSignal-Daten. Um es auszuschalten, setzen Sie APPSIGNAL_CLI_TELEMETRY=0:

Shell

APPSIGNAL_CLI_TELEMETRY=0 appsignal-cli incidents list --app "MyApp" --environment production

Setzen Sie die Variable in Ihrem Shell-Profil, um die Telemetrie für jeden Befehl zu deaktivieren.

Benutzerdefinierte Endpoints

Die meisten Benutzer benötigen diese Einstellungen nie. Sie sorgen dafür, dass die CLI statt mit dem Standard-Server mit einem Nicht-Produktions-AppSignal-Server kommuniziert, was hauptsächlich für die Engineers von AppSignal selbst für Tests nützlich ist. Sie können sie als Flags auf project init oder auth login setzen oder als Schlüssel in Ihrer Konfigurationsdatei. Die Schlüssel sind:

Konfigurationsschlüssel	Beschreibung
`endpoint`	Basis-URL des AppSignal-Servers, ohne `/graphql`. Die CLI fügt `/graphql` für API-Aufrufe an und verwendet die Basis-URL für OAuth.
`rest_endpoint`	Basis-URL der REST- oder Public-API, wenn sie sich von `endpoint` unterscheidet.
`oauth_client_id`	OAuth-Client-ID, die während der Anmeldung verwendet werden soll. Wenn nicht gesetzt, verwendet die CLI den Produktions-Client oder registriert automatisch einen für Endpoints, die einen `registration_endpoint` anbieten.

Ein Wert wie https://appsignal.example.com/graphql wird nicht unterstützt. Verwenden Sie nur die Basis-URL.

Nächste Schritte

Mit Ihrer Konfiguration an Ort und Stelle listen Sie Ihre Apps auf und beginnen mit der Abfrage Ihrer Daten.

​Der project-Befehl

​Wo die Konfiguration lebt

​Konfigurationsschlüssel

​Telemetrie

​Benutzerdefinierte Endpoints

​Nächste Schritte

Der `project`-Befehl

Wo die Konfiguration lebt

Konfigurationsschlüssel

Telemetrie

Benutzerdefinierte Endpoints

Nächste Schritte