Zuerst Lesen! Bug-Report- und Fragen-Howto

Gesperrt
CLAdmin
Administrator
Beiträge: 40
Registriert: Di 26. Nov 2013, 16:23
Kontaktdaten:

Zuerst Lesen! Bug-Report- und Fragen-Howto

Beitrag von CLAdmin »

Liebe Community,

um euch, wie auch uns, die Arbeit ein wenig zu erleichtern möchten wir euch bitten dieses Bug-Report Howto als Grundlage für eure Bug-Meldungen zu nehmen. Sinngemäß (bis auf die Betreffzeile, die aber dennoch einen aussagekräftigen Titel haben soll!) gilt das auch für Fragen bei Problembeschreibungen, was die benötigten Informationen angeht.

Damit wir gleich auf Anhieb wissen, dass es sich um einen Bug handelt und welche Version betroffen ist für den Betreff:
[BUG 2.0.0] kurzer aussagekräftiger Titel
Sobald wir den Bug bestätigt haben, wird der Thread dann in unser Bug-Forum verschoben. Im anderen Fall entfernen wir den Bug-Hinweis im Titel.

Im Inhaltsbereich möchten wir euch dann um folgende Infos bitten, welche man per Copy & Paste im ConLite Backend entnehmen kann.
(Hier mal ein Beispiel aus einer meiner Demoinstallationen)

Server Betriebssystem Apache/2.4.7 (Ubuntu)
PHP Datenbankerweiterung mysql
Datenbankserver-Version 5.5.44-MariaDB-1ubuntu0.14.04.1
Installierte PHP-Version 5.5.9-1ubuntu4.9
safe_mode Deaktiviert
magic_quotes_gpc Deaktiviert
magic_quotes_runtime Deaktiviert
gpc_order
memory_limit 128M
max_execution_time 60
Deaktivierte Funktionen pcntl_alarm, pcntl_fork, pcntl_waitpid, pcntl_wait, pcntl_wifexited, pcntl_wifstopped, pcntl_wifsignaled, pcntl_wexitstatus, pcntl_wtermsig, pcntl_wstopsig, pcntl_signal, pcntl_signal_dispatch, pcntl_get_last_error, pcntl_strerror, pcntl_sigprocmask, pcntl_sigwaitinfo, pcntl_sigtimedwait, pcntl_exec, pcntl_getpriority, pcntl_setpriority,
Gettext Erweiterung geladen
sql.safe_mode Deaktiviert


Nun fehlt nur noch der Inhalt eines eventuell vorhandenen ErrorLogs, bei dem ihr bitte alle Teile die auf euch, bzw. euren Server schließen lassen, z.B. Pfade bzw. Domainnamen, durch XXX unkenntlich macht. Hier mal ein Beispiel, bei dem zusätzlich der PHP-Debugger aktiv ist, was eine Nachverfolgung (Trace) des Ablaufs in PHP ermöglicht.

Code: Alles auswählen

