Laravel

Paket für Laravel 10+

Kostenlos in jedem Plan, auch im kostenlosen

Kostenlos starten Dokumentation

Woher nehmen

Auf Packagist ansehen

Packagist

Voraussetzungen Laravel 10+, PHP 8.2+

Paketname dockcodes/dock-ray-laravel

Preise Kostenlos

Wozu es dient

Das offizielle DockRay-Paket integriert Laravel-Anwendungen mit der Monitoring-Plattform und ermöglicht die automatische Meldung von Ausnahmen sowie das Performance-Monitoring von HTTP-Anfragen. Ereignisse werden zusammen mit den für eine schnelle Problemdiagnose erforderlichen Informationen direkt an das DockRay-Dashboard übermittelt.

Monitoring von Fehlern und Ausnahmen

DockRay integriert sich in das Exception-Reporting-System von Laravel und übermittelt Anwendungsfehler automatisch an ein zentrales Monitoring-Dashboard.

Gemeldete Ereignisse können unter anderem folgende Informationen enthalten:

Typ und Beschreibung der Ausnahme,
Ort des Auftretens und Stack Trace,
Informationen über die Umgebung und Anwendungsversion,
Kontext der verarbeiteten Anfrage.

Ausgewählte Exception-Klassen können von der Meldung ausgeschlossen werden. DockRay berücksichtigt außerdem die standardmäßige dontReport-Konfiguration von Laravel.

Performance-Monitoring

Das Paket kann die Verarbeitungszeit von HTTP-Anfragen für ausgewählte Middleware-Gruppen wie web und api überwachen. Transaktionen werden anhand des Routenmusters gruppiert, sodass Anfragen an dieselbe Route unabhängig von den in der URL übergebenen IDs gemeinsam analysiert werden können.

Die Häufigkeit der Erfassung von Transaktionsdaten kann über eine Sampling-Rate gesteuert werden.

Benutzerkontext und Datenschutz

DockRay kann optional Informationen über den angemeldeten Benutzer in gemeldete Ereignisse aufnehmen, beispielsweise ID, E-Mail-Adresse und Name. Die Übermittlung der IP-Adresse und des User-Agents wird über eine separate Einstellung gesteuert und muss standardmäßig nicht aktiviert sein.

Queues und Artisan-Befehle

Fehler, die in Queues und Konsolenprozessen auftreten, können ebenfalls an DockRay gemeldet werden. Da diese außerhalb des HTTP-Middleware-Stacks ausgeführt werden, erzeugen sie keine Performance-Transaktionen.

Sichere Fehlerübermittlung

Die Reporting-Methoden von DockRay lösen keine Ausnahmen aus. Dadurch beeinträchtigen vorübergehende Ausfälle der Monitoring-Plattform nicht die standardmäßige Fehlerbehandlung Ihrer Anwendung.

Installation

Installation des Pakets

Installieren Sie DockRay mit Composer:

bash

composer require dockcodes/dock-ray-laravel

Veröffentlichen Sie anschließend die Konfigurationsdatei:

bash

php artisan vendor:publish --tag=ray-config

Der Service Provider wird von Laravel automatisch erkannt und muss nicht manuell registriert werden.

Konfiguration

Fügen Sie die DockRay-Projektdaten zur Datei .env hinzu:

RAY_TOKEN=project-token
RAY_PRIVATE_KEY=project-private-key
RAY_TRACES_SAMPLE_RATE=0.2

Den Projekt-Token und den privaten Schlüssel finden Sie im DockRay-Dashboard. Wenn RAY_TOKEN und RAY_PRIVATE_KEY nicht gesetzt sind, bleibt das Paket inaktiv und sendet keine Daten.

Die übrigen Einstellungen der Integration befinden sich in der Datei config/ray.php.

So wird es verwendet

Ausnahmen meldet die Integration von selbst. Das hier ist für Meldungen, die Sie bewusst senden.

php

<?php

use Dock\Ray\Laravel\Ray;
use Illuminate\Foundation\Configuration\Exceptions;

->withExceptions(function (Exceptions $exceptions) {
    $exceptions->reportable( fn (Throwable $exception) => Ray::report($exception) );
})