.appsignal.toml die het binnen een project overneemt. Deze pagina behandelt het project-commando, waar elk bestand staat en elke sleutel die u kunt instellen.
Het project-commando
appsignal-cli project init maakt of werkt een projectlokale .appsignal.toml bij:
Shell
.appsignal.toml naar de root van de repository. Buiten een git checkout gebruikt het de huidige directory.
U kunt de standaardorganisatie van het project instellen terwijl u het bestand aanmaakt:
Shell
project init accepteert deze flags:
| Flag | Beschrijving |
|---|---|
--org <slug> | Stel de standaardorganisatie voor het project in |
--endpoint <url> | Wijs het project naar een niet-productie AppSignal-server |
--rest-endpoint <url> | Wijs het project naar een niet-productie REST- of publieke API-base-URL |
--oauth-client-id <id> | Overschrijf het OAuth-client-ID voor het project |
project init kopieert uw globale OAuth-inloggegevens niet naar het projectbestand. Voer na het aanmaken appsignal-cli auth login uit binnen het project om projectspecifieke inloggegevens in te stellen.Waar config wordt opgeslagen
De globale config wordt opgeslagen in de standaard configuratiedirectory van uw besturingssysteem; het exacte pad varieert per besturingssysteem. Voerappsignal-cli auth status uit om te zien waar die van u zich bevindt. Het bevat uw accountbrede inloggegevens en standaardorganisatie.
Een projectlokale .appsignal.toml kan overal in een project staan. Wanneer de CLI binnen dat project of een subdirectory wordt uitgevoerd, gebruikt het de dichtstbijzijnde .appsignal.toml als de enige config voor dat project. Wanneer een projectlokale config actief is, leest en schrijft de CLI alleen dat bestand. Anders gebruikt het de globale config.
De org-waarde wordt automatisch opgeslagen wanneer u appsignal-cli apps list of appsignal-cli apps set-org --org <slug> uitvoert, in welke config dan ook actief is. Voer eerst project init uit als u wilt dat die writes lokaal aan het project blijven.
Configsleutels
Beide bestanden gebruiken dezelfde sleutels:| Sleutel | Beschrijving |
|---|---|
org | Standaard organisatie-slug, gebruikt wanneer een commando --org weglaat. |
[oauth] tabel | OAuth-inloggegevens (access_token, refresh_token, expires_at). Automatisch ingesteld door appsignal-cli auth login. |
Global config
.appsignal.toml gebruikt hetzelfde formaat.
OAuth-tokens worden automatisch vernieuwd voor API-aanroepen, zodat u zich niet opnieuw hoeft aan te melden. OAuth gebruikt altijd de ingebouwde lokale callback op http://127.0.0.1:9789/callback.
Telemetrie
De CLI verstuurt een minimale, best-effort telemetrie-event voor elke uitgevoerde commando, om AppSignal te helpen CLI-gebruik en -betrouwbaarheid te meten. Elke event bevat alleen het commandopad, of het slaagde of faalde, hoe lang het duurde, de CLI-versie en het outputformaat. Het bevat niets van uw AppSignal-gegevens. Om dit uit te zetten, stelt uAPPSIGNAL_CLI_TELEMETRY=0 in:
Shell
Aangepaste endpoints
De meeste gebruikers hebben deze instellingen nooit nodig. Ze laten de CLI praten met een niet-productie AppSignal-server in plaats van de standaard, wat vooral nuttig is voor de eigen engineers van AppSignal voor testen. U kunt ze instellen als flags bijproject init of auth login, of als sleutels in uw configbestand. De sleutels zijn:
| Configsleutel | Beschrijving |
|---|---|
endpoint | Base-URL van de AppSignal-server, zonder /graphql. De CLI voegt /graphql toe voor API-aanroepen en gebruikt de base-URL voor OAuth. |
rest_endpoint | Base-URL van de REST- of publieke API, wanneer deze afwijkt van endpoint. |
oauth_client_id | OAuth-client-ID om te gebruiken tijdens de login. Indien niet ingesteld, gebruikt de CLI de productieclient, of registreert er automatisch één voor endpoints die een registration_endpoint adverteren. |
https://appsignal.example.com/graphql wordt niet ondersteund. Gebruik alleen de base-URL.