Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 62 lines (39 sloc) 3.349 kB
2ff85ba @Seldaek Added README file
authored
1 Monolog - Logging for PHP 5.3
2 =============================
3
4 Usage
5 -----
6
7 use Monolog\Logger;
20110bf @Seldaek Updated README
authored
8 use Monolog\Handler\StreamHandler;
2ff85ba @Seldaek Added README file
authored
9
3fa6e4b @Seldaek Major refactoring to follow the Logbook model
authored
10 // create a log channel
11 $log = new Logger('name');
20110bf @Seldaek Updated README
authored
12 $log->pushHandler(new StreamHandler('path/to/your.log', Logger::WARNING));
2ff85ba @Seldaek Added README file
authored
13
6c24217 @Seldaek Renamed message to record
authored
14 // add records to the log
3fa6e4b @Seldaek Major refactoring to follow the Logbook model
authored
15 $log->addWarning('Foo');
16 $log->addError('Bar');
2ff85ba @Seldaek Added README file
authored
17
8d27400 @Seldaek Updated README
authored
18 Core Concepts
19 -------------
20
6c24217 @Seldaek Renamed message to record
authored
21 Every Logger instance has a channel (name) and a stack of handlers. Whenever you add a record to the logger, it traverses the handler stack. Each handler decides whether it handled fully the record, and if so, the propagation of the record ends there.
8d27400 @Seldaek Updated README
authored
22
6c24217 @Seldaek Renamed message to record
authored
23 This allow for flexible logging setups, for example having a FileHandler at the bottom of the stack that will log anything to disk, and on top of that add a MailHandler that will send emails only when an error message is logged. Handlers also have a bubbling property which define whether they block the record or not if they handled it. In this example, setting the MailHandler's $bubble argument to true means that all records will propagate to the FileHandler, even the errors that are handled by the MailHandler.
8d27400 @Seldaek Updated README
authored
24
6c24217 @Seldaek Renamed message to record
authored
25 You can create many Loggers, each defining a channel (e.g.: db, request, router, ..) and each of them combining various handlers, which can be shared or not. The channel is reflected in the logs and allows you to easily see or filter records.
8d27400 @Seldaek Updated README
authored
26
6c24217 @Seldaek Renamed message to record
authored
27 Each Handler also has a Formatter, a default one with settings that make sense will be created if you don't set one. The formatters normalize and format incoming records so that they can be used by the handlers to output useful information.
81c6cd3 @Seldaek Added note about formatters
authored
28
6c24217 @Seldaek Renamed message to record
authored
29 Custom severity levels are not available. Only four levels (debug, info, warning, error) are present for basic filtering purposes, but for sorting and other use cases that would require flexibility, you should add Processors to the Logger that can add extra information (tags, user ip, ..) to the records before they are handled.
8d27400 @Seldaek Updated README
authored
30
31 Notable Features (non-exhaustive and incomplete)
32 ------------------------------------------------
33
6c24217 @Seldaek Renamed message to record
authored
34 - _FingersCrossedHandler_: A very interesting handler. It takes a logger as parameter and will accumulate log records of all levels until a record exceeds the defined severity level. At which point it delivers all records, including those of lower severity, to the handler it wraps. This means that until an error actually happens you will not see anything in your logs, but when it happens you will have the full information, including debug and info records. This provides you with the info you need, only when you need it.
031a394 @ericclemmons Updated the README with a note about FirePHPHandler
ericclemmons authored
35 - _FirePHPHandler_: Handler for [FirePHP](http://www.firephp.org/), providing inline `console` messages within [FireBug](http://getfirebug.com/).
8d27400 @Seldaek Updated README
authored
36
2ff85ba @Seldaek Added README file
authored
37 Todo
38 ----
39
8d27400 @Seldaek Updated README
authored
40 - MailHandler
2ff85ba @Seldaek Added README file
authored
41
8d27400 @Seldaek Updated README
authored
42 Requirements
43 ------------
44
45 Any flavor of PHP 5.3 should do
46
2ff85ba @Seldaek Added README file
authored
47 Author
48 ------
49
7f2127b @Seldaek Updated README
authored
50 Jordi Boggiano - <j.boggiano@seld.be> - <http://twitter.com/seldaek><br />
20110bf @Seldaek Updated README
authored
51 See also the list of [contributors](https://github.com/Seldaek/monolog/contributors) which participated in this project.
2ff85ba @Seldaek Added README file
authored
52
53 License
54 -------
55
a30c1d6 @Seldaek Fix license info
authored
56 Monolog is licensed under the MIT License - see the LICENSE file for details
2ff85ba @Seldaek Added README file
authored
57
3fa6e4b @Seldaek Major refactoring to follow the Logbook model
authored
58 Acknowledgements
59 ----------------
60
8d27400 @Seldaek Updated README
authored
61 This library is heavily inspired by Python's [Logbook](http://packages.python.org/Logbook/) library, although most concepts have been adjusted to fit in the PHP world.
Something went wrong with that request. Please try again.