add bug reporting feature to help page

matomo-org / matomo

Empowering People Ethically with the leading open source alternative to Google Analytics that gives you full control over your data. Matomo lets you easily collect data from websites & apps and visualise this data and extract insights. Privacy is built-in. Liberating Web Analytics. Star us on Github? +1. And we love Pull Requests!

https://matomo.org/

GNU General Public License v3.0

19.94k stars 2.66k forks source link

add bug reporting feature to help page #5810

Open diosmosis opened 10 years ago

diosmosis commented 10 years ago

To aid in debugging individual user issues and bugs, it would be helpful if data regarding the Piwik install and server were sent to us along w/ a bug report. A new section can be added to the Help page that allows users to either:

send such a bug report w/ info
view the bug report to copy-paste in a dialog (so they can report to the forums or email it themselves)

The following info can be helpful in debugging:

phpinfo() output
server info (OS, filesystem, etc.)
webserver log entries related to piwik install
Piwik log entries from a certain time (should also allow users to manage logging through the web interface so we can get as much debug info as possible)

Users should be able to specify which info to send and should be able to double check that they are ok w/ sending the data.

mattab commented 10 years ago

Sounds good to add possibility for users to copy paste PHPINFO + Server info + maybe also Piwik System check result.

feedback about other items:

webserver log entries related to piwik install

it won't be possible for us to read the web server log (we don't know the path nor the web server user should have permission to read it)

nor should we for privacy reasons I think...

Piwik log entries from a certain time

imho not needed for MVP

Users should be able to specify which info to send and should be able to double check that they are ok w/ sending the data.

Maybe we can let them copy paste and they can manually check what info they copy paste?

mattab commented 10 years ago

It's better to let users keep reporting the bug in the forums as it keeps it all in one place (ie. we shouldn't tell users to report by email)

diosmosis commented 10 years ago

the option can be to post to the forum or to copy-paste the info

mattab commented 10 years ago

users will have to post on forum themselves to make sure they have a chance to be notified when we fix the issue, or need more info from them, or need them to test a patch etc.

So +1 for letting them copy paste and then instructing them to post in a new forum post