Entwicklung & Design

Sentry: Programmierfehler finden mit System

Seite 2 / 2

Sentry ins eigene Projekt integrieren: so geht’s

Um Sentry auszuprobieren, reicht die kostenfreie SaaS-Variante. Nach dem Anlegen eines neuen Projekts muss zunächst der Raven-PHP-Client von Github geladen werden, alternativ steht auch ein Composer-Package zur Verfügung. Mit dem Sentry-DSN wird eine Instanz von Raven erstellt:

<?php

# Bei der Installation via Composer entfällt dieser Teil
require_once '/path/to/raven/lib/Raven/Autoloader.php';
Raven_Autoloader::register();

# Der von Sentry vergebene DSNdefine('DSN', 'https://public:secret@app.getsentry.com/project-id');

# Initialisierung des Clients
$client = new Raven_Client(DSN, array(
 'logger' => 't3n',
 'tags' => array(
 'foo'=>'bar',    
 ),
));

Bei der Initialisierung des Clients können beliebige Tags sowie ein Name für den Logger angegeben werden. Sentry erstellt daraus automatisch Filter für das Web-Frontend. Um die eigentliche Nachricht zu erzeugen, genügt ein Einzeiler:

# Event loggen, die Daten aus dem Extra-Parameter werden direkt dem Event angehängt
$event_id = $client->captureMessage("Fehler: %s", array('Unbekannt'), array(
 'extra' => array(
 'key' => 'value',
 'lorem' => 'ipsum'
 ),
 'level' => 'info',
 ));

echo $event_id;

Neben der eigentlichen Nachricht werden von Raven weitere Details wie die HTTP-Header des Requests, GET- und POST-Parameter, das $_SERVER-Array sowie Informationen zum Client-OS und Browser gesendet. Optional besteht die Möglichkeit, verschiedene Fehler-Level wie Debug, Warning oder Fatal für jedes Event zu vergeben. Ebenfalls optional ist der Extra-Parameter, der in der neuesten Version des Clients hinzugekommen ist. Mit diesem lassen sich beliebige Key-/Value-Paare (Values können auch Arrays oder Objekte sein) als Zusatzinformation übergeben, die später übersichtlich formatiert im Kontext des Events angezeigt werden. Einen Hash, der all diese Informationen exakt in der Datenbank identifiziert, liefert Raven praktischerweise als Rückgabewert.

Beispiel der Detail-Ansicht einer Nachricht. Neben der Meldung selbst sind auch Unmengen an kontextbezogenen Informationen verfügbar.
Beispiel der Detail-Ansicht einer Nachricht. Neben der Meldung selbst sind auch Unmengen an kontextbezogenen Informationen verfügbar.

Darüber hinaus kennt Raven noch weitere „Convenience Methoden“. Der wichtigste Anwendungsfall ist das Loggen von Exceptions. Analog zu oben genanntem Beispiel kann mit Raven_Client::captureException($e) anstelle einer Nachricht auch ein Exception-Objekt übergeben werden. Intern nutzt Raven dazu ein anderes Nachrichten-Interface, das im Wesentlichen für die ordentliche Darstellung eines Stacktraces in den Logs sorgt. Auch die Verwendung im Rahmen des Standard-Error-Handlings von PHP ist bereits vorgesehen, der Client stellt entsprechende Methoden bereit.

Das Web-Frontend: Fehlermeldung in Echtzeit

Im Web-Frontend von Sentry laufen alle Nachrichten eines Projekts in Echtzeit zusammen und werden im so genannten „Stream“ dargestellt. Sendet eine Applikation mehrfach dasselbe Event, wird es aggregiert und an den Anfang verschoben. In Kombination mit der Häufigkeit und dem Fehlerlevel ergibt sich so eine Priorisierung für das anschließende Bug-Fixing praktisch von selbst. Neben den (konfigurierbaren) Default-Filtern von Sentry wie nach Host oder Client-Browser lässt sich der Stream auch nach den bei der Client-Instanzierung vergebenen Tags filtern. Sentry informiert außerdem bei einem erstmalig aufgetretenen Bug per Mail oder IM und kann automatisiert ein Ticket in Tools wie Jira eröffnen oder Web-Hooks ausführen.

