Magento

Modul für Magento 2.4 und Adobe Commerce

Kostenlos in jedem Plan, auch im kostenlosen

Kostenlos starten Dokumentation

Woher nehmen

Auf Packagist ansehen

Packagist

Voraussetzungen Magento Open Source oder Adobe Commerce 2.4.4+, Mage-OS, PHP 8.1+

Paketname dockcodes/dock-ray-magento

Preise Kostenlos

Wozu es dient

Das offizielle DockRay-Modul für Magento 2 integriert Ihren Shop in die Fehlerüberwachungsplattform DockRay und meldet automatisch PHP-Ausnahmen sowie von Magento protokollierte Fehler. Meldungen aus Controllern, REST- und GraphQL-APIs, Zahlungs- und Versandintegrationen sowie Cron-Jobs werden direkt an Ihr DockRay-Dashboard übermittelt und erleichtern die Diagnose von Problemen in Magento Open Source und Adobe Commerce.

Überwachung von PHP-Fehlern und Ausnahmen

DockRay erfasst Informationen über Fehler, die während des Shopbetriebs auftreten, darunter Ausnahmen, die von den Fehlerbehandlungsmechanismen von Magento erfasst werden, sowie Ereignisse, die als Fehler in den Logs protokolliert werden. So können Sie Probleme mit der Anwendung, externen Integrationen und Hintergrundprozessen schneller erkennen.

Überwachung der Performance und von JavaScript-Fehlern

Die optionale Überwachung der Antwortzeiten von Magento-Routen hilft dabei, langsam ausgeführte Bereiche der Anwendung zu identifizieren. Die Messwerte werden den Routennamen und nicht den konkreten Produkt-URLs zugeordnet. Dadurch lässt sich die Performance analysieren, ohne die Ergebnisse auf zahlreiche ähnliche URLs aufzuteilen.

Das Modul kann außerdem JavaScript-Fehler erfassen, die im Storefront auftreten. Der Mechanismus funktioniert auch bei aktiviertem Seiten-Cache. So können Sie Probleme auf Browserseite überwachen, ohne auf Performance-Optimierungen Ihres Shops verzichten zu müssen.

Erkennung bekannter Sicherheitslücken in Magento

DockRay analysiert Informationen über die Software Ihres Shops, darunter die Magento-Version, Composer-Pakete und Erweiterungen im Verzeichnis app/code, auf bekannte Sicherheitslücken. Die Ergebnisse sind im DockRay-Dashboard verfügbar und helfen dabei, Komponenten zu identifizieren, die möglicherweise aktualisiert oder einer zusätzlichen Sicherheitsprüfung unterzogen werden müssen.

Einfache Konfiguration und sichere Speicherung von Schlüsseln

Die Verbindung konfigurieren Sie unter Stores → Configuration → DockRay → Monitoring, indem Sie Ihr Projekttoken und Ihren privaten Schlüssel eingeben. Um Zugangsdaten nicht in der Magento-Datenbank speichern zu müssen, können Sie den privaten Schlüssel in der Datei app/etc/env.php hinterlegen oder über eine Umgebungsvariable bereitstellen.

DockRay für Magento hilft Ihnen, Anwendungsfehler zu überwachen, die Performance von Routen zu analysieren und bekannte Sicherheitslücken in Erweiterungen zentral über ein Dashboard zu erkennen, ohne sämtliche Shop-Logs manuell durchsuchen zu müssen.

Installation

Voraussetzungen

Das DockRay-Modul ist für Magento Open Source und Adobe Commerce ab Version 2.4.4 sowie für Mage-OS vorgesehen. Es erfordert PHP in Version 8.1 oder höher.

Installation über Composer

Installieren Sie das DockRay-Modul mit Composer im Stammverzeichnis Ihres Magento-Projekts:

bash

composer require dockcodes/dock-ray-magento
bin/magento module:enable DockCodes_DockRay
bin/magento setup:upgrade

# In der Produktionsumgebung zusätzlich ausführen:

bin/magento setup:di:compile
bin/magento setup:static-content:deploy

Verbindung mit DockRay konfigurieren

Navigieren Sie im Magento-Adminbereich zu Stores → Configuration → DockRay → Monitoring. Geben Sie Ihr Projekttoken und Ihren privaten Schlüssel aus dem DockRay-Dashboard ein und speichern Sie die Konfiguration.

Wenn Sie den privaten Schlüssel nicht in der Magento-Datenbank speichern möchten, können Sie die Zugangsdaten über CLI-Befehle festlegen:

bash

bin/magento config:set --lock-env dockray/connection/token IHR_PROJEKTTOKEN
bin/magento config:set --lock-env dockray/connection/private_key IHR_PRIVATER_SCHLUESSEL

Die Option --lock-env speichert die Konfiguration im Bereich der Umgebung. Auf diese Weise gesetzte Werte sind im Adminbereich gesperrt und werden aus der Umgebungskonfiguration übernommen.

Privaten Schlüssel außerhalb der Datenbank speichern

Sie können den privaten Schlüssel in der Datei app/etc/env.php speichern oder über eine Umgebungsvariable bereitstellen:

php

'dockray' => [
    'connection' => [
        'private_key' => 'IHR_PRIVATER_SCHLUESSEL',
    ],
],

Alternativ können Sie die Umgebungsvariable CONFIG__DEFAULT__DOCKRAY__CONNECTION__PRIVATE_KEY verwenden. Wenn Geheimnisse nicht in der Datenbank gespeichert werden, lässt sich der Zugriff auf Zugangsdaten besser kontrollieren.

Installation überprüfen

Senden Sie nach dem Speichern der Konfiguration ein Testereignis, um die Verbindung zu Ihrem DockRay-Projekt zu überprüfen. Führen Sie dazu im Terminal folgenden Befehl aus:

bash

bin/magento dockray:test

Öffnen Sie anschließend Ihr DockRay-Projekt und prüfen Sie, ob das neue Ereignis eingegangen ist. Berichte über bekannte Sicherheitslücken werden regelmäßig über Magento Cron übermittelt. Sie können den Versand auch manuell auslösen:

bash

bin/magento dockray:inventory:send

So wird es verwendet

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

php

<?php

use DockCodes\DockRay\Model\Reporter;

class SyncStock
{
    public function __construct(
        private Reporter $dockray
    ) {}

    public function execute(): void
    {
        try {
            $this->erp->pushStock();
        } catch (\Throwable $e) {
            $this->dockray->captureException($e);
        } 
    } 
}