1CGI::Application::PlugiUns:e:rDBCIoPnrtorfiibluet(e3d)PCeGrIl::DAopcpulmiecnattaitoino:n:Plugin::DBIProfile(3)
2
3
4

NAME

6       CGI::Application::Plugin::DBIProfile - DBI profiling plugin
7

SYNOPSIS

9           # Set env in apache or in perl.
10           $ENV{DBI_PROFILE} = '2/CGI::Application::Plugin::DBIProfile::Driver';
11           use CGI::Application::Plugin::DevPopup;
12           use CGI::Application::Plugin::DBIProfile;
13
14           The rest of your application follows
15           ...
16

INSTALLATION

18       To install this module, run the following commands:
19
20           perl Makefile.PL
21           make
22           make test
23           make install
24

DESCRIPTION

26       CGI::Application::Plugin::DBIProfile provides popup (using
27       CAP::DevPopup if available) holding DBI Profile information (see
28       DBI::Profile, DBI::ProfileDumper). It will output both graphed output
29       and a DBI::ProfileDumper report.
30

CONFIGURATION

32       To enable, set the DBI_PROFILE environment variables. For example
33
34       in apache config for cgi
35               SetVar DBI_PROFILE 2/CGI::Application::Plugin::DBIProfile::Driver
36               SetVar CAP_DBIPROFILE_EXEC 1
37
38       in apache config for mod_perl
39               PerlSetVar DBI_PROFILE 2/CGI::Application::Plugin::DBIProfile::Driver
40               PerlSetVar CAP_DBIPROFILE_EXEC 1
41
42       in your CAP module
43               BEGIN {
44                   $ENV{DBI_PROFILE} = '2/CGI::Application::Plugin::DBIProfile::Driver';
45                   $ENV{CAP_DBIPROFILE_EXEC} = 1;
46               }
47
48       If you disable it, be sure to unset the DBI_PROFILE env var, as it will
49       continue to accumulate stats regardless of the setting of
50       CAP_DBIPROFILE_EXEC, you just won't see them.
51
52   MODES OF OPERATION
53       It has two modes of opperation; per-request or per-process. In a CGI
54       environment, there is no difference.
55
56       per-request - this is the default.
57       per-process - set the following env var to a true value.
58               CAP_DBIPROFILE_PERPROCESS 1
59
60       Under mod_perl, the per-request setup will show the DBI Profile
61       specific to each page hit.  The per-process setup will show the DBI
62       Profile that has accumulated for the life of the apache process you are
63       hitting.
64
65       Please note, running under the per-process setting can cause your
66       memory usage to grow significantly, as the profile data is never
67       cleared.
68
69   GRAPHING PLUGINS
70       The default graphing module is
71       CGI::Application::Plugin::DBIProfile::Graph::HTML, which generates a
72       minimal inline HTML graph. To change which graphing plugin is used,
73       it's just another environment variable (no need to set this if you like
74       the default).
75
76           CAP_DBIPROFILE_GRAPHMODULE Your::Graph::Module::Name
77
78       Please see  CGI::Application::Plugin::DBIProfile::Graph::HTML for
79       information on writing new graph modules.
80

TODO

82       Tests. None exist at this time.
83
84       Other graphing plugins (Plotr, Open Flash Chart, GraphML using
85       Graph::Easy).
86
87       Add checks to be sure $dbh->{Profile} isn't disabled (probably better
88       in ::Driver).
89

REQUIREMENTS

91       Data::JavaScript
92       IO::Scalar
93       HTML::Template
94
95       Optional:
96
97       ·   GD::Graph
98
99           For CGI::Application::Plugin::DBIProfile::Graph::GDGraphInline
100           support.
101
102       ·   SVG::TT::Graph
103
104           For CGI::Application::Plugin::DBIProfile::Graph::SVGTT support.
105
106       ·   HTML::BarGraph
107
108           For CGI::Application::Plugin::DBIProfile::Graph::HTMLBarGraph
109           support.
110

SEE ALSO

112       CGI::Application
113       CGI::Application::Plugin::DevPopup
114       CGI::Application::Plugin::DBIProfile::Data
115       CGI::Application::Plugin::DBIProfile::Driver
116       CGI::Application::Plugin::DBIProfile::Graph::HTML
117       CGI::Application::Plugin::DBIProfile::Graph::HTML::Horizontal
118       CGI::Application::Plugin::DBIProfile::Graph::HTMLBarGraph
119       CGI::Application::Plugin::DBIProfile::Graph::GDGraphInline
120       CGI::Application::Plugin::DBIProfile::Graph::SVGTT
121

SPECIAL THANKS

123       To Sam Tregar, for the original codebase on which this was based, and
124       DBI::ProfileDumper itself.
125

AUTHOR

127           Sam Tregar, C<< <sam@tregar.com> >>
128           Joshua I Miller, C<< <unrtst@cpan.org> >>
129

BUGS

131       Please report any bugs or feature requests to
132       bug-cgi-application-plugin-dbiprofile@rt.cpan.org, or through the web
133       interface at
134       http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CGI-Application-Plugin-DBIProfile
135       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CGI-Application-Plugin-
136       DBIProfile>.  I will be notified, and then you'll automatically be
137       notified of progress on your bug as I make changes.
138

140       Copyright 2007 Joshua Miller, all rights reserved.
141
142       This program is free software; you can redistribute it and/or modify it
143       under the same terms as Perl itself.
144
145
146
147perl v5.12.0                      2010-0C4G-I3:0:Application::Plugin::DBIProfile(3)
Impressum