Het diagnoserapport
Deze commandline-tool is nuttig bij het testen van AppSignal op een systeem en het valideren van de lokale configuratie. De tool produceert nuttige informatie om problemen te debuggen en controleert of de AppSignal-agent kan draaien op de architectuur van de machine en kan communiceren met de AppSignal-servers. Deze diagnosetool verzamelt en toont het volgende:- informatie over het AppSignal-pakket.
- informatie over het hostsysteem en Node.js.
- of de AppSignal-extensie en agent kunnen draaien op het hostsysteem.
- alle geconfigureerde configuratie-opties (inclusief standaardwaarden).
- of de configuratie geldig en actief is.
- of de Push API-sleutel aanwezig en geldig is (internetverbinding vereist).
- waar configuratie-optiewaarden vandaan komen.
Het rapport indienen
U moet de optie--send-report doorgeven om het diagnoserapport naar AppSignal te versturen. Als deze wordt gebruikt, wordt het rapport naar onze servers verzonden en ontvangt u een support-token.
Wanneer u dit support-token naar ons stuurt, bekijken wij het rapport en helpen wij u bij het debuggen van het probleem. We hebben gezien dat het kopiëren en plakken van de rapportuitvoer doorgaans opmaak verliest en het moeilijker leesbaar maakt, daarom wordt het in JSON-formaat naar onze servers verzonden.
Gebruik
Voer in uw project op de commandline (een map met eenpackage.json en @appsignal/nodejs geïnstalleerd) het volgende uit:
APPSIGNAL_PUSH_API_KEY zijn ingesteld voordat het diagnosecommando kan worden uitgevoerd. Als deze nog niet in uw omgeving is ingesteld, kunt u deze ook tijdens runtime instellen met de optie --api-key:
Opties
| Optie | Beschrijving |
|---|---|
--environment=<environment> | Stel de omgeving in die in het commando moet worden gebruikt, bijv. production of staging. |
--api-key | Definieer welke API-sleutel moet worden gebruikt. |
--[no-]send-report | Automatisch verzenden, of het rapport niet verzenden. |
Omgevingsoptie
Definieer welke app-omgeving AppSignal moet laden in de diagnose-CLI.Optie voor rapportindiening
De opties om het rapport in te dienen — direct of niet — zijn toegevoegd aan het AppSignal Node.js-pakket versie1.2.5.
Het rapport bij AppSignal indienen:
Uitvoerformaat van de configuratie
Formaat van configuratie-optiewaarden
De configuratie-opties worden in de CLI afgedrukt als hun geïnspecteerde waarden. Dit betekent dat we ze afdrukken zoals Node.js dat in een console zou doen.- Stringwaarden worden afgedrukt met dubbele aanhalingstekens eromheen, bijv.
"My app name". - Booleanwaarden worden afgedrukt als hun ruwe waarden:
trueenfalse. - Array-waarden worden afgedrukt als een verzameling waarden omgeven door vierkante haken, bijv.
["HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET"].- Lege arrays worden afgedrukt als twee vierkante haken:
[].
- Lege arrays worden afgedrukt als twee vierkante haken:
- Null- of undefined-waarden worden afgedrukt als
nullofundefined.