PHP

Bibliothek für PHP-Anwendungen

Kostenlos in jedem Plan, auch im kostenlosen

Kostenlos starten Dokumentation

Woher nehmen

Auf Packagist ansehen

Packagist

Voraussetzungen PHP 8.2+ und Composer 2

Paketname dockcodes/dock-ray

Preise Kostenlos

Wozu es dient

Das offizielle DockRay PHP SDK ermöglicht die Integration jeder PHP-Anwendung mit der DockRay-Monitoring-Plattform. Es meldet automatisch unbehandelte Ausnahmen und PHP-Fehler und ermöglicht das Monitoring der Verarbeitungszeit von HTTP-Anfragen.

Monitoring von PHP-Fehlern und Ausnahmen

DockRay kann unbehandelte Ausnahmen und kritische Fehler automatisch erfassen und an das Monitoring-Dashboard übermitteln.

Gemeldete Ereignisse können unter anderem folgende Informationen enthalten:

Typ und Beschreibung des Fehlers oder der Ausnahme,
Ort des Auftretens und Stack Trace,
Informationen über die Umgebung und Anwendungsversion,
Tags, Benutzerdaten und zusätzlichen Kontext.

Das SDK ermöglicht außerdem die manuelle Meldung von Ausnahmen und Nachrichten sowie das Hinzufügen eigener Diagnoseinformationen mithilfe von Tags, Benutzerdaten und Breadcrumbs.

Performance-Monitoring

Das SDK ermöglicht das Monitoring von HTTP-Transaktionen und der Verarbeitungszeit von Anfragen. Die Häufigkeit der Datenerfassung kann über eine Sampling-Rate gesteuert werden.

Monitoring von JavaScript-Fehlern

Das DockRay PHP SDK stellt außerdem Werkzeuge für die Integration des JavaScript-Fehlermonitorings bereit. Ereignisse aus dem Browser werden über die PHP-Anwendung weitergeleitet, sodass der private Schlüssel des Projekts auf dem Server verbleibt.

Für Produktivanwendungen entwickelt

Standardmäßig werden Ereignisse während der Verarbeitung einer Anfrage in eine Warteschlange gestellt und nach der Vorbereitung der Antwort gesendet. Dadurch sollte eine vorübergehend nicht verfügbare oder langsamere Monitoring-Plattform die Antwort der Anwendung an den Benutzer nicht verzögern.

Framework-unabhängig

Das DockRay PHP SDK benötigt kein bestimmtes Framework und kann in jeder Anwendung mit PHP 8.2+ verwendet werden. Es bildet außerdem die Grundlage für die dedizierten DockRay-Integrationen für gängige Frameworks und CMS.

Installation

Installieren Sie das DockRay PHP SDK mit Composer:

bash

composer require dockcodes/dock-ray

Das Paket erfordert PHP 8.2 oder neuer.

Konfiguration

Initialisieren Sie DockRay beim Start Ihrer Anwendung und geben Sie den Projekt-Token und den privaten Schlüssel an:

php

use function Dock\Ray\init;

init([
    'token' => 'PROJECT_TOKEN',
    'private_key' => 'PROJECT_PRIVATE_KEY',
    'environment' => 'production',
    'release' => '1.4.0',
]);

Den Projekt-Token und den privaten Schlüssel finden Sie im DockRay-Dashboard. Die Zugangsdaten können alternativ auch über die Servervariablen RAY_TOKEN und RAY_PRIVATE_KEY übergeben werden.

Wenn der Projekt-Token oder der private Schlüssel nicht konfiguriert ist, bleibt das SDK inaktiv und sendet keine Daten.

So wird es verwendet

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

php

<?php

use function Dock\Ray\captureException;

try {
    $order->settle();
} catch (\Throwable $exception) {
    captureException($exception);

    throw $exception;
}