.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CGI::Application::Plugin::DBIProfile 3pm"
.TH CGI::Application::Plugin::DBIProfile 3pm "2015-06-10" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
CGI::Application::Plugin::DBIProfile \- DBI profiling plugin
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&    # Set env in apache or in perl.
\&    $ENV{DBI_PROFILE} = \*(Aq2/CGI::Application::Plugin::DBIProfile::Driver\*(Aq;
\&    use CGI::Application::Plugin::DevPopup;
\&    use CGI::Application::Plugin::DBIProfile;
\&
\&    The rest of your application follows
\&    ...
.Ve
.SH "INSTALLATION"
.IX Header "INSTALLATION"
To install this module, run the following commands:
.PP
.Vb 4
\&    perl Makefile.PL
\&    make 
\&    make test
\&    make install
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
CGI::Application::Plugin::DBIProfile provides popup (using CAP::DevPopup if available) holding \s-1DBI\s0 Profile information (see DBI::Profile, DBI::ProfileDumper). It will output both graphed output and a DBI::ProfileDumper report.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
To enable, set the \s-1DBI_PROFILE\s0 environment variables. For example
.IP "in apache config for cgi" 4
.IX Item "in apache config for cgi"
.Vb 2
\&    SetVar DBI_PROFILE 2/CGI::Application::Plugin::DBIProfile::Driver
\&    SetVar CAP_DBIPROFILE_EXEC 1
.Ve
.IP "in apache config for mod_perl" 4
.IX Item "in apache config for mod_perl"
.Vb 2
\&    PerlSetVar DBI_PROFILE 2/CGI::Application::Plugin::DBIProfile::Driver
\&    PerlSetVar CAP_DBIPROFILE_EXEC 1
.Ve
.IP "in your \s-1CAP\s0 module" 4
.IX Item "in your CAP module"
.Vb 4
\&    BEGIN {
\&        $ENV{DBI_PROFILE} = \*(Aq2/CGI::Application::Plugin::DBIProfile::Driver\*(Aq;
\&        $ENV{CAP_DBIPROFILE_EXEC} = 1;
\&    }
.Ve
.PP
If you disable it, be sure to unset the \s-1DBI_PROFILE\s0 env var, as it will continue to accumulate stats regardless of the setting of \s-1CAP_DBIPROFILE_EXEC,\s0 you just won't see them.
.SS "\s-1MODES OF OPERATION\s0"
.IX Subsection "MODES OF OPERATION"
It has two modes of opperation; per-request or per-process. In a \s-1CGI\s0 environment, there is no difference.
.IP "per-request \- this is the default." 4
.IX Item "per-request - this is the default."
.PD 0
.IP "per-process \- set the following env var to a true value." 4
.IX Item "per-process - set the following env var to a true value."
.PD
.Vb 1
\&    CAP_DBIPROFILE_PERPROCESS 1
.Ve
.PP
Under mod_perl, the per-request setup will show the \s-1DBI\s0 Profile specific to each page hit.
The per-process setup will show the \s-1DBI\s0 Profile that has accumulated for the life of the apache process you are hitting.
.PP
Please note, running under the per-process setting can cause your memory usage to grow significantly, as the profile data is never cleared.
.SS "\s-1GRAPHING PLUGINS\s0"
.IX Subsection "GRAPHING PLUGINS"
The default graphing module is CGI::Application::Plugin::DBIProfile::Graph::HTML, which generates a minimal inline \s-1HTML\s0 graph. To change which graphing plugin is used, it's just another environment variable (no need to set this if you like the default).
.PP
.Vb 1
\&    CAP_DBIPROFILE_GRAPHMODULE Your::Graph::Module::Name
.Ve
.PP
Please see  CGI::Application::Plugin::DBIProfile::Graph::HTML for information on writing new graph modules.
.SH "TODO"
.IX Header "TODO"
Tests. None exist at this time.
.PP
Other graphing plugins (Plotr, Open Flash Chart, GraphML using Graph::Easy).
.PP
Add checks to be sure \f(CW$dbh\fR\->{Profile} isn't disabled (probably better in ::Driver).
.SH "REQUIREMENTS"
.IX Header "REQUIREMENTS"
.IP "Data::JavaScript" 4
.IX Item "Data::JavaScript"
.PD 0
.IP "IO::Scalar" 4
.IX Item "IO::Scalar"
.IP "HTML::Template" 4
.IX Item "HTML::Template"
.PD
.PP
Optional:
.IP "\(bu" 4
GD::Graph
.Sp
For CGI::Application::Plugin::DBIProfile::Graph::GDGraphInline support.
.IP "\(bu" 4
SVG::TT::Graph
.Sp
For CGI::Application::Plugin::DBIProfile::Graph::SVGTT support.
.IP "\(bu" 4
HTML::BarGraph
.Sp
For CGI::Application::Plugin::DBIProfile::Graph::HTMLBarGraph support.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "CGI::Application" 4
.IX Item "CGI::Application"
.PD 0
.IP "CGI::Application::Plugin::DevPopup" 4
.IX Item "CGI::Application::Plugin::DevPopup"
.IP "CGI::Application::Plugin::DBIProfile::Data" 4
.IX Item "CGI::Application::Plugin::DBIProfile::Data"
.IP "CGI::Application::Plugin::DBIProfile::Driver" 4
.IX Item "CGI::Application::Plugin::DBIProfile::Driver"
.IP "CGI::Application::Plugin::DBIProfile::Graph::HTML" 4
.IX Item "CGI::Application::Plugin::DBIProfile::Graph::HTML"
.IP "CGI::Application::Plugin::DBIProfile::Graph::HTML::Horizontal" 4
.IX Item "CGI::Application::Plugin::DBIProfile::Graph::HTML::Horizontal"
.IP "CGI::Application::Plugin::DBIProfile::Graph::HTMLBarGraph" 4
.IX Item "CGI::Application::Plugin::DBIProfile::Graph::HTMLBarGraph"
.IP "CGI::Application::Plugin::DBIProfile::Graph::GDGraphInline" 4
.IX Item "CGI::Application::Plugin::DBIProfile::Graph::GDGraphInline"
.IP "CGI::Application::Plugin::DBIProfile::Graph::SVGTT" 4
.IX Item "CGI::Application::Plugin::DBIProfile::Graph::SVGTT"
.PD
.SH "SPECIAL THANKS"
.IX Header "SPECIAL THANKS"
To Sam Tregar, for the original codebase on which this was based, and DBI::ProfileDumper itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 2
\&    Sam Tregar, C<< <sam@tregar.com> >>
\&    Joshua I Miller, C<< <unrtst@cpan.org> >>
.Ve
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
bug\-cgi\-application\-plugin\-dbiprofile@rt.cpan.org, or through the web
interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CGI\-Application\-Plugin\-DBIProfile>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2007 Joshua Miller, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.