Sentry breadcrumbs: addBreadcrumb, filters en limieten | We.Inc
Zo werken Sentry breadcrumbs in de JavaScript SDK: automatische en handmatige breadcrumbs, filteren met beforeBreadcrumb, de standaardwaarde van 100 voor maxBreadcrumbs, en opschonen.
Breadcrumbs in Sentry zijn kleine registraties van wat er vlak voor een fout gebeurde: klikken, netwerkverzoeken, consoleberichten en paginawissels. De SDK verzamelt er veel automatisch, u voegt uw eigen toe met Sentry.addBreadcrumb(), en ze worden aan het volgende foutevent gekoppeld. Standaard bewaart de JavaScript SDK de laatste 100.
Instellingen voor breadcrumbs in één oogopslag
Instelling of aanroep
Wat het doet
Standaard
maxBreadcrumbs
Hoeveel breadcrumbs worden bewaard
beforeBreadcrumb
Elke breadcrumb bewerken of weggooien voordat hij wordt opgeslagen
Niet ingesteld
Sentry.addBreadcrumb()
Uw eigen breadcrumb vastleggen
Niet van toepassing
fatal, error, warning, log, info of debug
Niet ingesteld
Als een klant een fout tegenkomt op uw site, vertelt de stack trace waar de code brak, maar niet wat de klant daarvoor deed. Breadcrumbs vullen dat gat. Deze gids behandelt de JavaScript SDK voor de browser; andere Sentry-SDK's volgen hetzelfde idee met hun eigen standaardwaarden.
De SDK luistert naar klikken en toetsaanslagen, fetch- en XHR-verzoeken, consoleaanroepen en locatiewijzigingen, en maakt van elk een breadcrumb.
Uw eigen code kan er meer toevoegen met Sentry.addBreadcrumb(), bijvoorbeeld na het inloggen of nadat een kortingscode is toegepast.
Elke nieuwe breadcrumb gaat eerst door beforeBreadcrumb als u die hebt ingesteld. Geeft u null terug, dan wordt hij weggegooid.
Het bewaarde spoor is begrensd op maxBreadcrumbs; de SDK haalt de oudste weg zodra de lijst boven die grens uitkomt.
Wanneer een fout wordt vastgelegd, wordt het huidige spoor aan dat event gekoppeld en op de issuepagina getoond.
Gebruik een korte, vaste categorie zoals auth, cart of payment, zodat u het spoor op de issuepagina kunt filteren.
Zet details in data, niet in het bericht, zodat ze als velden verschijnen.
Zet nooit wachtwoorden, kaartnummers of volledige adressen in een breadcrumb. Sentry zegt zelf dat u geen PII moet loggen wanneer consolelogs breadcrumbs worden.
Is de console rumoerig, gooi consolebreadcrumbs dan weg in beforeBreadcrumb in plaats van maxBreadcrumbs voor alles te verlagen.
Met maxBreadcrumbs op 0 schakelt u breadcrumbs uit; de SDK stopt meteen bij waarden van 0 of lager.
Veelgestelde vragen
Wat is de standaardwaarde van maxBreadcrumbs?
100. De Sentry-documentatie noemt een standaard van 100 voor de JavaScript SDK, en de broncode van de SDK gebruikt hetzelfde getal als de optie niet is ingesteld.
Welke breadcrumbs worden automatisch vastgelegd?
In de browser-SDK: klikken en toetsaanslagen op DOM-elementen, XHR- en fetch-verzoeken, aanroepen van de console-API en alle locatiewijzigingen.
Welke sleutels kan een breadcrumb hebben?
type, category, message, level, timestamp en data. Volgens de documentatie worden andere sleutels tijdens de verwerking weggelaten.
Hoe voorkom ik dat een breadcrumb wordt vastgelegd?
Stel beforeBreadcrumb in binnen Sentry.init. Die ontvangt elke breadcrumb en een optionele hint, en kan een aangepaste breadcrumb teruggeven, of null om hem weg te gooien.
Worden breadcrumbs los verstuurd?
Nee. Ze worden in het geheugen bewaard en gekoppeld aan het volgende event dat de SDK verstuurt, zoals een fout.
Handmatige breadcrumbs die de moeite waard zijn
Automatische breadcrumbs vertellen u wat de browser deed. Handmatige vertellen u wat het bedrijfsproces deed: een klant koos snelle verzending, een kortingscode werd toegepast, een boekingsdatum werd gekozen.
Dat zijn de momenten waar een supportmedewerker als eerste naar vraagt, dus door ze vast te leggen bespaart u een vragenronde.
Persoonsgegevens buiten de deur houden
Breadcrumbs pikken vaak tekst op die u niet wilde bewaren: een e-mailadres in een consoleregel, een zoekopdracht in een URL. Schoon ze op in beforeBreadcrumb voordat ze worden opgeslagen, en gebruik beforeSend voor de rest van het event.
Sentry biedt ook data scrubbing aan de serverkant die u in de interface instelt, als tweede vangnet.
Codevoorbeelden
Een handmatige breadcrumb toevoegen
Leg een stap in het bedrijfsproces vast met een categorie, een kort bericht, een niveau en extra velden onder data.
Breadcrumbs filteren en opschonen
Gooi consoleruis weg, maskeer e-mailadressen en schrijf de standaardlimiet uit, zodat u die makkelijk kunt wijzigen.
Simulator voor het breadcrumbspoor
Leg een paar events vast, stel de opties in en veroorzaak dan een fout om te zien welke breadcrumbs meegaan. Dit is een simulatie in uw browser; er wordt niets naar Sentry gestuurd.