Naar hoofdinhoud gaan
De AppSignal Ruby gem bevat een zelfdiagnostisch hulpmiddel waarmee u de installatie en configuratie van uw AppSignal-integratie kunt debuggen. Het is een van de eerste tools die ons supportteam u vraagt uit te voeren bij het oplossen van een probleem.

Het diagnoserapport

U kunt deze diagnosetool gebruiken om uw AppSignal-installatie te testen en valideren. Het geeft nuttige informatie weer om problemen op te lossen en controleert of de AppSignal-agent op de architectuur van de machine kan draaien en met de AppSignal-servers kan communiceren. Deze diagnosetool verzamelt en geeft het volgende weer:
  • Informatie over de AppSignal gem.
  • Informatie over het hostsysteem en Ruby.
  • Of de AppSignal extension en agent op het hostsysteem kunnen draaien.
  • Alle geconfigureerde configuratieopties (inclusief standaardwaarden).
  • Of de configuratie geldig en actief is.
  • Of de Push API key aanwezig en geldig is (internetverbinding vereist).
  • Waar de waarden van configuratieopties vandaan komen.
  • Of de vereiste systeempaden bestaan, schrijfbaar zijn en welke gebruiker en groep eigenaar zijn.
  • Kleine delen van het einde van de beschikbare logbestanden.
U kunt meer lezen over het gebruik van het diagnose-commando in onze Debugging documentatie.

Het rapport indienen

In gem versie 2.2.0 en hoger wordt u gevraagd om het rapport naar AppSignal te sturen. Als u akkoord gaat, wordt het rapport naar onze servers verzonden en ontvangt u een support-token. Wanneer u dit support-token naar ons stuurt bekijken we het rapport en helpen we u het probleem te debuggen. We hebben gemerkt 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. In gem versie 2.8.0 is de optie toegevoegd om het rapport zelf op AppSignal.com te bekijken. Een link naar het rapport wordt afgedrukt in de diagnose-uitvoer. Deze webweergave toont ook eventuele validatieproblemen en waarschuwingen die ons systeem heeft gedetecteerd.

Gebruik

Voer op de command-line in uw project het volgende uit:
appsignal diagnose
Als u een probleem ondervindt in productie en het rapport voor support naar AppSignal moet sturen, kunt u het volgende commando uitvoeren om het rapport te genereren en naar onze servers te sturen:
bundle exec appsignal diagnose --environment=production --send-report

Opties

OptieBeschrijving
--environment=<environment>Stel de omgeving in die in het commando gebruikt wordt, bv. production of staging.
--[no-]send-reportStuur het rapport automatisch, of niet.
--[no-]colorSchakel de kleuring van de uitvoer in of uit.

Environment-optie

Voer het onderstaande commando uit om een specifieke omgeving te selecteren met de CLI:
appsignal diagnose --environment=production
De environment-optie is nuttig wanneer er geen standaardomgeving is (niet-Rails-apps en apps die geconfigureerd zijn met een configuratiebestand) of wanneer de standaardomgeving niet de omgeving is die u wilt diagnosticeren. De diagnosetool waarschuwt u wanneer er geen omgeving is geselecteerd.

Optie voor het indienen van het rapport

De opties om het rapport direct in te dienen of niet, zijn toegevoegd in AppSignal gem versie 2.8.0. Door deze opties te gebruiken om wel of niet het rapport te verzenden, wordt deze vraag niet meer gesteld, wat het gebruik in niet-interactieve omgevingen vergemakkelijkt. Voer het onderstaande commando uit om diagnose uit te voeren en de rapportgegevens naar AppSignal te sturen:
appsignal diagnose --send-report
Voer het onderstaande commando uit om diagnose uit te voeren zonder de rapportgegevens naar AppSignal te sturen:
appsignal diagnose --no-send-report

Formaat van configuratie-uitvoer

Formaat van configuratieoptiewaarden

De configuratieopties worden afgedrukt naar de CLI als hun geïnspecteerde waarden. Dit betekent dat we ze afdrukken zoals Ruby dat in een console zou doen.
  • Stringwaarden worden afgedrukt met dubbele aanhalingstekens, bv. "My app name".
  • Boolean-waarden worden afgedrukt als hun ruwe waarden: true en false.
  • Array-waarden worden afgedrukt als een verzameling waarden omringd door vierkante haakjes, bv. ["HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET"].
    • Lege arrays worden afgedrukt als twee vierkante haakjes: [].
  • Nil-waarden worden afgedrukt als nil.

Configuratiebronnen

De configuratiesectie toont ook de herkomst van de waarden van configuratieopties, wat kan helpen om bronnen te identificeren die waarden uit andere configuratiebronnen overschrijven. U kunt meer lezen over configuratiebronnen, hun laadvolgorde en prioriteit in de documentatie over laadvolgorde van configuratie. De configuratieopties worden weergegeven op basis van de bron van hun waarden en het aantal bronnen die ze instellen, zoals in het onderstaande voorbeeld:
Shell
Configuration
  # Option with a value loaded only from the default source
  send_params: true

  # Option with one source
  # A different source than the default source
  name: "My app name" (Loaded from file)

  # Option with multiple sources
  # Listed in order of priority (highest priority last)
  active: true
    Sources:
      default: false
      file:    false
      env:     true