Catalyst::Plugin::ErrorCatcher - Catch application errors and emit them somewhere
version 0.0.8.13
use Catalyst qw/-Debug StackTrace ErrorCatcher/;
This plugin allows you to do More Stuff with the information that would normally only be seen on the Catalyst Error Screen courtesy of the Catalyst::Plugin::StackTrace plugin.
The plugin is configured in a similar manner to other Catalyst plugins:
<Plugin::ErrorCatcher> enable 1 context 5 always_log 0 include_session 0 user_identified_by username emit_module A::Module </Plugin::ErrorCatcher>
Setting this to true forces the module to work its voodoo.
It's also enabled if the value is unset and you're running Catalyst in debug-mode.
When there is stack-trace information to share, how many lines of context to show around the line that caused the error.
This specifies which module to use for custom output behaviour.
You can chain multiple modules by specifying a line in the config for each module you'd like used:
emit_module A::Module emit_module Another::Module emit_module Yet::Another::Module
If none are specified, or all that are specified fail, the default behaviour is to log the prepared message at the INFO level via $c->log().
$c->log()
For details on how to implement a custom emitter see "CUSTOM EMIT CLASSES" in this documentation.
The default plugin behaviour when using one or more emitter modules is to suppress the info log message if one or more of them succeeded.
If you wish to log the information, via $c->log() then set this value to 1.
The default behaviour is to suppress potentially sensitive and revealing session-data in the error report.
If you feel that this information is useful in your investigations set the value to true.
When set to 1 the report will include a Data::Dump::pp() representation of the request's session.
Data::Dump::pp()
If there's a logged-in user use the specified value as the method to identify the user.
If the specified value is invalid the module defaults to using id.
If unspecified the value defaults to id.
It is possible to run your application in non-Debug mode, and still have errors reported with a stack-trace.
Include the StackTrace and ErrorCatcher plugins in MyApp.pm:
use Catalyst qw< ErrorCatcher StackTrace >;
Set up your myapp.conf to include the following:
myapp.conf
<stacktrace> enable 1 </stacktrace> <Plugin::ErrorCatcher> enable 1 # include other options here <Plugin::ErrorCatcher>
Any exceptions should now show your user the "Please come back later" screen whilst still capturing and emitting a report with stack-trace.
This module uses MIME::Lite to send the prepared output to a specified email address.
See Catalyst::Plugin::ErrorCatcher::Email for usage and configuration details.
A custom emit class takes the following format:
package A::Module; # vim: ts=8 sts=4 et sw=4 sr sta use strict; use warnings; sub emit { my ($class, $c, $output) = @_; $c->log->info( 'IGNORING OUTPUT FROM Catalyst::Plugin::ErrorCatcher' ); return; } 1; __END__
The only requirement is that you have a sub called emit.
emit
Catalyst::Plugin::ErrorCatcher passes the following parameters in the call to emit():
Catalyst::Plugin::ErrorCatcher
emit()
The package name
A Context object
The processed output from Catalyst::Plugin::ErrorCatcher
If you want to use the original error message you should use:
my @error = @{ $c->error };
You may use and abuse any Catalyst methods, or other Perl modules as you see fit.
Summary: https://github.com/chiselwright/catalyst-plugin-errorcatcher/pull/1
Bug report: https://rt.cpan.org/Public/Bug/Display.html?id=75607
Catalyst, Catalyst::Plugin::StackTrace
The authors of Catalyst::Plugin::StackTrace, from which a lot of code was used.
Ash Berlin for guiding me in the right direction after a known hacky first implementation.
Fitz Elliot https://github.com/felliott/
Chisel <chisel@chizography.net>
This software is copyright (c) 2011 by Chisel Wright.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Catalyst::Plugin::ErrorCatcher, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Catalyst::Plugin::ErrorCatcher
CPAN shell
perl -MCPAN -e shell install Catalyst::Plugin::ErrorCatcher
For more information on module installation, please visit the detailed CPAN module installation guide.