/ 
Log-Dispatch-FogBugz-0.1
River stage zero No dependents
/ Log::Dispatch::FogBugz

NAME

Log::Dispatch::FogBugz - Log::Dispatch appender for sending log messages to the FogBugz bug tracking system

VERSION

Version 0.01

SYNOPSIS

use Log::Dispatch::FogBugz;

my $log = Log::Dispatch::FogBugz->new
    (
        URL               => 'http://fogbugz.bar.com/scoutSubmit.php'
      , Project           => 'Bar'
      , Area              => 'Baz'
      , ForceNewBug       => 0
      , User              => 'Bob the Submitter'
      , DescriptionPrefix => 'Log4perl error!'
      , DescriptionRegex  => qr/> (.+)$/
    );
$log->log( message => "FATAL> main::do_baz(23) - Something really bad happened here", level => 'fatal' );

DESCRIPTION

This is a subclass of Log::Dispatch::Output that implements sending log messages to a FogBugz (http://fogcreek.com/fogbugz) bug tracking system.

METHODS

  • new

    This method takes configuration parameters as follows:

    • URL ($) Required

      Fully qualified url for fogbugz scoutsubmit script.

    • Project ($) Required

      The project to create this bug message in.

    • Area ($) Required

      The area within the given project.

    • ForceNewBug (0|1)

      Whether or not to force the creation of a new bug

    • User ($) Required

      Username to use when submitting.

    • DescriptionPrefix ($) Optionally Required

      String to use as either a prefix or a full description for the error. One of DescriptionRegex or DescriptionPrefix are required.

    • DescriptionRegex (Regex) Optionally Required

      Capturing regex to use to dynamically pull out the description. $1 will be used as the description. Will be concatenated to DescriptionPrefix if set. One of DescriptionRegex or DescriptionPrefix are required.

  • log_message( level => $, message => $ )

    Sends the message if the level is greater than or equal to the object's minimum level.

SEE ALSO

Log::Log4perl::Config, Log::Log4perl::Appender, Log::Dispatch,

AUTHOR

DIMARTINO, <chris.dimartino at gmail.com>

BUGS

Please report any bugs or feature requests to bug-log-dispatch-fogbugz at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Log-Dispatch-FogBugz. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Log::Dispatch::FogBugz

You can also look for information at:

ACKNOWLEDGEMENTS

Thanks to the authors of Log::Log4perl and Log::Dispatch modules.

COPYRIGHT & LICENSE

Copyright 2009 CDIMARTINO, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.