user_guide/general/profiling.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3 <head>
   4
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <title>Profiling Your Application : CodeIgniter User Guide</title>
   7
   8 <style type='text/css' media='all'>@import url('../userguide.css');</style>
   9 <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
  10
  11 <script type="text/javascript" src="../nav/nav.js"></script>
  12 <script type="text/javascript" src="../nav/prototype.lite.js"></script>
  13 <script type="text/javascript" src="../nav/moo.fx.js"></script>
  14 <script type="text/javascript" src="../nav/user_guide_menu.js"></script>
  15
  16 <meta http-equiv='expires' content='-1' />
  17 <meta http-equiv= 'pragma' content='no-cache' />
  18 <meta name='robots' content='all' />
  19 <meta name='author' content='ExpressionEngine Dev Team' />
  20 <meta name='description' content='CodeIgniter User Guide' />
  21
  22 </head>
  23 <body>
  24
  25 <!-- START NAVIGATION -->
  26 <div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
  27 <div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
  28 <div id="masthead">
  29 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
  30 <tr>
  31 <td><h1>CodeIgniter User Guide Version 2.0.2</h1></td>
  32 <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
  33 </tr>
  34 </table>
  35 </div>
  36 <!-- END NAVIGATION -->
  37
  38
  39 <!-- START BREADCRUMB -->
  40 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
  41 <tr>
  42 <td id="breadcrumb">
  43 <a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
  44 <a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
  45 Profiling Your Application
  46 </td>
  47 <td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
  48 </tr>
  49 </table>
  50 <!-- END BREADCRUMB -->
  51
  52 <br clear="all" />
  53
  54
  55 <!-- START CONTENT -->
  56 <div id="content">
  57
  58
  59 <h1>Profiling Your Application</h1>
  60
  61 <p>The Profiler Class will display benchmark results, queries you have run, and $_POST data at the bottom of your pages.
  62 This information can be useful during development in order to help with debugging and optimization.</p>
  63
  64
  65 <h2>Initializing the Class</h2>
  66
  67 <p class="important"><strong>Important:</strong>&nbsp; This class does <kbd>NOT</kbd> need to be initialized. It is loaded automatically by the
  68 <a href="../libraries/output.html">Output Class</a> if profiling is enabled as shown below.</p>
  69
  70 <h2>Enabling the Profiler</h2>
  71
  72         <p>To enable the profiler place the following function anywhere within your <a href="controllers.html">Controller</a> functions:</p>
  73         <code>$this->output->enable_profiler(TRUE);</code>
  74
  75         <p>When enabled a report will be generated and inserted at the bottom of your pages.</p>
  76
  77         <p>To disable the profiler you will use:</p>
  78         <code>$this->output->enable_profiler(FALSE);</code>
  79
  80
  81 <h2>Setting Benchmark Points</h2>
  82
  83         <p>In order for the Profiler to compile and display your benchmark data you must name your mark points using specific syntax.</p>
  84
  85         <p>Please read the information on setting Benchmark points in <a href="../libraries/benchmark.html">Benchmark Class</a> page.</p>
  86
  87
  88 <h2>Enabling and Disabling Profiler Sections</h2>
  89
  90         <p>Each section of Profiler data can be enabled or disabled by setting a corresponding config variable to <var>TRUE</var> or <var>FALSE</var>.  This can be done one of two ways.  First, you can set application wide defaults with the <dfn>application/config/profiler.php</dfn> config file.</p>
  91
  92         <code>$config['config']&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;= FALSE;<br />
  93         $config['queries']&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;= FALSE;<br /></code>
  94
  95         <p>In your controllers, you can override the defaults and config file values by calling the <kbd>set_profiler_sections()</kbd> method of the <a href="../libraries/output.html">Output class</a>:</p>
  96
  97         <code>$sections = array(<br />
  98         &nbsp;&nbsp;&nbsp;&nbsp;'config' &nbsp;=> TRUE,<br />
  99         &nbsp;&nbsp;&nbsp;&nbsp;'queries' => TRUE<br />
 100         &nbsp;&nbsp;&nbsp;&nbsp;);<br />
 101         <br />
 102         $this->output->set_profiler_sections($sections);</code>
 103
 104         <p>Available sections and the array key used to access them are described in the table below.</p>
 105
 106         <table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
 107                 <tr>
 108                 <th>Key</th>
 109                 <th>Description</th>
 110                 <th>Default</th>
 111                 </tr><tr>
 112
 113                 <td class="td"><strong>benchmarks</strong></td>
 114                 <td class="td">Elapsed time of Benchmark points and total execution time</td>
 115                 <td class="td">TRUE</td>
 116                 </tr><tr>
 117
 118                 <td class="td"><strong>config</strong></td>
 119                 <td class="td">CodeIgniter Config variables</td>
 120                 <td class="td">TRUE</td>
 121                 </tr><tr>
 122
 123                 <td class="td"><strong>controller_info</strong></td>
 124                 <td class="td">The Controller class and method requested</td>
 125                 <td class="td">TRUE</td>
 126                 </tr><tr>
 127
 128                 <td class="td"><strong>get</strong></td>
 129                 <td class="td">Any GET data passed in the request</td>
 130                 <td class="td">TRUE</td>
 131                 </tr><tr>
 132
 133                 <td class="td"><strong>http_headers</strong></td>
 134                 <td class="td">The HTTP headers for the current request</td>
 135                 <td class="td">TRUE</td>
 136                 </tr><tr>
 137
 138                 <td class="td"><strong>memory_usage</strong></td>
 139                 <td class="td">Amount of memory consumed by the current request, in bytes</td>
 140                 <td class="td">TRUE</td>
 141                 </tr><tr>
 142
 143                 <td class="td"><strong>post</strong></td>
 144                 <td class="td">Any POST data passed in the request</td>
 145                 <td class="td">TRUE</td>
 146                 </tr><tr>
 147
 148                 <td class="td"><strong>queries</strong></td>
 149                 <td class="td">Listing of all database queries executed, including execution time</td>
 150                 <td class="td">TRUE</td>
 151                 </tr><tr>
 152
 153                 <td class="td"><strong>uri_string</strong></td>
 154                 <td class="td">The URI of the current request</td>
 155                 <td class="td">TRUE</td>
 156                 </tr><tr>
 157         </table>
 158
 159
 160 </div>
 161 <!-- END CONTENT -->
 162
 163
 164 <div id="footer">
 165 <p>
 166 Previous Topic:&nbsp;&nbsp;<a href="caching.html">Caching</a>
 167 &nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 168 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 169 <a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 170 Next Topic:&nbsp;&nbsp;<a href="managing_apps.html">Managing Applications</a>
 171 </p>
 172 <p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
 173 </div>
 174
 175 </body>
 176 </html>