In der Detail-Ansicht steht dann die volle Bandbreite an Kontext-Informationen zur Verfügung, zum Beispiel die Informationen aus dem extra-Parameter von Raven_Client::captureMessage() oder der Stacktrace einer Exception. Wurde der Auslöser einer Exception korrigiert, lässt sich der daraus resultierende Eintrag entsprechend markieren. Tritt dieselbe Exception erneut auf, wertet Sentry das als Regression-Bug und sendet eine entsprechende Benachrichtigung – so ist es fast unmöglich, aufgetretene Fehler zu übersehen.

Sentry informiert bei aufgetretenen Fehlern einen festgelegten Empfängerkreis per E-Mail oder IM.
Sentry informiert bei aufgetretenen Fehlern einen festgelegten Empfängerkreis per E-Mail oder IM.

Fazit: Zentrales Logging wichtig bei größeren Projekten

In der Praxis merkt man schnell, dass dank Sentry Probleme auffallen, von denen man nicht mal wusste, dass es diese überhaupt gibt. Bekommt zum Beispiel ein Redakteur beim Einpflegen eines Artikels eine Fehlermeldung, erhalten die Entwickler alle wesentlichen Informationen dazu – und zwar noch bevor der Redakteur selbst reagieren kann. Auf den ersten Blick „nur“ ein praktisches Tool für das zentralisierte Logging, können Tools wie Sentry mehr als eine wichtige Komponente bei fast allen größeren Projekten darstellen. Logging kann so nützlich sein, wenn man es richtig macht: mit Sentry.

Bitte beachte unsere Community-Richtlinien

Wir freuen uns über kontroverse Diskussionen, die gerne auch mal hitzig geführt werden dürfen. Beleidigende, grob anstößige, rassistische und strafrechtlich relevante Äußerungen und Beiträge tolerieren wir nicht. Bitte achte darauf, dass du keine Texte veröffentlichst, für die du keine ausdrückliche Erlaubnis des Urhebers hast. Ebenfalls nicht erlaubt ist der Missbrauch der Webangebote unter t3n.de als Werbeplattform. Die Nennung von Produktnamen, Herstellern, Dienstleistern und Websites ist nur dann zulässig, wenn damit nicht vorrangig der Zweck der Werbung verfolgt wird. Wir behalten uns vor, Beiträge, die diese Regeln verletzen, zu löschen und Accounts zeitweilig oder auf Dauer zu sperren.

Trotz all dieser notwendigen Regeln: Diskutiere kontrovers, sage anderen deine Meinung, trage mit weiterführenden Informationen zum Wissensaustausch bei, aber bleibe dabei fair und respektiere die Meinung anderer. Wir wünschen Dir viel Spaß mit den Webangeboten von t3n und freuen uns auf spannende Beiträge.

Dein t3n-Team

Ein Kommentar
nachtgold
nachtgold

Toller Tipp!

Antworten

Melde dich mit deinem t3n Account an oder fülle die unteren Felder aus.

Bitte schalte deinen Adblocker für t3n.de aus!

Hey du! Schön, dass du hier bist. 😊

Bitte schalte deinen Adblocker für t3n.de aus, um diesen Artikel zu lesen.

Wir sind ein unabhängiger Publisher mit einem Team bestehend aus 65 fantastischen Menschen, aber ohne riesigen Konzern im Rücken. Banner und ähnliche Werbemittel sind für unsere Finanzierung sehr wichtig.

Danke für deine Unterstützung.

Digitales High Five,
Stephan Dörner (Chefredakteur t3n.de) & das gesamte t3n-Team

Anleitung zur Deaktivierung