Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 7cdef03633cf8cc40678fc837ccec2d2164caade / . / user_guide / general / profiling.html
blob: 804c9e0bb7bda3a2e1d5bfc9927cc46eeee8629b [file] [log] [blame]
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Derek Allardafd99ac2008-01-19 19:59:14 +0000[diff] [blame]2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]3<head>
4
Derek Allard8039d4c2008-05-31 02:47:56 +0000[diff] [blame]5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Derek Jonesfd93d222008-05-06 15:18:50 +0000[diff] [blame]6<title>Profiling Your Application : CodeIgniter User Guide</title>
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]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>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame]14<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]15
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
Derek Allard3d879d52008-01-18 19:41:32 +0000[diff] [blame]19<meta name='author' content='ExpressionEngine Dev Team' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]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>
Rick Ellis7cdef032008-08-26 18:44:54 +0000[diff] [blame^]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>
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Derek Jones1ca3fc42008-06-27 00:19:33 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.6.3</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]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">
Derek Jones7a9193a2008-01-21 18:39:20 +0000[diff] [blame]43<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Profiling Your Application
46</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]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>
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]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.
62This information can be useful during development in order to help with debugging and optimization.</p>
63
64
65<h2>Initializing the Class</h2>
66
admin10c3f412006-10-08 07:21:12 +0000[diff] [blame]67<p class="important"><strong>Important:</strong>&nbsp; This class does <kbd>NOT</kbd> need to be initialized. It is loaded automatically by the
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]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
admine7e1dcd2006-10-21 18:04:01 +0000[diff] [blame]72<p>To enable the profiler place the following function anywhere within your <a href="controllers.html">Controller</a> functions:</p>
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]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<h2>Setting Benchmark Points</h2>
81
Derek Allardce66d152008-03-04 20:55:55 +0000[diff] [blame]82<p>In order for the Profiler to compile and display your benchmark data you must name your mark points using specific syntax.</p>
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]83
Derek Allardce66d152008-03-04 20:55:55 +0000[diff] [blame]84<p>Please read the information on setting Benchmark points in <a href="../libraries/benchmark.html">Benchmark Class</a> page.</p>
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]85
86
87
88</div>
89<!-- END CONTENT -->
90
91
92<div id="footer">
93<p>
94Previous Topic:&nbsp;&nbsp;<a href="caching.html">Caching</a>
95&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
96<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
97<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
admincef21062006-10-30 17:13:13 +0000[diff] [blame]98Next Topic:&nbsp;&nbsp;<a href="managing_apps.html">Managing Applications</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]99</p>
Derek Jones07870432008-02-13 03:49:26 +0000[diff] [blame]100<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
admin0cd0d4c2006-10-03 05:21:32 +0000[diff] [blame]101</div>
102
103</body>
104</html>