1Catalyst::Plugin::StackUTsrearceC(o3n)tributed Perl DocuCmaetnatlaytsito:n:Plugin::StackTrace(3)
2
3
4

NAME

6       Catalyst::Plugin::StackTrace - Display a stack trace on the debug
7       screen
8

SYNOPSIS

10           use Catalyst qw/-Debug StackTrace/;
11

DESCRIPTION

13       This plugin will enhance the standard Catalyst debug screen by
14       including a stack trace of your appliation up to the point where the
15       error occurred.  Each stack frame is displayed along with the package
16       name, line number, file name, and code context surrounding the line
17       number.
18
19       This plugin is only active in -Debug mode by default, but can be
20       enabled by setting the "enable" config option.
21

CONFIGURATION

23       Configuration is optional and is specified in
24       MyApp->config->{stacktrace}.
25
26   enable
27       Allows you forcibly enable or disalbe this plugin, ignoring the current
28       debug setting. If this option is defined, its value will be used.
29
30   context
31       The number of context lines of code to display on either side of the
32       stack frame line.  Defaults to 3.
33
34   reverse
35       By default, the stack frames are shown in from "top" to "bottom"
36       (newest to oldest). Enabling this option reverses the stack frames so
37       they will be displayed "bottom" to "top", or from the callers
38       perspective.
39
40   verbose
41       This option sets the amount of stack frames you want to see in the
42       stack trace.  It defaults to 0, meaning only frames from your
43       application's namespace are shown.  You can use levels 1 and 2 for
44       deeper debugging.
45
46       If set to 1, the stack trace will include frames from packages outside
47       of your application's namespace, but not from most of the Catalyst
48       internals.  Packages ignored at this level include:
49
50           Catalyst
51           Catalyst::Action
52           Catalyst::Base
53           Catalyst::Dispatcher
54           Catalyst::Engine::*
55           Catalyst::Plugin::StackTrace
56           Catalyst::Plugin::Static::Simple
57           NEXT
58           main
59
60       If set to 2, the stack trace will include frames from everything except
61       this module.
62

INTERNAL METHODS

64       The following methods are extended by this plugin.
65
66       execute
67           In execute, we create a local die handler to generate the stack
68           trace.
69
70       finalize_error
71           In finalize_error, we inject the stack trace HTML into the debug
72           screen below the error message.
73
74       setup
75

SEE ALSO

77       Catalyst
78

AUTHORS

80       Andy Grundman, <andy@hybridized.org>
81
82       Matt S. Trout, <mst@shadowcatsystems.co.uk>
83

THANKS

85       The authors of CGI::Application::Plugin::DebugScreen, from which a lot
86       of code was used.
87

89       Copyright (c) 2005 - 2009 the Catalyst::Plugin::StackTrace "AUTHORS" as
90       listed above.
91

LICENSE

93       This program is free software, you can redistribute it and/or modify it
94       under the same terms as Perl itself.
95
96
97
98perl v5.34.0                      2021-07-22   Catalyst::Plugin::StackTrace(3)
Impressum