From ee71c80dd20bcfc60169af3eb1f628229ca30d67 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 10 Mar 2010 10:05:05 -0600 Subject: added ability to enable/disable individual sections of the Profiler --- user_guide/general/profiling.html | 90 +++++++++++++++++++++++++++++++++++---- 1 file changed, 81 insertions(+), 9 deletions(-) (limited to 'user_guide/general') diff --git a/user_guide/general/profiling.html b/user_guide/general/profiling.html index ec71278b1..8622edeb9 100644 --- a/user_guide/general/profiling.html +++ b/user_guide/general/profiling.html @@ -69,20 +69,92 @@ This information can be useful during development in order to help with debuggin

Enabling the Profiler

-

To enable the profiler place the following function anywhere within your Controller functions:

-$this->output->enable_profiler(TRUE); +

To enable the profiler place the following function anywhere within your Controller functions:

+ $this->output->enable_profiler(TRUE); -

When enabled a report will be generated and inserted at the bottom of your pages.

+

When enabled a report will be generated and inserted at the bottom of your pages.

-

To disable the profiler you will use:

-$this->output->enable_profiler(FALSE); +

To disable the profiler you will use:

+ $this->output->enable_profiler(FALSE); -

Setting Benchmark Points

- -

In order for the Profiler to compile and display your benchmark data you must name your mark points using specific syntax.

-

Please read the information on setting Benchmark points in Benchmark Class page.

+

Setting Benchmark Points

+

In order for the Profiler to compile and display your benchmark data you must name your mark points using specific syntax.

+ +

Please read the information on setting Benchmark points in Benchmark Class page.

+ + +

Enabling and Disabling Profiler Sections

+ +

Each section of Profiler data can be enabled or disabled by setting a corresponding config variable to TRUE or FALSE. This can be done one of two ways. First, you can set application wide defaults with the system/application/config/profiler.php config file.

+ + $config['config']          = FALSE;
+ $config['queries']         = FALSE;
 + +

In your controllers, you can override the defaults and config file values by calling the set_profiler_sections() method of the Output class:

+ + $sections = array(
+     'config'  => TRUE,
+     'queries' => TRUE
+     );
+
+ $this->output->set_profiler_sections($sections); + +

Available sections and the array key used to access them are described in the table below.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyDescriptionDefault
benchmarksElapsed time of Benchmark points and total execution timeTRUE
configCodeIgniter Config variablesTRUE
controller_infoThe Controller class and method requestedTRUE
getAny GET data passed in the requestTRUE
http_headersThe HTTP headers for the current requestTRUE
memory_usageAmount of memory consumed by the current request, in bytesTRUE
postAny POST data passed in the requestTRUE
queriesListing of all database queries executed, including execution timeTRUE
uri_stringThe URI of the current requestTRUE
-- cgit v1.2.3-24-g4f1b