matomo-org/matomo

add bug reporting feature to help page

Open

#5810 opened on Jul 10, 2014

View on GitHub
 (4 comments) (0 reactions) (0 assignees)PHP (21,513 stars) (2,847 forks)batch import
EnhancementHelp wanted

Description

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.

Contributor guide

Tech stack
phpjavascripthtmlcss
Domain
frontendbackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PHP knowledgeMatomo plugin developmentJavaScript basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate the existing Help page structure in Matomo (e.g., plugins/Help/). Look into how system info is gathered (e.g., using PHP functions like phpinfo()). Consider adding a new section to the Help page for bug reports. Review existing bug report mechanisms in the codebase. Check if there is a logging component that can be exposed for user debugging.