Skip to content

Commit

Permalink
Adding documentation for the Profiler logging and timers.
Browse files Browse the repository at this point in the history
Simple as that :)
  • Loading branch information
JesseObrien committed Jan 3, 2013
1 parent 742eb4e commit 4d6827c
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
1 change: 1 addition & 0 deletions laravel/documentation/contents.md
Expand Up @@ -65,6 +65,7 @@
- [Upgrading Bundles](/docs/bundles#upgrading-bundles)
- [Class Auto Loading](/docs/loading)
- [Errors & Logging](/docs/logging)
- [Profiler](/docs/profiler)
- [Runtime Configuration](/docs/config)
- [Examining Requests](/docs/requests)
- [Generating URLs](/docs/urls)
Expand Down
38 changes: 38 additions & 0 deletions laravel/documentation/profiler.md
@@ -0,0 +1,38 @@
# Profiler

## Contents
- [Logging to the Proiler](#logging)
- [Timers and Benchmarking](#timers)

<a name="logging"></a>
## Logging

It is possible to use the profiler to the Log viewing portion of the profiler. Throughout your application you can call the logger and have it displayed when the profiler is rendered.

#### Logging to the profiler:

Profiler::log('info', 'Log some information to the profiler');

<a name="timers"></a>
## Timers

Timing and benchmarking your app is simple with the ```tick()``` function on the profiler. It allows you to set various different timers in your app and will show you their performance when your app ends execution.

Each timer can have it's own individual name which gives it a timeline. Every timer with the same name is another 'tick' on that timeline. Each timer can also execute a callback on it to perform other operations.

#### Using the generic timer timeline

Profiler::tick();
Profiler::tick();

#### Using multiple named timers with seperate timelines

Profiler::tick('myTimer');
Profiler::tick('nextTimer');
Profiler::tick('myTimer');
Profiler::tick('nextTimer');

#### Using a named timer with a callback
Profiler::tick('myTimer', function($timers) {
echo "I'm inside the timer callback!";
});

0 comments on commit 4d6827c

Please sign in to comment.