Naar hoofdinhoud gaan
Het AppSignal Node.js-pakket wordt geleverd met een zelfdiagnose-tool. Deze tool kan worden gebruikt om uw AppSignal-installatie te debuggen en is een van de eerste dingen waar ons supportteam om vraagt wanneer er een probleem is.

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.
Lees meer over hoe u het diagnosecommando gebruikt op de Debugging-pagina.

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 een package.json en @appsignal/nodejs geïnstalleerd) het volgende uit:
npx @appsignal/cli diagnose
Op zijn minst moet 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:
npx @appsignal/cli diagnose --api-key="<PUSH API KEY HERE>"
U kunt de omgevingsvariabele ook tijdens runtime instellen:
APPSIGNAL_PUSH_API_KEY="<PUSH API KEY HERE>" npx @appsignal/cli diagnose
Om de diagnose op uw productieserver uit te voeren en het rapport voor ondersteuningsdoeleinden naar AppSignal te versturen, kunt u het volgende commando uitvoeren:
npx @appsignal/cli diagnose --environment=production --send-report --api-key="<PUSH API KEY HERE>"
De omgevingsoptie is nuttig wanneer de standaardomgeving niet de omgeving is die u wilt diagnosticeren. De diagnosetool waarschuwt u wanneer er geen omgeving is geselecteerd.

Opties

OptieBeschrijving
--environment=<environment>Stel de omgeving in die in het commando moet worden gebruikt, bijv. production of staging.
--api-keyDefinieer welke API-sleutel moet worden gebruikt.
--[no-]send-reportAutomatisch verzenden, of het rapport niet verzenden.

Omgevingsoptie

Definieer welke app-omgeving AppSignal moet laden in de diagnose-CLI.
npx @appsignal/cli diagnose --environment=production

Optie voor rapportindiening

De opties om het rapport in te dienen — direct of niet — zijn toegevoegd aan het AppSignal Node.js-pakket versie 1.2.5. Het rapport bij AppSignal indienen:
npx @appsignal/cli diagnose --send-report
Het rapport niet bij AppSignal indienen:
npx @appsignal/cli diagnose --no-send-report

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: true en false.
  • 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: [].
  • Null- of undefined-waarden worden afgedrukt als null of undefined.