[22-Jun-2015 12:19:18 UTC] PHP Strict standards:  Declaration of PropertyItem::setField() should be compatible with Item::setField($sField, $mValue, $bSafe = true) in /srv/www/htdocs/ConLite/conlite/classes/class.properties.php on line 0
[22-Jun-2015 12:19:18 UTC] PHP Stack trace:
[22-Jun-2015 12:19:18 UTC] PHP   1. {main}() /srv/www/htdocs/ConLite/conlite/index.php:0
[22-Jun-2015 12:19:18 UTC] PHP   2. page_open() /srv/www/htdocs/ConLite/conlite/index.php:45
[22-Jun-2015 12:19:18 UTC] PHP   3. Auth->start() /srv/www/htdocs/ConLite/conlib/page.inc:51
[22-Jun-2015 12:19:18 UTC] PHP   4. Contenido_Challenge_Crypt_Auth->auth_loginform() /srv/www/htdocs/ConLite/conlib/auth.inc:143
[22-Jun-2015 12:19:18 UTC] PHP   5. include() /srv/www/htdocs/ConLite/conlib/local.php:545
[22-Jun-2015 12:19:18 UTC] PHP   6. RequestPassword->renderForm() /srv/www/htdocs/ConLite/conlite/main.loginform.php:194
[22-Jun-2015 12:19:18 UTC] PHP   7. cHTMLTextbox->__construct() /srv/www/htdocs/ConLite/conlite/classes/class.request.password.php:239
[22-Jun-2015 12:19:18 UTC] PHP   8. cHTMLFormElement->__construct() /srv/www/htdocs/ConLite/conlite/classes/class.htmlelements.php:728
[22-Jun-2015 12:19:18 UTC] PHP   9. cHTML->__construct() /srv/www/htdocs/ConLite/conlite/classes/class.htmlelements.php:503
[22-Jun-2015 12:19:18 UTC] PHP  10. getEffectiveSetting() /srv/www/htdocs/ConLite/conlite/classes/class.htmlelements.php:129
[22-Jun-2015 12:19:18 UTC] PHP  11. cApiClientLanguage->getProperty() /srv/www/htdocs/ConLite/conlite/includes/functions.general.php:951
[22-Jun-2015 12:19:18 UTC] PHP  12. cApiClientLanguage->_getPropertiesCollectionInstance() /srv/www/htdocs/ConLite/conlite/classes/contenido/class.clientslang.php:140
[22-Jun-2015 12:19:18 UTC] PHP  13. spl_autoload_call() /srv/www/htdocs/ConLite/conlite/classes/contenido/class.clientslang.php:208
[22-Jun-2015 12:19:18 UTC] PHP  14. cAutoload::autoload() /srv/www/htdocs/ConLite/conlite/classes/contenido/class.clientslang.php:208
[22-Jun-2015 12:19:18 UTC] PHP  15. cAutoload::_loadFile() /srv/www/htdocs/ConLite/conlite/classes/class.autoload.php:190
[22-Jun-2015 12:19:18 UTC] PHP Notice:  Undefined property: cApiSystemPropertyCollection::$_bDebug in /srv/www/htdocs/ConLite/conlite/classes/cApi/class.system_property.php on line 41
[22-Jun-2015 12:19:18 UTC] PHP Stack trace:
[22-Jun-2015 12:19:18 UTC] PHP   1. {main}() /srv/www/htdocs/ConLite/conlite/index.php:0
[22-Jun-2015 12:19:18 UTC] PHP   2. page_open() /srv/www/htdocs/ConLite/conlite/index.php:45
[22-Jun-2015 12:19:18 UTC] PHP   3. Auth->start() /srv/www/htdocs/ConLite/conlib/page.inc:51
[22-Jun-2015 12:19:18 UTC] PHP   4. Contenido_Challenge_Crypt_Auth->auth_loginform() /srv/www/htdocs/ConLite/conlib/auth.inc:143
[22-Jun-2015 12:19:18 UTC] PHP   5. include() /srv/www/htdocs/ConLite/conlib/local.php:545
[22-Jun-2015 12:19:18 UTC] PHP   6. RequestPassword->renderForm() /srv/www/htdocs/ConLite/conlite/main.loginform.php:194
[22-Jun-2015 12:19:18 UTC] PHP   7. cHTMLTextbox->__construct() /srv/www/htdocs/ConLite/conlite/classes/class.request.password.php:239
[22-Jun-2015 12:19:18 UTC] PHP   8. cHTMLFormElement->__construct() /srv/www/htdocs/ConLite/conlite/classes/class.htmlelements.php:728
[22-Jun-2015 12:19:18 UTC] PHP   9. cHTML->__construct() /srv/www/htdocs/ConLite/conlite/classes/class.htmlelements.php:503
[22-Jun-2015 12:19:18 UTC] PHP  10. getEffectiveSetting() /srv/www/htdocs/ConLite/conlite/classes/class.htmlelements.php:129
[22-Jun-2015 12:19:18 UTC] PHP  11. getSystemProperty() /srv/www/htdocs/ConLite/conlite/includes/functions.general.php:962
[22-Jun-2015 12:19:18 UTC] PHP  12. cApiSystemPropertyCollection->__construct() /srv/www/htdocs/ConLite/conlite/includes/functions.general.php:879
Screenshots, Links und Zugänge

Sehr hilfreich sind in manchen Fällen Screenshot, evtl. mit Markierungen der betroffenen Bereiche. Solltet ihr euch also nicht sicher sein ob ihr den Fehler ausreichend erklären konntet, so macht einen Screenshot davon und hängt ihn als Datei an, wobei ihr folgende Punkte beachten solltet.
  • entfernt alle persönlichen oder copyright-relevanten Inhalte, bzw. macht sie unkenntlich.
  • Optimiert eure Bilddatei in der Größe, ein Screenshot mit 1, 2 oder mehr MB ist nicht nur schlecht zu händeln sondern definitiv zu groß. Maximal 150-200 kB sollten hier ausreichen
  • Ladet euren Screenshot lieber im Forum als Anhang hoch, bevor ihr ihn von Fremdservern oder Bilderdiensten verlinkt. Viele Posts im Forum ergeben sonst irgendwann wegen fehlender Bilder kaum noch Sinn, wenn nicht sogar gar keinen Sinn.
Auch Links zu eurem Frontend und/oder Backend machen, wenn möglich, Sinn und sind hilfreich um Fehler aufzuzeigen.

:!: Doch eine Bitte von uns:
Stellt keine Links zu PHP-Info-Dateien oder schreibt keine Zugangsdaten zu Backends öffentlich in eure Postings. Sollten wir solche Daten benötigen so fragen wir sie an. Ein Austausch sollte nur per persönlicher PN oder auf anderen direkten Wegen (E-Mail, Skype, etc) erfolgen. Das gilt entsprechend auch für den folgenden Punkt.

Server- und PHP-Logs

Ergänzend können diese Logdateien interessant sein, zumal wenn im ConLite Errorlog keine Einträge zu finden sind. Doch auch hier gilt der Datenschutz als ein wichtiges Kriterium.
Daher, wenn ihr solche Logs nutzen wollt und könnt, macht alle Datenschutz-relevanten Daten, wie z.B. IP-Adresse in Apache-Logs, zumindest unkenntlich oder noch besser, gebt nur an das ihr dort eine Zugriffsmöglichkeit habt und gebt diese Logs nur per "privater" Kommunikation und evtl. nur den betroffenen Teil heraus.

Wir möchten uns schon im Vorfeld bei euch für eure Mühe bedanken. Für uns sind diese Informationen bei der Suche des Fehlers und für die Nachvollziehbarkeit wichtig und sehr hilfreich. Außerdem vermeiden wir dadurch unnötige Nachfragen.
Gesperrt