SimuBugCatcher

From HEWIKI
Revision as of 00:12, 6 January 2010 by SIMU-NOVA (Talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

SimuBugCatcher is a utility program which submits automatically generated bug reports to a FogBugz installation.

Overview

A quick overview of how our bug crash detection and tracking system works.

Application Code and Compiling:

  1. Applications compile against BugSlayer.lib and require BugSlayerUtil.dll
  2. In the code, in the beginning of main(), applications set dump settings (Application Name, interactivity flag, Project Name). Project name is hard coded, but we manually change this on some source code branches.
  3. The application sets up a structured exception handler try/catch and registers a handler for the STL runtime checks.

Events during a crash:

  1. Application throws a structured exception
  2. Try/catch block executes the handler in BugSlayerUtil.dll
  3. A log file is written containing the particulars of the crash and information about the system
  4. A minidump of the process is written to a file
  5. The SimuBugCatcher executable is started with command line parameters specifying location of files and FogBugz project name
  6. SimuBugCatcher uploads the minidump to the dump analyzer web page and records the response text
  7. SimuBugCatcher then uploads the log file and the minidump to a custom? FogBugz bug submission web page

Creating a new FogBug or editing an existing one triggers an e-mail to the person to whom the bug is assigned. The bug submission page assigns the bug to the default contact for the project.

Notes: URL to dump analyzer and bug submission page are hard coded into SimuBugCatcher. Also hard coded is the expected data the submission page requires.

Command line options

It understands these command line options and arguments:

/r  
the '/r' option tells SimuBugCatcher to remove the bug report file after attempting to send it.
/i  
the '/i' option tells SimuBugCatcher to collect data from the user interactively. (Only used on non-server product invocations, such as HeroBlade and RepositoryBrowser.)
/p  
the '/p' option indicates which fogBugz PROJECT this crash should be filed under.

Parameters

After processing each option, the remaining command line parameters are interpreted thusly:

Argument #1
the crash TAG. This ends up as the SUBJECT of the FogBugz. e.g.: HeroBlade.exe: exception occurred while ...
Argument #2
the crash LOG filename. This ends up as the explanatory text of the FogBugz that is submitted. In interactive mode, the text the user enters, along with email address, is also included with this text.
Argument #3
optional, the crash DUMP filename. This file, when present, it automatically uploaded to the Fogbugz server as a separate bug-item attachment.
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox