Shopware Debugging
Shopware Debugging ist ein leidiges Thema. Aber jeder ist irgendwann einmal an dem Punkt wo er einen Fehler findet und am liebsten gleich selber beheben möchte. Bei einigen Fehlern geht es schnell, bei anderen dauert es wiederum länger.
Hier ist eine mögliche Route um mögliche Fehler zu beheben. Man kann sich von Punkt 1 runterarbeiten oder seinen Lieblingspunkt heraussuchen.
Shopware Debugging Übersicht
- 1. Cache löschen
- 2. Systeminfo prüfen
- 3. System-Log prüfen
- 4. Das Debug Plugin
- 5. Der Frosh Profiler
- 6. Weiterführende Links und Quellen
1. Cache löschen
Debugging beginnt im Normalfalls bei Shopware immer erst einmal mit dem Löschen des Cache. Gerade Shopware Einsteiger oder Leute die nur mit großen zeitlichen Abständen an ihren Shops arbeiten vergessen diese „Kleinigkeit“ oft.
1.1 Den „kleinen“ Cache löschen
Der von mir klein getaufte Cache ist direkt über die Backend-Navigation erreichbar … Noch einfacher geht es mit Strg + Alt + X.
1.2 Den großen Cache löschen
Der große Cache versteckt sich gleich unter dem oben beschriebenen roten Button … klickt anschließend auf den blauen Button genehmigen.
1.3 Den Backend Cache per FTP löschen
https://netgrade.de/shopware-5-wie-kann-ich-den-cache-manuell-leeren/
2. Systeminfo prüfen
Als Erstes macht es grundsätzlich Sinn einen Blick in die Systeminfos zu werfen. Manchmal kann einem hier schon etwas ins Auge springen und den Weg zur Problemlösung weisen.
Wir gehen hierfür in den Menüpunkt Einstellungen > Systeminfo. Angekommen in der Systeminfo-Übersicht klicken wir uns durch alle Reiter.
2.1 Systeminfo – Server-Konfiguration
Hier sollten keine Fehler oder Warnmeldungen vorkommen. In diesem Beispiel sehen wir z.B. dass das die maximale Dateigröße für Uploads lediglich 2 MB sind. Benötigt werden jedoch 6 MB – das kann also schonmal zu Fehlern führen. Falls du also ein Problem beim Upload von Dateien in deine Mediathek hattest, könnte das schon der richtige Wink mit dem Zaunpfahl sein.
Wenn der Fehler, so wie bei mir geschehen, auf der lokalen MAMP Installation vorgefunden wird ist das einfach zu beheben. Zunächst einmal müssen wir wissen welche PHP Version für den Shop verwendet wird. Klicken wir auf den PHP-Inforeiter erhalten wir genau diese Info. Dafür muss man auch nicht lange suchen, sondern es quasi schon die Überschrift in diesem Bereich.
Wie man groß und deutlich sieht, handelt es sich um die Version 7.4.2 – um diese zu bearbeiten, bewegen wir uns zunächst im MAMP Ordner in den Unterordner: php > php7.4.2 > conf.
Nun öffnen wir als Nächstes die php.ini Datei im Editor unserer Wahl und suchen in der Datei nach dem memory_limit Eintrag und vervierfachen den Wert am besten gleich mal auf 512. Der sollte dann so aussehen: 512M (ohne Semikolon am Ende). Wer nicht die richtige php.ini Datei findet kann auch wieder unter dem PHP-Info Tab in der Zeile Loaded Configuration File ganz genau nachschauen welche Datei zu bearbeiten ist bzw. wo man „seine“ php.ini Datei findet. Hier sieht man die Zeile an letzter Stelle im Screenshot.
Ein zu geringer Wert beim memory_limit kann z.B. dazu führen, dass der Thememanager nicht korrekt funktioniert.
Nach der Anpassung in der Datei müssen wir jedoch auch noch einmal den MAMP Server neu starten. Erst dann sind die Änderungen im System und der Fehler im Tab Server-Konfiguration wird nicht mehr angezeigt.
2.2 Systeminfo – Shopware-Verzeichnisse
Nun sollte ein Blick in die Inhalte unter dem Shopware-Verzeichnisse Ordner geworfen werden. Auch hier sollte definitiv jeder Eintrag mit dem grünen Häkchen versehen sein. Ist dies nicht der Fall, wird man eine Warnmeldung angezeigt bekommen. Ist dies der Fall, ist der Ordner entweder gar nicht vorhanden oder aber es gibt einen Fehler bei den Zugriffsrechten. Beide Fehler sollten sofort behoben werden.
2.3 Systeminfo – Shopware-Dateien
Unter dem Shopware-Dateien-Ordner sieht es ziemlich genau so aus wie beim Shopware-Verzeichnisse Ordner mit dem Unterschied, dass es logischerweise viel mehr Einträge sind. Noch ein Unterschied ist, dass es hier pro Eintrag 2 grüne Haken gibt, jeweils die Verfügbarkeit und den Status der Datei prüfen. Genau wie bei den Shopware-Verzeichnissen ist darauf achtzugeben, dass alle Einträge fehlerfrei sind.
2.4 Systeminfo – Versions-Info
Im Reiter Versions-Info erhalten wir Informationen zu unterschiedlichen Dingen. An erster Stelle haben wir beispielsweise die Versions-Info zur verwendeten Shopware Installation. Ganz unten erkennen wir wiederum Versions-Informationen zu den installierten Plugins.
Wenn man einmal selber den Fehler nicht findet und sich mit seinem Anliegen an das Shopware Forum wendet, dann macht es definitiv Sinn entsprechende Infos zu den verwendeten Versionen der Shop-Version abzuliefern. Das erleichtert den anderen Foren Mitgliedern dann das Problem bestenfalls aus der Ferne zu beheben.
2.5 Systeminfo – Media Optimizer
Unter diesem Reiter kann es grundsätzlich schon einmal so aussehen, ohne dass man sich großartig Sorgen um die Funktionalität seines Shops machen müsste:
Hier geht es einfach darum welche Bildkompressions-Funktionen der Server mit bringt. Auf meiner lokalen Installation sieht es da also ziemlich düster aus. Auf Live Umgebungen sollte man aufgrund der besseren Performance sprich den einhergehenden schnelleren Ladezeiten bestenfalls alles grün haben. Aber das hat dann nichts mehr mit Debugging sondern eher SEO zu tun.
2.6 Systeminfo – PHP-Info
Im PHP-Info Bereich wird man zwar keine Fehler angezeigt bekommen, sehr wohl aber evtl. nützliche Informationen angezeigt bekommen. Diese können dann den Ursprung eines bestimmten Fehlers herleiten. Wird für ein bestimmtes Plugin beispielsweise zwingend Shopware 7.4 benötigt aber der Server läuft mit Shopware 7.3, dann weiß man wie der Hase läuft und kann bestenfalls mit einem Paar 7-Meilen Stiefeln schnell hinterher laufen und noch ein Hühnchen mit ihm rupfen. Einige der wichtigsten Infos aus diesem Bereich werden zudem auch schon unter dem Server-Konfiguration Reiter angezeigt.
3. System-Log prüfen
Der System-Log Bereich ist ein sehr interessanter Bereich um einen genauer definierten Fehler angezeigt zu bekommen. Man erreicht ihn in der Backend Navigation über den Link Einstellungen > Logfile. Hier muss man dann noch den Reiter System-Log auswählen. Bevor jedoch irgendwelche Fehler ausgegeben werden können muss man noch vorher in das Dropdown-Menü klicken um dann den Eintrag zu dem jeweiligen Tag auszuwählen.
Wird das Datum des heutigen / aktuellen Tages nicht angezeigt kann ein Klick auf den blauen Aktualisieren Button helfen. Kommt immer noch nichts heißt es dass für diesen Tag keine Fehler protokolliert wurden.
Im Reiter daneben findet man die Admin Logs. Wenn also etwas kaputt gegangen ist, kann man hier evtl. rausfinden wer zu der Zeit kurz bevor der Fehler das aufgetreten ist eingeloggt war und wahrscheinlich auch den Fehler verursacht hat. Zusätzlich wird hier auch ebenfalls festgehalten was der User alles gemacht war als er sich durch das System geklickt hat.
4. Das Debug Plugin
Das Debug Plugin ist bei jeder Shopware Installation schon in der Plugin-Liste vorinstalliert. Befindet sich jedoch in der Liste deinstalliert. Das mag verwirrend klingen, ist es aber auch. Um das Plugin einsatzbereit zu machen klicken wir einmal auf den grünen Button und klicken anschlißend in dem sich öffnenden Plugin noch auf den blauen Aktivieren Button.
Soll das Plugin auf einer Live-Umgebung zum Einsatz kommen empfiehlt es sich noch in das oberste Feld im Formular seine IP-Adresse einzugeben. Diese kann man beispielsweise über einen kostenlos Dienst wie https://wieistmeineip.de herausfinden. Achtet jedoch bei der IP Adresse darauf, dass die Buchstaben als Kleinbuchstaben eingegeben werden müssen.
Damit beschränkt man die Funktion also nur auf seine IP Adresse und alle anderen Shop-Besucher kriegen nichts davon mit. Das hat den Vorteil, dass weniger Skripte geladen werden und die Ladezeit der Live-Umgebung somit auch nicht verlangsamt wird.
Durch Aktivierung des Shopware Debug Plugins hat man Einsicht in die aufgerufenen Template Anweisungen. Diese lassen sich nun in unter dem Console Reiter des Developer Tools einsehen. Nach der Aktivierung muss die Seite einmal neu geladen werden. Diese spezielle Funktion haben wir in der Praxis selten bis nie verwendet. Auch als wir es einmal getestet haben konnten wir im besagten Console Bereich keinen zusätzlichen infos vorfinden.
5. Der Frosh Profiler
Frosh ist die Abkürzung für Friends of Shopware. Diese Freunde von Shopware sind ambitionierte Entwickler die einen großen Beitrag für die Shopware Community leisten. Sie entwickeln unterschiedliche nützliche Plugins – wer mehr über die Frosh erfahren möchte, kann die Webseite unter https://friendsofshopware.com/ besuchen.
Wer schon etwas länger mit Shopware arbeitet, kennt eventuell auch noch den Shyim Profiler, benannt nach dem Entwickler, bzw. dessen Foren-Namen.
5.1 Was kann der Frosh Profiler?
Was macht nun dieser Frosh Profiler? Kurz gesagt kann man damit zusätzliche Informationen ausgeben lassen, die einem bei der Fehlerbehebung behilflich sein können. Besonders praktisch ist beispielsweise die Ausgabe aller in Verwendung befindlicher Smarty Variablen oder aufgetreten Events auf einer Seite.
Am besten probiert ihr es einfach einmal aus.
5.2 Wo finde ich das Plugin?
Das Plugin bekommt ihr hier: https://github.com/FriendsOfShopware/FroshProfiler
Dort findet ihr dann den Link zur aktuellen Zip-Datei. Aktuell sind wir bei Version 1.4.4, die auch kompatibel ist mit Shopware 5.7:
https://github.com/FriendsOfShopware/FroshProfiler/releases
Einfacher geht es natürlich auch über den Shopware Store oder am allereinfachsten über euer Shopware 5 Backend. Es führen also alle Wege nach Rom. Über diesen Link erhaltet ihr es im Store: https://store.shopware.com/frosh14879865239f/profiler.html
5.3 Plugin Einstellungen
Ist das Plugin installiert, könnt ihr im Plugin-Manager einige Einstellungen vornehmen:
Im Grunde kann man in erster Instanz alle Einstellungen so bei belassen.
5.4 Ansicht der Developer Toolbar
Haben wir das Plugin korrekt installiert, sehen wir im Frontend eine zusätzliche Toolbar in unserem Shop.
Wie man sieht, gibt es verschiedene Buttons / Reuter in der Toolbar. Fährt man mit dem Mauszeiger darüber, erhält man zusätzliche Informationen. Für Theme und Plugin-Entwickler besonders interessant: Der Button Template.
Zusätzlich kann man in einem neuen Tab mit einem Klick auf den Button noch detaillierte Informationen aufrufen.
Natürlich ist dieser Bereich nur nützlich, wenn man sich auch ein Stück weit mit der Materie auskennt. Für angehende Plugin und Theme Entwickler und Bug-Fighter ist dieses Plugin aber definitiv ein Must-Have.
