Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 243f5cc45f23436a1ed3f2fc1ac5f0388dc3d4f5 / . / user_guide / libraries / benchmark.html
blob: b8b0bfd32784103c22b5a0db5f6a64288512eb87 [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html>
3<head>
4
5<title>Code Igniter User Guide</title>
6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]10<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]12<script type="text/javascript" src="../nav/moo.fx.js"></script>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]13<script type="text/javascript">
14window.onload = function() {
15 myHeight = new fx.Height('nav', {duration: 400});
16 myHeight.hide();
17}
18</script>
19
20<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
21<meta http-equiv='expires' content='-1' />
22<meta http-equiv= 'pragma' content='no-cache' />
23<meta name='robots' content='all' />
24<meta name='author' content='Rick Ellis' />
25<meta name='description' content='Code Igniter User Guide' />
26
27</head>
28<body>
29
30<!-- START NAVIGATION -->
31<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
32<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
33<div id="masthead">
34<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
35<tr>
admin41a16852006-09-26 18:17:19 +0000[diff] [blame]36<td><h1>Code Igniter User Guide Version 1.5.0</h1></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]37<td id="breadcrumb_right"><a href="../toc.html">Full Table of Contents</a></td>
38</tr>
39</table>
40</div>
41<!-- END NAVIGATION -->
42
43
44<!-- START BREADCRUMB -->
45<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
46<tr>
47<td id="breadcrumb">
48<a href="http://www.codeigniter.com/">Code Igniter Home</a> &nbsp;&#8250;&nbsp;
49<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
50Benchmarking Class
51</td>
52<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.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>
53</tr>
54</table>
55<!-- END BREADCRUMB -->
56
57<br clear="all" />
58
59
60<!-- START CONTENT -->
61<div id="content">
62
63
64<h1>Benchmarking Class</h1>
65
66<p>Code Igniter has a Benchmarking class that is always active, enabling the time difference between any
67two marked points to be calculated.</p>
68
69<p class="important"><strong>Note:</strong> This class is initialized automatically by the system so there is no need to do it manually.</p>
70
71
72<p>In addition, the benchmark is always started the moment the framework is
73invoked, and ended by the output class right before sending the final view to the browser, enabling a very accurate
74timing of the entire system execution to be shown.</p>
75
admine26611f2006-10-02 21:59:12 +0000[diff] [blame]76
77<h3>Table of Contents</h3>
78
79<ul>
80<li><a href="#using">Using the Benchmark Class</a></li>
81<li><a href="#execution">Displaying Total Execution Time</a></li>
82<li><a href="#memory">Displaying Memory Consumption</a></li>
83<li><a href="#profiler">Auto Profiler</a></li>
84</ul>
85
86
87
88<a name="using"></a>
89<h2>Using the Benchmark Class</h2>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]90
91<p>The Benchmark class can be used within your <a href="../general/controllers.html">controllers</a>, <a href="../general/views.html">views</a>, or your <a href="../general/models.html">Models</a>. The process for usage is this:
92
93<ol>
94<li>Mark a start point</li>
95<li>Mark an end point</li>
96<li>Run the "elapsed time" function to view the results</li>
97</ol>
98
99<p>Here's an example using real code:</p>
100
101<code>$this->benchmark->mark('start');<br />
102<br />
103// Some code happens here<br />
104<br />
105$this->benchmark->mark('end');<br />
106<br />
107echo $this->benchmark->elapsed_time('start', 'end');</code>
108
109<p><strong>Note:</strong> The words "start" and "end" are arbitrary. They are simply words used to set two markers. You can
110use any words you want, and you can set multiple sets of markers. Consider this example:</p>
111
112<code>$this->benchmark->mark('dog');<br />
113<br />
114// Some code happens here<br />
115<br />
116$this->benchmark->mark('cat');<br />
117<br />
118// More code happens here<br />
119<br />
120$this->benchmark->mark('bird');<br />
121<br />
122echo $this->benchmark->elapsed_time('dog', 'cat');<br />
123echo $this->benchmark->elapsed_time('cat', 'bird');<br />
124echo $this->benchmark->elapsed_time('dog', 'bird');</code>
125
126
admine26611f2006-10-02 21:59:12 +0000[diff] [blame]127<a name="execution"></a>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]128<h2>Displaying Total Execution Time</h2>
129
130<p>If you would like to display the total elapsed time from the moment Code Igniter starts to the moment the final output
131is sent to the browser, simply place this in one of your view templates:</p>
132
133<code>&lt;?=$this->benchmark->elapsed_time();?&gt;</code>
134
135<p>You'll notice that it's the same function used in the examples above to calculate the time between two point, except you are
136<strong>not</strong> using any parameters. When the parameters are absent, Code Igniter does not stop the benchmark until right before the final
137output is sent to the browser. It doesn't matter where you use the function call, the timer will continue to run until the very end.</p>
138
139<p>An alternate way to show your elapsed time in your view files is to use this pseudo-variable, if you prefer not to use the pure PHP:</p>
140<code>{elapsed_time}</code>
141
142<p class="important"><strong>Note:</strong> If you want to benchmark anything within your controller
143functions you must set your own start/end points.</p>
144
admine26611f2006-10-02 21:59:12 +0000[diff] [blame]145<a name="memory"></a>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]146<h2>Displaying Memory Consumption</h2>
147
148<p>If your PHP installation is configured with --enable-memory-limit, you can display the amount of memory consumed by the entire
149system using the following code in one of your view file:</p>
150
151<code>&lt;?=$this->benchmark->memory_usage();?&gt;</code>
152<p>Note: This function can only be used in your view files. The consumpiton will reflect the total memory used by the entire app.</p>
153
154<p>An alternate way to show your memory usage in your view files is to use this pseudo-variable, if you prefer not to use the pure PHP:</p>
155<code>{memory_usage}</code>
156
157
admine26611f2006-10-02 21:59:12 +0000[diff] [blame]158<a name="profiler"></a>
159<h2>Auto Profiler</h2>
160
161<p>When the "auto profiler" is enabled, you'll see a report printed at the bottom of your pages containing a list of
162execution times for all benchmarks you have set throughout your application. This information can help you optimize your program.</p>
163
164<p class="important"><strong>Note:</strong> Even though this is a feature of the Benchmark class you will enable it from the Output class as indicated below.</p>
165
166<p>To enable the profiler place the the following function anywhere within your Controllers:</p>
167<code>$this->output->enable_profiler(TRUE);</code>
168
169<p>When enabled you'll see a table of execution times at the bottom of your pages.</p>
170
171<p>To disable the profiler you will use:</p>
172<code>$this->output->enable_profiler(FALSE);</code>
173
174<p>Important: In order to use this feature all of your marked points must end with <kbd>_start</kbd> and <kbd>_end</kbd>, and
175each pair of points must otherwise be named identically. Example:</p>
176
177<code>
178$this->benchmark->mark('my_mark<kbd>_start</kbd>');<br />
179<br />
180// Some code happens here...<br />
181<br />
182$this->benchmark->mark('my_mark<kbd>_end</kbd>');
183<br /><br />
184
185$this->benchmark->mark('another_mark<kbd>_start</kbd>');<br />
186<br />
187// Some more code happens here...<br />
188<br />
189$this->benchmark->mark('another_mark<kbd>_end</kbd>');
190
191</code>
192
193
194
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]195
196</div>
197<!-- END CONTENT -->
198
199
200<div id="footer">
201<p>
202Previous Topic:&nbsp;&nbsp;<a href="../general/alternative_php.html">Alternative PHP Syntax</a>
203&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
204<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
205<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
206Next Topic:&nbsp;&nbsp;<a href="calendar.html">Calendaring Class</a>
207<p>
208<p><a href="http://www.codeigniter.com">Code Igniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 &nbsp;&middot;&nbsp; <a href="http://www.pmachine.com">pMachine, Inc.</a></p>
209</div>
210
211</body>
212</html>