samples- of traces-commando’s (aliassen) om individuele samples op te halen uit AppSignal’s tracing-data. Traces tonen wat er gebeurde tijdens een request, job of scriptuitvoering, en ze kunnen de trace achter een exception tonen.
Som traces op en open er vervolgens één om de span tree te bekijken en de timings, tags en attributes van één span te inspecteren.
Het commando is beschikbaar als samples of traces. appsignal-cli traces list en appsignal-cli samples list doen hetzelfde. Deze pagina gebruikt overal traces.
Traces worden opgehaald via AppSignal’s REST tracing API met uw ingelogde account, dus authenticeer eerst de CLI. Zie Authenticatie.
Gemeenschappelijke opties
Elktraces-commando identificeert één applicatie en gebruikt uw standaardorganisatie tenzij u anders aangeeft:
| Flag | Beschrijving |
|---|---|
--app <name> | Applicatienaam (voeg --environment toe wanneer meer dan één app de naam deelt) |
--environment <env> | Environment, gebruikt met --app, zoals production of development |
--app-id <id> | Het ID van de app (een lange hexadecimale string uit appsignal-cli apps list), in plaats van --app en --environment |
--org <slug> | Organisatie-slug (gebruikt uw standaard indien weggelaten) |
Een trace vinden vanuit een incident
De meeste onderzoeken beginnen bij een incident, niet bij een trace-ID. Deze stappen brengen u van een incidentnummer naar de span tree van één request, aan de hand van een LaravelPaymentDeclinedException op POST /checkout (exception incident 9).
1. Lees de digest van het incident
Error traces worden gegroepeerd op exception digest. Lees de digest uit het incident, of kopieer deze uit de AppSignal-app:Shell
digests-veld:
2. Som de traces op voor die digest
Geef de digest door aantraces errors. Elke rij is één vastgelegd voorkomen:
Shell
3. Inspecteer de trace
Geef het incidentnummer en de trace-ID door aantraces show-incident:
Shell
!! markeert de span die de exception heeft veroorzaakt: hier POST /checkout, direct na de 334 ms stripe.charge. Om één span volledig te inspecteren, voegt u --span-id toe met de waarde uit de span:. Zie één span inspecteren.
Deze stappen beginnen vanuit een exception incident. Als u vanuit iets anders start, gebruik dan het bijbehorende commando:
- Een performance incident:
traces incident --number <N>lijst zijn traces zonder digest. Zie voor een incident. - Een bekende namespace en action:
traces list --namespace <name> --action <name>. Zie voor een action.
Traces opsommen
Drie commando’s sommen traces op, afhankelijk van waar u begint: een performance action, een incident of een exception digest. Elk retourneert een tabel met trace-ID’s die u vervolgens kunt doorgeven aan de inspect-commando’s in de volgende sectie.Voor een action
Som de recente performance samples op voor één namespace en action:Shell
list vereist --namespace, --action en een app (--app of --app-id), en neemt deze aanvullende opties:
| Flag | Beschrijving |
|---|---|
--namespace <name> | Namespace om in te zoeken, bijv. web, background, graphql (verplicht) |
--action <name> | Action om traces voor op te halen, bijv. GET /products (verplicht) |
--start <ISO8601> | Starttijd, bijv. 2025-01-15T00:00:00Z (standaard 24 uur geleden) |
--end <ISO8601> | Eindtijd (standaard nu) |
--min-duration-ms <ms> | Retourneer alleen traces die minstens dit aantal milliseconden lang zijn |
--limit <N> | Maximaal aantal te retourneren traces (1–100, standaard 25) |
--page-all | Haal elke trace in het bereik op, waarbij --limit wordt genegeerd |
--namespace is de AppSignal namespace die de action groepeert, gewoonlijk web, background, rake, runner of graphql. Uw app kan ook custom namespaces definiëren. Als u niet zeker weet tot welke namespace een action behoort, gebruik dan traces incident --number <N>: dit leest de namespace- en action-namen direct uit het performance incident, zodat u ze niet zelf hoeft op te geven.Voor een incident
Sla de opzoeking van namespace en action over en som de samples achter een performance incident op op nummer:Shell
--action door om de opzoeking tot één ervan te beperken. Bovenop de gemeenschappelijke opties neemt incident:
| Flag | Beschrijving |
|---|---|
--number <N> | Nummer van het performance incident (verplicht) |
--action <name> | Beperk de opzoeking tot één action wanneer het incident er meerdere heeft |
--start <ISO8601> | Starttijd (standaard 24 uur geleden) |
--end <ISO8601> | Eindtijd (standaard nu) |
--min-duration-ms <ms> | Retourneer alleen traces die minstens dit aantal milliseconden lang zijn |
--limit <N> | Maximaal aantal traces per action (1–100, standaard 25) |
--page-all | Haal elke trace voor elke action op, waarbij --limit wordt genegeerd |
Error traces voor een exception
Som de error traces op achter een exception, geïdentificeerd door de digest ervan:Shell
errors vereist --digest en een app (--app of --app-id), en neemt ook --limit (1–100, standaard 25) en --page-all. Vind de digest op het exception incident in de AppSignal-app-UI, of gebruik traces show-incident in de volgende sectie om de digest volledig over te slaan.
Een trace inspecteren
Zodra u een trace-ID heeft, opent u deze om de span tree te zien: elke span met zijn kind, duur, aantal events en eventuele exception, gevolgd door een samenvatting. Drie commando’s doen dit, overeenkomend met de drie manieren waarop u de trace opsomde.Vanuit een action
Toon een performance trace op basis van de namespace, action en trace-ID ervan:Shell
!! en het exception-type.
Vanuit een exception digest
Toon een error trace op basis van de digest en trace-ID ervan:Shell
traces errors (of door traces incident voor een exception incident).
Vanuit een incidentnummer
Wanneer u een incidentnummer heeft in plaats van een namespace, action of digest, controleertshow-incident het incident voor u: aan de hand van het nummer zoekt het de namespace en action (of digest) op, zodat u ze niet hoeft aan te leveren. U kiest nog steeds welke trace u wilt inspecteren met --trace-id, dus lijst eerst de traces van het incident op met traces incident:
Shell
Één span inspecteren
Voeg--span-id toe aan elk van de show-commando’s om de volledige details van één span te printen in plaats van de tree: de timings, status, tags, span-attributes, events en resource-attributes.
Shell
span:-waarde aan het einde van elke regel in de span tree. Als het ID niet in de trace zit, somt de CLI op wat beschikbaar is:
Gevoelige gegevens
Standaard laten de show-commando’s HTTP-headers, request-parameters, sessiegegevens en functieparameters weg. Voeg--include-sensitive toe om ze te tonen:
Shell
Tijdsbereik en paginering
list, incident en de performance show-commando’s kijken standaard 24 uur terug. Verbreed of verplaats het venster met --start en --end (ISO 8601, bijvoorbeeld 2025-01-15T00:00:00Z). Als een trace ouder is dan het standaardvenster, meldt een opzoeking op ID dat deze niet werd gevonden: voer opnieuw uit met een eerdere --start.
--limit beperkt een listing tot maximaal 100 traces (standaard 25). Om in plaats daarvan elke trace in het bereik op te halen, gebruikt u --page-all, dat --limit negeert.
JSON-output
- Voeg de globale
--output json(of--format json) flag toe voor machineleesbare resultaten. - List-commando’s (
traces list,traces incident,traces errors) retourneren eentraces-array. - Show-commando’s (
traces show,traces show-error,traces show-incident) retourneren hettrace_iden de bijbehorendespans, plus een enkelespanwanneer u--span-iddoorgeeft. - Dit geldt voor zowel performance samples als error traces, en combineert met
--page-allom door elk resultaat te pagineren. - Resultaten (de JSON) worden naar stdout geschreven, terwijl statusberichten naar stderr worden geschreven, zodat het doorsluizen van de output naar een ander tool nooit niet-JSON tekst mengt.
Shell