BugReport Appender
The Bugs Genie Bug Report Appender files bug reports into the BUGS - The Bugs Genie bug tracking system.
in order to use this appender with the Bugs Genie, two additional PHP files must be added to your installation (these fiels are included with BugReport Appender download). These files create a form handler that the appender uses to file bug reports.
| File | Destination |
|---|---|
| direct_bug_post.php | Place this in the root directory of Bugs Genie |
| bug_report_functions.php | Place this in the include directory of Bugs Genie |
Bugs Genie Bug Report Appender takes a number of options from the log4j configuration:
| Option | Required | Description |
|---|---|---|
| application | true | Bugs Genie application. |
| assignTo | false | Bugs Genie username to whom to assign new bug reports. |
| authenticationHost | false | Authentication host to use if HTTP authentication is required to file bugs into the web based bug tracking system. |
| authenticationPassword | false | Authentication password to use if HTTP authentication is required to file bugs into the web based bug tracking system. |
| authenticationRealm | false | Authentication realm to use if HTTP authentication is required to file bugs into the web based bug tracking system. |
| authenticationUsername | false | Authentication username to use if HTTP authentication is required to file bugs into the web based bug tracking system. |
| bugsPassword | true | Bugs Genie password. |
| bugsUsername | true | Bugs Genie username. |
| build | true | Bugs Genie build name. |
| category | true | Bugs Genie category for newly filed bugs. |
| connectionStaleCheckingEnabled | false | Sets the staleCheckingEnabled value to be set on HttpConnections that are created. |
| edition | true | Bugs Genie edition. |
| hashingMethod | false | In order to minimize reporting duplicate bugs, bug reports are tracked with
semiunique hashes. This setting controls the method by which these hash values are
generated. Available hasing methods:
|
| layout | true | A log4j layout. |
| maxConnectionsPerHost | false | Sets the maximum number of connections allowed for a given HostConfiguration. Defaults to 2 |
| maxSize | false | Set the maximum number of logging events the thread bound buffer can hold. Defaults to 200. |
| maxTotalConnections | false | Sets the maximum number of connections allowed in the system. |
| product | true | Bugs Genie product. |
| status | true | Bugs Genie status for newly filed bug reports. |
| reportDuplicates | false | By default, appenders don't report duplicate bug reports. Set this to true to change this behavior. |
| thresholdPriority | false | Bug reports are not filed unless one or more logging events is of the specified (or greater) priority. The default priority is ERROR |
| thresholdSize | false | For long running threads, it may not be practical to wait until a thread ends to file a report. For long running threads, the Logging Event buffer will be checked (based on the sleepMilliseconds parameter). If the events in the buffer are of suffient number (specified by this parameter) and have met the threadholdPriority, they will be filed as a bug. The default value for this option is 100. |
| url | true | Bugs Genie url (point this at direct_bug_post.php). |
log4j.rootLogger=DEBUG, A1, A2
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.threshold=ERROR
log4j.appender.A2=net.codesmarts.log4j.BugsGenieBugReportAppender
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
log4j.appender.A2.thresholdPriority=ERROR
log4j.appender.A2.product=Fake Product
log4j.appender.A2.edition=1.0
log4j.appender.A2.build=12
log4j.appender.A2.category=Interface Bugs
log4j.appender.A2.application=Application
log4j.appender.A2.status=Just confirmed
log4j.appender.A2.bugsUsername=username
log4j.appender.A2.bugsPassword=password
log4j.appender.A2.url=http://myhost/bugs/direct_bug_post.php
# Print the date in ISO 8601 format
log4j.appender.A1.layout.ConversionPattern=%d [%t] %-5p %c - %m%n
log4j.appender.A2.layout.ConversionPattern=%d [%t] %-5p %c - %m%n