/docs/dox/analyzing_error_reports.dox

http://crashrpt.googlecode.com/ · Unknown · 45 lines · 34 code · 11 blank · 0 comment · 0 complexity · 2cc9978a0af0545d9d3e33e7b7d6cf77 MD5 · raw file

  1. /*!
  2. \page analyzing_error_reports Analyzing Error Reports
  3. When a software release is made and CrashRpt support is enabled in your software, sooner or later you
  4. start receiving crash reports.
  5. To check the integrity of received crash report files, you may calculate MD5 hash for
  6. your error report and compare it with the MD5 hash that is attached to the error report.
  7. When you receive error reports using HTTP connection, the MD5 hash is passed to the
  8. server-side script through the 'md5' parameter. When you receive error reports using email,
  9. the MD5 hash is attached to the email.
  10. Count of received crash reports may depend on robustness of your software to various
  11. exceptional situations and on popularity of your software. So it's nothing unusual
  12. if you receive hundreds of error reports a day. If there are many incoming error reports,
  13. you can monitor and analyse them for some period of time after release, and prepare a hot fix
  14. release.
  15. The purpose of the error report is to help you determine the reason of the problem and
  16. try to fix it. The keyword is 'try', because in most cases you can't fix crashes as
  17. you usually do with normal bugs. You usually can't reproduce the error on your machine,
  18. so you can't guarantee it is fixed. Typically, you make fixes in parts of code that
  19. could cause the crash most probably and release a new version of your software.
  20. For some tips on doing such code modifications, see \ref writing_robust_code.
  21. The normal scenario is that your software becomes more and more stable with each evolutional release and
  22. less and less error reports are received.
  23. \section zip_structure The Structure of an Error Report
  24. A crash report is a ZIP file containing several files, such as
  25. - crash minidump (<i>crashdump.dmp</i>);
  26. - crash description XML (<i>crashrpt.xml</i>);
  27. - optional desktop screenshot file(s);
  28. - optional screen capture video file;
  29. - and other optional application-specific files, for example, log files.
  30. For more information about using crash description XML and crash minidump,
  31. see \ref using_crash_descriptor and \ref using_minidump.
  32. For information on how to automate error report processing with a web-server or
  33. with a command-line tool, see \ref automating_crash_report_processing.
  34. */