Kowal Sentry-Integration für Magento 2
- SKU
- M2-SENTRY
Beschreibung / Kowal Sentry-Integration für Magento 2
MAGENTO 2 · FEHLER · PERFORMANCE · CHECKOUT
Sehen Sie Magento-Fehler zusammen mit ihrem Entstehungskontext.
Kowal Sentry
Kombinieren Sie PHP- und JavaScript-Monitoring mit Tracing, Checkout-Breadcrumbs sowie der Überwachung von Cron-Jobs und Befehlen. Verknüpfen Sie Ereignisse mit Umgebung und Release, um Ihrem Team die Diagnose des Shops zu erleichtern.
Backend und Frontend · Cron und CLI · Release-Tracking
SO FUNKTIONIERT ES IN DER PRAXIS
01 · Sie verbinden den Shop mit dem Projekt
Sie legen DSN, Umgebung und Umfang der erfassten Ereignisse fest.
02 · Sie erfassen den Fehlerkontext
Traces, Breadcrumbs und Logs helfen dabei, den Ablauf nachzuvollziehen.
03 · Sie analysieren in Sentry
Sie vergleichen Ereignisse, Releases und Prozesse mit Optimierungsbedarf.
Welche Vorteile bietet das Ihrem Shop?
Entdecken Sie die Funktionen, Einsatzmöglichkeiten und Einstellungen des Moduls.
Magento 2 und Sentry in einer einheitlichen Implementierung
Im E-Commerce wirken sich die schnelle Erkennung von Fehlern und die Analyse ihrer Ursachen direkt auf Umsatz, Kundenservice und Shop-Stabilität aus. Kowal_Sentry wurde als Magento 2-Modul entwickelt, mit dem sich der Shop ohne Eingriffe in Core-Dateien und unter Wahrung der Plattformarchitektur mit Sentry verbinden lässt.
Das Modul unterstützt die Überwachung der wichtigsten Bereiche des Shopbetriebs:
- PHP-Backend-Fehler,
- JavaScript-Fehler im Storefront und im Admin-Panel,
- Tracing von HTTP- und AJAX-Requests,
- Monitoring des Checkouts und des Bestellprozesses,
- Cron-Monitoring und Check-ins an Sentry,
- Monitoring von CLI-Befehlen,
- Release-Tracking,
- Source Maps für das Frontend,
- Structured Logs,
- Session Replay und User Feedback in kontrolliertem Umfang.
Dadurch erhält das technische Team einen zentralen Beobachtungspunkt für die gesamte Magento 2-Anwendung.
Schnellere Fehlererkennung in Magento 2
Kowal_Sentry erfasst Backend- und Frontend-Fehler, sodass Probleme nach ihrem Auftreten entsprechend der Konfiguration und Transportverfügbarkeit gemeldet werden können. Dies gilt sowohl für PHP-Exceptions als auch für JavaScript-Fehler, Probleme mit RequireJS, unbehandelte Promise Rejections oder checkoutbezogene Fehler.
Bessere Analyse der Shop-Performance
Das Modul unterstützt Performance-Tracing für Requests, AJAX-Aufrufe, Cron-Jobs und CLI-Befehle. Dadurch lassen sich langsame Prozesse, Performance-Regressionen und Engpässe in den zentralen Bereichen des Magento 2-Shops erkennen.
Monitoring von Checkout und Verkaufsprozessen
Für Onlineshops sind Bereiche, die sich direkt auf die Conversion auswirken, besonders wichtig. Kowal_Sentry unterstützt das Monitoring des Checkouts, der Zahlungs- und Versandartauswahl, des Place-Order-Vorgangs sowie bestellbezogener Prozesse. Dies ist besonders wichtig bei der Diagnose von Problemen mit Warenkorb, Zahlungen und Kaufabschluss.
Cron-Monitoring und Beobachtbarkeit technischer Prozesse
Viele wichtige Magento 2-Prozesse laufen über Cron im Hintergrund. Das Modul ermöglicht die Überwachung des Jobstarts, der Ausführungsdauer und des Erfolgs- oder Fehlerstatus sowie die Übermittlung von Check-ins an Sentry. Dadurch erhalten Sie eine bessere Kontrolle über Synchronisierungen, Importe, Exporte und Shop-Automatisierungen.
Sichere Integration mit Magento-Daten
Das Modul wurde unter Berücksichtigung des Datenschutzes entwickelt. Es unterstützt die Maskierung von Kundendaten, das Blockieren von Cookies und Autorisierungsheadern, die Schwärzung von Query-Parametern, die Begrenzung des POST-Bodys sowie zusätzliche Bereinigungsregeln für Checkout- und Zahlungsfelder.
PHP-Backend-Monitoring
Die Erweiterung unterstützt die vollständige Initialisierung des PHP SDK für:
- Storefront HTTP,
- Adminhtml,
- REST und GraphQL,
- Cron,
- CLI,
- eigene Endpoints und Integrationen.
Damit lassen sich Exceptions, Fatal Errors, manuelle Meldungen sowie zusätzlicher technischer oder geschäftlicher Kontext übermitteln.
JavaScript-Frontend-Monitoring
Im Browser integriert das Modul Magento 2 mit dem Sentry Browser SDK und unterstützt:
window.onerror,unhandledrejection,- RequireJS-Fehler,
- Breadcrumbs für AJAX,
- Tracing von Ladevorgängen und Interaktionen,
- Checkout-Instrumentation,
- Session Replay,
- User-Feedback-Widget.
Die Lösung eignet sich sowohl für den klassischen Magento-Storefront als auch für Shops mit einer größeren Anzahl individueller Skripte und Widgets.
Magento 2-Checkout-Monitoring
Der Checkout ist einer der kritischsten Bereiche eines Shops. Kowal_Sentry ermöglicht:
- das Tracking der Checkout-Schritte,
- das Tagging von Zahlungs- und Versandarten,
- Breadcrumbs für AJAX-Fehler im Checkout,
- das Melden von Exceptions im Zusammenhang mit Place Order,
- eine bessere Analyse von Problemen, die sich auf die Conversion auswirken.
Monitoring von Cron-Jobs und CLI
Durch die Integration mit im Hintergrund ausgeführten Prozessen hilft das Modul bei der Analyse von Problemen, die im Storefront nicht immer sichtbar sind:
- Fehler in Importern,
- fehlgeschlagene Integrationssynchronisierungen,
- lange Cron-Ausführungszeiten,
- Fehler bei
bin/magento, - instabile, asynchron ausgeführte Aufgaben.
Warum dieses Magento 2-Modul für Sentry produktionsbereit ist
Kowal_Sentry ist kein einfacher Wrapper zum Versenden von Exceptions. Es handelt sich um eine durchdachte Integrationsschicht, die gemäß den Best Practices von Magento 2 entwickelt wurde.
Das Modul:
- verändert keine Core-Dateien,
- verwendet Dependency Injection, Plugins, Observer und Layout XML,
- unterstützt die Konfiguration über das Admin-Panel,
- funktioniert in Local-, Dev-, Staging- und Production-Umgebungen,
- unterstützt Multistore,
- ermöglicht die unabhängige Steuerung von Backend und Frontend,
- berücksichtigt Datenschutz und Datenbereinigung,
- unterstützt Release-Strategien und die Vorbereitung für Source Maps.
Dies ist wichtig für Teams, die eine Lösung für den realen Produktiveinsatz und nicht nur für Entwicklertests suchen.
Error Monitoring für Magento 2
Das Modul kann folgende Ereignisse melden:
- Unhandled Exceptions,
- Fatal Errors,
- JavaScript-Fehler,
- AJAX-Fehler,
- manuelle
captureExceptionundcaptureMessage, - Ereignisse im Zusammenhang mit Checkout und Bestellungen.
Performance Monitoring für Magento 2
Kowal_Sentry unterstützt:
- Tracing von Backend-Requests,
- Tracing von Frontend-Requests,
- Spans für HTTP-Aufrufe und Integrationen,
- Monitoring der Cron-Ausführungszeit,
- Monitoring von CLI-Befehlen,
- Korrelation der Performance mit Release und Environment.
Structured Logs und Observability
Das Modul stellt eine Fassade für Structured Logs bereit. Dadurch kann Sentry nicht nur als Fehler-Repository, sondern auch als zentrale Stelle zur Korrelation von Logs, Traces und Exception Events dienen.
Session Replay und User Feedback
Im Frontend unterstützt die Lösung eine kontrollierte Implementierung von Session Replay mit Datenmaskierung sowie ein Feedback-Widget für Endnutzer. Dadurch lassen sich Fehler in tatsächlichen Benutzersitzungen besser nachvollziehen.
Datensicherheit und Datenschutz
Monitoring-Implementierungen im E-Commerce müssen den Schutz personenbezogener und betrieblicher Daten berücksichtigen. Kowal_Sentry wurde im Hinblick auf eine sichere Standardkonfiguration entwickelt.
Das Modul unterstützt standardmäßig:
- Maskierung von Kundendaten,
- Blockieren von Authorization-Headern,
- Blockieren von Cookies,
- Entfernen des POST-Bodys,
- Schwärzung von Query-Parametern,
- Maskierung von Checkout-Feldern,
- Maskierung zahlungsbezogener Felder,
- Kontrolle des Datenumfangs, der an Replay übertragen wird.
Dadurch kann die Sentry-Integration verantwortungsvoller und entsprechend den Anforderungen der jeweiligen Organisation implementiert werden.
Für wen ist das Modul Kowal_Sentry geeignet?
Diese Lösung richtet sich an:
- produktive Magento 2-Shops,
- Softwarehäuser, die Magento-Shops betreuen,
- DevOps-Teams sowie Backend- und Frontend-Entwickler,
- Unternehmen, die Observability im E-Commerce implementieren,
- Organisationen, die eine bessere Kontrolle über Checkout-Fehler, Integrationen und Performance benötigen.
Das Modul eignet sich sowohl für einzelne Shops als auch für Multistore-Installationen mit komplexeren Geschäftsprozessen.
Zusammenfassung
Kowal_Sentry ist ein umfangreiches Magento 2-Modul zur Integration mit Sentry, das Error Tracking, Performance Monitoring, Cron Monitoring, Checkout Observability und eine sichere Datenbereinigung kombiniert. Die Lösung richtet sich an Unternehmen, die die Stabilität ihres Shops erhöhen, Probleme schneller diagnostizieren und die Qualität von Magento 2 in der Produktionsumgebung besser kontrollieren möchten.
Wenn Sie ein Modul für Magento 2 Sentry Integration, Magento 2-Fehlermonitoring, Magento Performance Monitoring oder Magento 2-Checkout-Monitoring, Kowal_Sentry genau für dieses Szenario entwickelt.
Konfiguration von DSN und Monitoring-Umfang
Stores → Configuration → Kowal → Sentry ermöglicht die unabhängige Steuerung von Backend und Frontend. Geben Sie ausschließlich die DSN-URL des entsprechenden Projekts an und wählen Sie Umgebung, Release und Sampling.
Der Hauptschalter des Moduls ist standardmäßig deaktiviert. Replay und das Feedback-Widget müssen ebenfalls separat aktiviert werden. Ihre Verfügbarkeit hängt vom verwendeten SDK und von der Sentry-Konfiguration ab.
Releases und Source Maps im Deployment-Prozess
Die Release-Strategie unterstützt manual, env, file und generated. Das Modul erkennt unter anderem KOWAL_SENTRY_RELEASE, SENTRY_RELEASE, RELEASE_NAME und GIT_COMMIT.
Source-Map-Dateien laden Sie im CI/CD-Prozess hoch, beispielsweise mit sentry-cli. Das Modul lädt sie im normalen Magento-Betrieb nicht hoch. Stellen Sie sicher, dass Release, Dist und Asset-Pfade übereinstimmen, damit die richtigen Fehler-Stacktraces gelesen werden können.
Maskierung und Datenkontrolle
Die Standardregeln schwärzen Autorisierungsheader, Cookies, den POST-Body und ausgewählte Parameter. Benutzerkennungen können gehasht und Checkout- sowie Zahlungsselektoren in Replay maskiert oder blockiert werden.
Prüfen Sie bei eigenen Feldern und Integrationen eine Auswahl der Ereignisse. Eine musterbasierte Bereinigung garantiert nicht, dass sämtliche vertraulichen Informationen entfernt werden. Der Umfang sichtbarer Ereignisse hängt außerdem vom Sampling und von der Transportverfügbarkeit ab.
Tracing, Logs und Metriken sind unterschiedliche Funktionen
HTTP-, CLI- und Cron-Transaktionen sowie Structured Logs helfen dabei, Fehler mit Prozessen zu korrelieren. Die Fassade captureMetric ist verfügbar, das Repository weist jedoch auf Einschränkungen bei Backend-Metriken in der verwendeten SDK-Integration hin. Sie sollte nicht als vollständiges Messsystem betrachtet werden.
Nach der Aktivierung von Enable Test Commands können Sie die Befehle kowal:sentry:test:error, :transaction, :checkin und :log zur kontrollierten Überprüfung auf Ihrer Instanz verwenden.
Installation über Composer
Paket kowal/module-sentry, Modul Kowal_Sentry. Nachdem Sie den Zugriff auf das Kowal-Repository konfiguriert haben, installieren Sie das Paket, aktivieren das Modul, aktualisieren Magento und leeren den Cache. Berücksichtigen Sie in der Produktionsumgebung die Kompilierung und Bereitstellung statischer Inhalte gemäß dem Bereitstellungsprozess des Shops.
Von der Konfiguration zum Ergebnis
1. Sie verbinden den Shop mit dem Projekt
Sie legen DSN, Umgebung und Umfang der erfassten Ereignisse fest.
2. Sie erfassen den Fehlerkontext
Traces, Breadcrumbs und Logs helfen dabei, den Ablauf nachzuvollziehen.
3. Sie analysieren in Sentry
Sie vergleichen Ereignisse, Releases und Prozesse mit Optimierungsbedarf.
Fehler beim Aufgeben einer Bestellung
Ein Kunde stößt im Checkout auf ein Problem. Das Ereignis kann Breadcrumbs, die Zahlungs- oder Versandart und Informationen zum Release enthalten.
Das Team nutzt diesen Kontext, um die Ursache zu ermitteln. Der Detaillierungsgrad hängt von der Konfiguration, dem Sampling und der Integration des jeweiligen Checkouts ab.
Verbinden Sie das Monitoring mit Ihrem Shop-Wartungsprozess
Möchten Sie das Modul an Ihren Shop anpassen? Fragen Sie nach einer Implementierung von Kowal Sentry und besprechen Sie die Konfiguration oder benötigte Erweiterungen.
Weitere Informationen
| Übereinstimmung mit der Vorlage | Luma / Leer, KOWAL |
|---|
Installationsanleitung für das Modul
Kowal_Sentry: Installations- und Konfigurationsanleitung
Zweck des Moduls
Kowal_Sentryintegriert Magento 2 mit Sentry und ermöglicht das Monitoring von:
- PHP-Backend-Fehlern,
- JavaScript-Fehlern im Storefront und optional im Admin-Panel,
- HTTP-, CLI- und Cron-Transaktionen,
- Checkout-Breadcrumbs,
- Session Replay,
- User Feedback,
- Release-Tracking und Vorbereitung für Source Maps.
Das Modul wurde als Composer-Paket entwickelt und sollte aus dem Verzeichnisvendor/kowal/module-sentry.
Anforderungen
- Magento Open Source / Adobe Commerce 2.4.x
- PHP 8.1+
- Zugriff auf Sentry und mindestens ein Projekt
- E-Mail-Adresse des Kunden und Lizenz-Token für das Kowal Composer-Repository
Installation
Die folgenden Befehle wurden ausREADME.md.
Die Zugangsdaten zum Composer-Repository (E-Mail-Adresse des Kunden und Lizenz-Token) erhalten Sie nach dem Kauf per E-Mail. Sie sind außerdem nach dem Login im Kundenbereich unter kowal.storeverfügbar. Ersetzen Sie TWOJ_EMAIL_KLIENTA durch die E-Mail-Adresse Ihres Kontos und TWOJ_TOKEN durch den erhaltenen Token. Führen Sie die Befehle im Magento-Stammverzeichnis aus.
composer config repositories.kowal composer https://repo.kowal.store
composer config http-basic.repo.kowal.store "TWOJ_EMAIL_KLIENTA" "TWOJ_TOKEN"
composer require kowal/module-sentry
bin/magento module:enable Kowal_Sentry
bin/magento setup:upgrade
bin/magento cache:flush
Wichtig
- Das Composer-Paket darf nur aus
vendor/kowal/module-sentry. - Dasselbe Modul darf nicht gleichzeitig unter
app/code/Kowal/Sentry. - Nach der Installation finden Sie die Konfiguration unter:
Stores -> Configuration -> Kowal -> Sentry
Schnellstart
Minimale Konfiguration zum Starten des Moduls:
- Legen Sie
Enable Module = Yes. - Legen Sie
Environmentfest, z. B.productionoderstaging. - Aktivieren Sie
Enable Backend Monitoringund fügen SieBackend DSN. - Wenn Sie das Frontend überwachen möchten, aktivieren Sie
Enable Frontend Monitoringund fügen SieFrontend DSN. - Speichern Sie die Konfiguration und leeren Sie bei Bedarf den Cache der jeweiligen Umgebung.
Wo Sie die Daten aus Sentry finden
DSN
Die DSN finden Sie normalerweise hier:
Settings -> Projects -> [projekt] -> Client Keys (DSN)
In die FelderBackend DSNundFrontend DSN fügen Sie ausschließlich die DSN-URL ein, zum Beispiel:
https://examplePublicKey@o0000000000000000.ingest.de.sentry.io/0000000000000000
Fügen Sie nicht das vollständige Snippet ein:
\Sentry\init([
'dsn' => 'https://examplePublicKey@o0000000000000000.ingest.de.sentry.io/0000000000000000',
]);
Organization
Den Organisations-Slug können Sie am einfachsten aus der URL des Sentry-Panels ablesen, zum Beispiel:
https://sentry.io/settings/acme/projects/shop-frontend/
In diesem Beispiel gilt:
acmeistOrganizationshop-frontendistProject Slug
Project Slug
Sie finden ihn:
- in der Projekt-URL im Sentry-Panel,
- oder unter
Settings -> Projects -> [projekt] -> Details
Auth-Token für Source Maps
Wenn Siesentry-cliverwenden, sollte der Token außerhalb von Magento gespeichert werden, beispielsweise in der Umgebungsvariable:
SENTRY_AUTH_TOKEN
Token erstellen:
Settings -> Custom Integrations- oder
User Settings -> Personal Tokens
Überprüfung nach der Installation
Nach der Grundkonfiguration können Sie prüfen, ob das Modul aktiv ist und das SDK funktioniert. Die folgenden Smoke-Test-Befehle wurden ausREADME.md.
Nach der Aktivierung vonEnable Test Commands:
bin/magento kowal:sentry:test:error
bin/magento kowal:sentry:test:transaction
bin/magento kowal:sentry:test:checkin
bin/magento kowal:sentry:test:log
Konfiguration im Magento-Panel
Pfad:
Stores -> Configuration -> Kowal -> Sentry
Nachfolgend finden Sie eine Beschreibung der einzelnen Bereiche, Optionen und Einstellungsvarianten.
Bereich General
Dieser Bereich steuert die Aktivierung des Moduls, die Umgebung und die Berechnung vonrelease.
Enable Module
Yes: aktiviert das Modul global.No: Backend und Frontend werden nicht initialisiert, selbst wenn andere Optionen aktiviert sind.
Empfehlung:
Yesin der Umgebung, aus der Sie Daten an Sentry senden möchten.
Environment
Beispiele:
productionstagingdevelopment
Varianten:
- ein gemeinsamer Name für die gesamte Instanz,
- unterschiedliche Werte pro Website/Store View, wenn Ereignisse getrennt werden sollen.
Empfehlung:
- ohne Leerzeichen und Schrägstriche,
- verwenden Sie eine einheitliche Benennung für Backend, Frontend und CI/CD.
Release Strategy
Verfügbare Varianten:
manual: Release stammt aus dem FeldRelease Name Overrideenv: Release wird aus Umgebungsvariablen übernommenfile: Release wird aus einer Datei gelesengenerated: Release wird automatisch vom Modul zusammengesetzt
Wann verwenden:
manual: bei manueller Release-Eingabe, eher als Ausweichlösung oder bei einfachen Implementierungenenv: ideal für CI/CD, wenn das Deployment den Release übergibtfile: wenn das Deployment die Versionskennung in eine gemeinsam genutzte Datei schreibtgenerated: für den Einstieg, wenn noch keine ausgereifte Release-Pipeline vorhanden ist
Unterstützte Umgebungsvariablen:
KOWAL_SENTRY_RELEASESENTRY_RELEASERELEASE_NAMEGIT_COMMIT
Release Name Override
Wird nur bei der Strategiemanual.
Beispiel:
magento-store@2.4.7-p1+20260410.1
Empfehlung:
- Beim Upload der Source Maps sollte exakt derselbe Wert verwendet werden.
Project Name
Hilfsname des Projekts in den Modulkontexten. Dies ist nicht derProject Slugaus Sentry.
Varianten:
- Name der Shop-Instanz,
- Name der Shop-Gruppe,
- Name des internen Projekts.
Debug Mode
Yes: ausführlichere DiagnoseprotokollierungNo: Produktionsmodus
Empfehlung:
Noin der Produktionsumgebung,Yesvorübergehend zur Diagnose der Konfiguration.
Enable Test Commands
Yes: stellt Testbefehle bereitbin/magentoNo: blendet sie im Normalbetrieb aus
Empfehlung:
Yesauf Staging oder während Tests,Noin der dauerhaften Produktivkonfiguration.
Abschnitt Backend SDK
Betrifft das PHP-SDK für Storefront-HTTP, Administration, API, Cron und CLI.
Enable Backend Monitoring
Yes: aktiviert das Backend-MonitoringNo: das Backend sendet keine Fehler und Traces an Sentry
Backend DSN
Dies ist die primäre DSN für das PHP SDK.
Varianten:
- separates Sentry-Projekt nur für das Backend
- dasselbe Projekt für Backend und Frontend
Empfehlung:
- Bei ausgereifteren Implementierungen sollten getrennte Projekte für Backend und Frontend verwendet werden,
- bei kleineren Installationen kann zunächst ein gemeinsames Projekt verwendet werden.
Error Sample Rate
Bereich:0-1
Beispiele:
1: alle Fehler senden0.5: ungefähr die Hälfte senden0.25: ungefähr 25 % senden
Empfehlung:
- normalerweise
1.0für Fehler, zumindest zu Beginn.
Trace Sample Rate
Bereich:0-1
Beispiele:
0.05: niedriges Sampling, geeignet für Produktionsumgebungen mit hohem Traffic0.1: sinnvoller Ausgangspunkt0.2: mehr Daten bei höherem Volumen
Empfehlung:
- in der Produktionsumgebung normalerweise
0.05-0.2, abhängig von Traffic und Sentry-Tarif.
Profile Sample Rate
Bereich:0-1
Varianten:
0: Profiling deaktiviert- niedriger Wert, beispielsweise
0.01: regelmäßige Performance-Diagnose
Empfehlung:
0oder ein sehr niedriger Wert in der Produktionsumgebung.
Enable Logs
Yes: sendet Structured LogsNo: keine Logs in Sentry
Wann aktivieren:
- wenn Sie Logs mit Traces und Fehlern korrelieren möchten.
Enable Metrics API
Yes: aktiviert die Modulfassade für MetrikenNo: modulbezogene Metriken sind nicht aktiv
Hinweis:
- Das aktuelle
sentry/sentry 4.24.xbehandelt Backend Metrics als auslaufende API beziehungsweise alsno-op.
Enable Cron Monitoring
Yes: sendet Check-ins und Cron-TransaktionenNo: Cron-Jobs werden nicht durch Sentry überwacht
Die Daten finden Sie in Sentry in den Bereichen:
CronsMonitors
Enable CLI Monitoring
Yes: überwacht Befehlebin/magentoNo: keine Überwachung von CLI-Prozessen
Hilfreich für:
- Importe,
- Neuindexierung,
- individuelle Integrationsbefehle.
Enable Adminhtml Monitoring
Yes: überwacht Requests des Admin-PanelsNo: beschränkt das Backend auf Storefront, API, Cron und CLI
Enable API Monitoring
Yes: überwacht REST, GraphQL und andere EndpointsNo: schließt den Integrationsbereich vom Monitoring aus
Bereich Frontend SDK
Betrifft das Browser SDK, das im Storefront und optional im Admin-Panel geladen wird.
Enable Frontend Monitoring
Yes: lädt das Browser SDKNo: das Frontend sendet keine Daten an Sentry
Frontend DSN
Varianten:
- ein eigenes Frontend-Projekt
- dieselbe DSN wie im Backend
- ein leeres Feld, damit das Modul einen Fallback versucht auf
Backend DSN
Empfehlung:
- langfristig ein eigenes Frontend-Projekt für übersichtliche Issues, Replay und Performance.
Enable Storefront JS
Yes: Browser SDK ist im Storefront aktivNo: kein SDK im öffentlichen Bereich des Shops
Enable Admin JS
Yes: Browser SDK ist auch im Admin-Panel aktivNo: JS-Monitoring ist auf den Storefront beschränkt
Empfehlung:
- nur aktivieren, wenn Sie tatsächlich JS-Probleme im Admin-Bereich diagnostizieren.
JS Trace Sample Rate
Bereich:0-1
Beispiele:
0.01: sehr vorsichtig0.05: guter Ausgangspunkt für die Produktionsumgebung0.1: mehr Daten und höheres Volumen
JS Replay Session Sample Rate
Bereich:0-1
Beispiele:
0: keine vollständigen Replays0.01: sicherer Ausgangspunkt0.05: mehr Daten für die Analyse von UX und Fehlern
JS Replay On Error Sample Rate
Bereich:0-1
Beispiele:
1: Replay nach jedem Fehler in der Sitzung0.5: Replay nach einem Teil der Fehler
Empfehlung:
- häufig ein besserer Ausgangspunkt als ein hohes Sampling sämtlicher Sitzungen.
Enable Session Replay
Yes: aktiviert ReplayNo: keine Sitzungsaufzeichnung
Empfehlung:
- nur zusammen mit einer umfassenden Maskierung von Checkout- und Zahlungsdaten aktivieren.
Enable User Feedback Widget
Yes: das Feedback-Widget ist verfügbarNo: das Widget wird nicht geladen
Hinweis:
- abhängig vom Sentry-Tarif und -Konto kann die Funktion als Beta oder Experimental gekennzeichnet sein.
Enable Checkout Instrumentation
Yes: fügt Checkout-Breadcrumbs und -Tags hinzuNo: kein zusätzlicher Checkout-Kontext
Empfehlung:
- normalerweise sollte diese Option aktiviert bleiben.
Enable Ajax Instrumentation
Yes: Breadcrumbs für AJAX / fetch / XHRNo: weniger Kontext für Frontend-Probleme
Browser SDK CDN URL
Verweist standardmäßig auf das offizielle Sentry-Bundle.
Varianten:
- Standard-URL des Moduls
- eigener CDN-Mirror
- festgelegtes Bundle oder eine bestimmte Version
Nur ändern, wenn:
- Sie die SDK-Version festschreiben,
- Sie eigene CSP-Regeln verwenden,
- Sie Assets spiegeln.
Bereich Privacy / Security
Dieser Bereich dient dazu, das Risiko der Übertragung vertraulicher Daten zu minimieren.
Send Default PII
Yes: das SDK kann den standardmäßigen Satz an Benutzer- und Request-Daten sendenNo: restriktivere Datenschutzrichtlinie
Empfehlung:
- normalerweise
No.
Anonymize IP
Yes: vollständige IP-Adresse nicht übertragenNo: Standardverhalten beibehalten
Empfehlung:
- normalerweise
Yes.
Mask Customer Data
Yes: maskiert KundendatenNo: geringerer Datenschutz
Empfehlung:
- in der Produktionsumgebung praktisch immer
Yes.
Mask Checkout Fields
Yes: maskiert Checkout-FelderNo: Risiko eines Datenlecks im Checkout
Empfehlung:
- immer
Yes.
Mask Payment Fields
Yes: maskiert zahlungsbezogene FelderNo: sehr riskant
Empfehlung:
- immer
Yes.
Block Authorization Headers
Yes: entfernt oder maskiertAuthorizationund TokensNo: Risiko der Übertragung von Authentifizierungsdaten
Empfehlung:
- immer
Yes.
Block Cookies
Yes: entfernt Cookies aus den EreignisdatenNo: höheres Risiko eines Lecks von Sitzungsdaten
Empfehlung:
- normalerweise
Yes.
Block POST Bodies
Yes: entfernt die Bodies vonPOSTNo: sendet mehr Request-Daten
Empfehlung:
- normalerweise
Yes, besonders bei Checkout, Anmeldung und Formularen.
Redact Query Params
Yes: maskiert Query-String-ParameterNo: der Query String bleibt besser lesbar, ist jedoch weniger sicher
Additional Redacted Keys
Textfeld für zusätzliche zu schwärzende Schlüssel.
Beispiele:
tokenapi_keycustomer_emailexternal_customer_id
Sie können die Werte trennen durch:
- Kommas,
- Leerzeichen,
- Zeilenumbrüche.
Replay Mask Selectors
CSS-Selektoren, deren Inhalt in Replay maskiert werden soll.
Beispiele:
.customer-email.field[name*="password"].payment-method
Replay Block Selectors
CSS-Selektoren, die in Replay vollständig blockiert werden sollen.
Beispiele:
.checkout-container.payment-method iframe.opc-wrapper
Allowed Domains for Replay Network Details
Liste der Domains, für die Replay Details zu Netzwerk-Requests hinzufügen darf.
Beispiele:
store.example.comapi.example.comtrusted-partner.example
Empfehlung:
- tragen Sie nur eigene und vertrauenswürdige Domains ein.
Bereich Filtering
Dieser Bereich reduziert Rauschen und Ereignisvolumen.
Ignore Exceptions Regex
Eine Regex-Regel pro Zeile.
Anwendungsbeispiele:
- bekannte, harmlose technische Fehler,
- Exceptions aus externen Integrationen, die bereits anderweitig behandelt werden.
Ignore URLs Regex
Eine Regex-Regel pro Zeile.
Beispiele:
- Health-Check-Endpoints,
- Test-Webhooks,
- technische Ressourcen.
Ignore Transactions
Ein Transaktionsname pro Zeile.
Empfehlung:
- zunächst Daten sammeln,
- anschließend wenig wertvolle und wiederkehrende Transaktionen herausfiltern.
Ignore Bots
Yes: schließt Bot- und Crawler-Traffic ausNo: überwacht auch automatisierten Traffic
Empfehlung:
Yesbei hohem SEO-Traffic.
Ignore Health Checks
Yes: überspringt/health,/status,/pingund ähnliche RequestsNo: solche Requests werden an Sentry übertragen
Ignore Admin Routes
Yes: reduziert Ereignisse aus dem Admin-BereichNo: der Admin-Bereich bleibt überwacht
Ignore Static Resource Errors
Yes: filtert einen Teil der Asset-Fehler.jsund.cssNo: alle Fehler dieses Typs bleiben sichtbar
Empfehlung:
- normalerweise
Yes, wenn Sie das Projekt nach Deployments nicht mit Störmeldungen füllen möchten.
Abschnitt Context
Steuert den Umfang des Geschäftskontexts in Events.
Attach Store Context
Yes: fügtstore_id,store_code, Shopname und Währung hinzuNo: kein entsprechender Kontext
Empfehlung:
Yes, insbesondere bei Multistore.
Attach Website Context
Yes: fügt Website-Daten hinzuNo: keine Identifikation auf dieser Ebene
Attach Customer Context
Yes: fügt anonymisierten Kundenkontext hinzuNo: keine Daten zum Kundenstatus
Attach Quote Context
Yes: fügt Warenkorb- oder Quote-Kontext hinzuNo: weniger Daten für die Checkout-Diagnose
Attach Cart Totals
Yes: fügt Warenkorbsummen hinzuNo: schlankeres Ereignis
Empfehlung:
- nur aktivieren, wenn diese Daten tatsächlich bei der Analyse helfen.
Attach Order Context
Yes: fügt Bestellkontext hinzuNo: keine Daten zum Order Flow
Besonders nützlich für:
- Invoice,
- Shipment,
- Transaktions-E-Mails,
- ERP- oder OMS-Integrationen.
Attach Product Context
Yes: fügt grundlegenden Produktkontext hinzuNo: kein entsprechender Kontext
Attach Category Context
Yes: fügt grundlegenden Kategoriekontext hinzuNo: kein entsprechender Kontext
Attach Payment / Shipping Method
Yes: fügtpayment_methodundshipping_methodNo: weniger Checkout-Daten
Empfehlung:
- ist eine besonders hilfreiche Diagnoseeinstellung.
Attach Module Version
Yes: fügt die Version hinzu vonKowal_SentryNo: ohne diese Information in Events
Attach Magento Version
Yes: fügt die Magento-Version hinzuNo: kein Plattformkontext
Attach Deployment Metadata
Yes: fügt zusätzliche Deployment-Daten hinzu, sofern verfügbarNo: keine entsprechenden Metadaten
Nützlich, wenn Sie ein Problem schnell mit einem Rollout oder einem bestimmten Build verknüpfen möchten.
Bereich Source Maps / Release
Dieser Bereich verwaltet die für Release und Source Maps benötigten Parameter. Der Upload selbst sollte in CI/CD und nicht während der Magento-Laufzeit erfolgen.
Enable Source Map Upload
Yes: bestätigt, dass Source Maps organisatorisch verwendet werdenNo: das Modul setzt keine Source Maps in der Konfiguration voraus
Hinweis:
- Dies ist ein Konfigurationsschalter und kein Upload-Mechanismus.
Source Map Upload Mode
Varianten:
manual: manuelle Befehlesentry-clici: Upload in der CI/CD-Pipelinedeploy_hook: Upload im Deployment-Hook
Empfehlung:
- im Produktivbetrieb meistens
ci.
Assets Base URL
Beispiel:
https://store.example.com/static/frontend
Dieser Wert muss dem entsprechen, was das Browser SDK im Stacktrace sieht. Andernfalls können die Source Maps nicht zugeordnet werden.
Release Dist
Optionalesdistfür das Release.
Beispiele:
storefrontadminpl-store
Verwenden Sie dies, wenn ein Release mehrere Asset-Varianten besitzt.
Organization
Organisations-Slug, der vonsentry-cliund API verwendet wird.
So finden Sie ihn:
- in der URL des Sentry-Panels,
- zum Beispiel
https://sentry.io/settings/acme/projects/shop-frontend/->acme
Project Slug
Projekt-Slug, der vom Release- und Source-Maps-Workflow verwendet wird.
So finden Sie ihn:
- in der Projekt-URL,
- oder
Settings -> Projects -> [projekt] -> Details
Release File Path
Pfad zur Datei mit dem Release-Namen bei der Strategiefile.
Beispiele:
/var/www/shared/release.txtpub/media/deploy/release-id.txt
Bereich User Feedback
Konfiguration des Widgets zur Meldung von Problemen im Browser.
Widget Theme
Varianten:
lightdarksystem
Empfehlung:
- normalerweise
system.
Widget Language
Beispiele:
pl-PLen-US
Empfehlung:
- bei Multistore an die Locale der Store View anpassen.
Auto-open after selected errors
Yes: nach ausgewählten Frontend-Fehlern kann eine Aufforderung zum Feedback angezeigt werdenNo: das Widget wird nicht automatisch geöffnet
Empfehlung:
- vorsichtig verwenden, um Nutzer nicht zu stark zu beeinträchtigen.
Show on checkout success
Yes: der Feedback-Trigger kann auf der Bestellbestätigungsseite erscheinenNo: kein Trigger an dieser Stelle
Show on contact page
Yes: Trigger oder Widget auf der KontaktseiteNo: keine Anzeige auf der Kontaktseite
Show in footer
Yes: dauerhaft sichtbarer Trigger im Footer oder als festes SeitenelementNo: kein dauerhafter Trigger
Dies ist die einfachste Option, wenn Sie eine SchaltflächeZglos problem.
Custom Trigger Selector
CSS-Selektor eines vorhandenen Elements, das Feedback öffnet.
Beispiele:
#report-issue.js-sentry-feedback
Verwenden Sie dieses Feld, wenn Sie das Widget mit einer eigenen Schaltfläche im Layout oder CMS-Block verknüpfen möchten.
Bereich Cron Monitoring
Dieser Bereich steuert Check-ins und Monitore für Magento-Cron-Jobs.
Enable auto-registration of configured cron jobs
Yes: der erste Check-in kann einen Monitor in Sentry erstellen oder aktualisierenNo: das Modul sendet Check-ins ohne automatische Monitorkonfiguration
Empfehlung:
Yes, wenn Sie ein kontrolliertes Deployment und bewusst definierte Jobs verwenden.
Monitored job codes
Liste der Magento-job_code-Werte.
Sie können die Werte trennen durch:
- Kommas,
- Leerzeichen,
- Zeilenumbrüche.
Varianten:
- leeres Feld: alle Cron-Jobs überwachen
- Liste ausgewählter
job_code-Werte: nur kritische Aufgaben überwachen
Beispiele:
sales_clean_quotescatalog_product_alertindexer_reindex_all_invalid
Timeout threshold per job
Eine Regel pro Zeile:
job_code:minutes
Beispiel:
catalog_product_alert:10
Verwenden Sie diese Einstellung, wenn ein Cron-Job unregelmäßig ausgeführt wird und Sie Fehlalarme reduzieren möchten.
Max runtime per job
Eine Regel pro Zeile:
job_code:minutes
Beispiel:
indexer_reindex_all_invalid:30
Nach Überschreiten des Grenzwerts kann Sentry den Monitor als problematisch markieren.
Check-in slug prefix
Beispiel:
magento-
Nützlich, wenn eine Sentry-Organisation mehrere Magento-Instanzen überwacht und Namenskollisionen vermieden werden sollen.
Empfohlene Konfigurationsprofile
Sicherer Einstieg in der Produktionsumgebung
Enable Module = YesEnable Backend Monitoring = YesEnable Frontend Monitoring = YesError Sample Rate = 1Trace Sample Rate = 0.05oder0.1JS Trace Sample Rate = 0.01oder0.05Enable Session Replay = YesJS Replay Session Sample Rate = 0.01JS Replay On Error Sample Rate = 1Send Default PII = NoAnonymize IP = YesMask Customer Data = YesMask Checkout Fields = YesMask Payment Fields = YesBlock Authorization Headers = YesBlock Cookies = YesBlock POST Bodies = YesRedact Query Params = YesIgnore Bots = YesIgnore Health Checks = Yes
Diagnoseprofil für Staging
- höhere
Trace Sample Ratefest, z. B.0.2 - höhere
JS Trace Sample Ratefest, z. B.0.1 - vorübergehend
Debug Mode = Yes Enable Test Commands = Yes- Replay vorsichtig verwenden: Maskierung und Blockierungen weiterhin beibehalten
Minimale Variante nur für das Backend
Enable Backend Monitoring = YesBackend DSNausgefülltEnable Frontend Monitoring = No
Dies ist ein guter erster Schritt, wenn Sie zunächst das Monitoring von Exceptions und Cron-Jobs auf der PHP-Seite aktivieren möchten.
Häufigste Konfigurationsfehler
- Einfügen des vollständigen Snippets
\Sentry\init(...)anstelle der DSN. - Gleichzeitiges Vorhandensein des Moduls unter
vendor/undapp/code/. - Unterschiedliche
release-Werte zwischen Ereignissen und Source Maps. - Zu aggressives Replay-Sampling in der Produktionsumgebung.
- Deaktivierung der Maskierung von Checkout- und Zahlungsdaten.
- Beispiel-DSN in der aktiven Konfiguration belassen.
Zusammenfassung
Am sichersten ist es, mit Backend-Monitoring, vorsichtigem Frontend-Monitoring und strengen Datenschutzeinstellungen zu beginnen. Sobald die Daten in Sentry stabil und übersichtlich sind, können Trace Sampling, Replay und der Umfang des Geschäftskontexts schrittweise erhöht werden.