Zend_Log | Zend_Log Programmer's Reference Guide | Writers

# Overview

Zend_Log is a component for general purpose logging. It supports multiple log backends, formatting messages sent to the log, and filtering messages from being logged. These functions are divided into the following objects:

- A Log (instance of Zend_Log) is the object that your application uses the most. You can have as many Log objects as you like; they do not interact. A Log object must contain at least one Writer, and can optionally contain one or more Filters.

- A Writer (inherits from Zend_Log_Writer_Abstract) is responsible for saving data to storage.

- A Filter (implements Zend_Log_Filter_Interface) blocks log data from being saved. A filter may be applied to an individual Writer, or to a Log where it is applied before all Writers. In either case, filters may be chained.

- A Formatter (implements Zend_Log_Formatter_Interface) can format the log data before it is written by a Writer. Each Writer has exactly one Formatter.

# Creating a Log

To get started logging, instantiate a Writer and then pass it to a Log instance:

1. $logger = new Zend_Log();
2. $writer = new Zend_Log_Writer_Stream('php://output');
4. $logger->addWriter($writer);

It is important to note that the Log must have at least one Writer. You can add any number of Writers using the Log's addWriter() method.

Alternatively, you can pass a Writer directly to constructor of Log as a shortcut:

1. $writer = new Zend_Log_Writer_Stream('php://output');
2. $logger = new Zend_Log($writer);

The Log is now ready to use.

# Logging Messages

To log a message, call the log() method of a Log instance and pass it the message with a corresponding priority:

1. $logger->log('Informational message', Zend_Log::INFO);

The first parameter of the log() method is a string `message` and the second parameter is an integer `priority`. The priority must be one of the priorities recognized by the Log instance. This is explained in the next section.

A shortcut is also available. Instead of calling the log() method, you can call a method by the same name as the priority:

1. $logger->log('Informational message', Zend_Log::INFO);
2. $logger->info('Informational message');
4. $logger->log('Emergency message', Zend_Log::EMERG);
5. $logger->emerg('Emergency message');

# Destroying a Log

If the Log object is no longer needed, set the variable containing it to `NULL` to destroy it. This will automatically call the shutdown() instance method of each attached Writer before the Log object is destroyed:

1. $logger = null;

Explicitly destroying the log in this way is optional and is performed automatically at PHP shutdown.

# Using Built-in Priorities

The Zend_Log class defines the following priorities:

1. EMERG = 0; // Emergency: system is unusable
2. ALERT = 1; // Alert: action must be taken immediately
3. CRIT = 2; // Critical: critical conditions
4. ERR = 3; // Error: error conditions
5. WARN = 4; // Warning: warning conditions
6. NOTICE = 5; // Notice: normal but significant condition
7. INFO = 6; // Informational: informational messages
8. DEBUG = 7; // Debug: debug messages

These priorities are always available, and a convenience method of the same name is available for each one.

The priorities are not arbitrary. They come from the BSD `syslog` protocol, which is described in » RFC-3164. The names and corresponding priority numbers are also compatible with another PHP logging system, » PEAR Log, which perhaps promotes interoperability between it and Zend_Log.

Priority numbers descend in order of importance. `EMERG` (0) is the most important priority. `DEBUG` (7) is the least important priority of the built-in priorities. You may define priorities of lower importance than `DEBUG`. When selecting the priority for your log message, be aware of this priority hierarchy and choose appropriately.

# Adding User-defined Priorities

User-defined priorities can be added at runtime using the Log's addPriority() method:

1. $logger->addPriority('FOO', 8);

The snippet above creates a new priority, `FOO`, whose value is `8`. The new priority is then available for logging:

1. $logger->log('Foo message', 8);
2. $logger->foo('Foo Message');

New priorities cannot overwrite existing ones.

# Understanding Log Events

When you call the log() method or one of its shortcuts, a log event is created. This is simply an associative array with data describing the event that is passed to the writers. The following keys are always created in this array: `timestamp`, `message`, `priority`, and `priorityName`.

The creation of the `event` array is completely transparent. However, knowledge of the `event` array is required for adding an item that does not exist in the default set above.

To add a new item to every future event, call the setEventItem() method giving a key and a value:

1. $logger->setEventItem('pid', getmypid ());

The example above sets a new item named `pid` and populates it with the PID of the current process. Once a new item has been set, it is available automatically to all writers along with all of the other data event data during logging. An item can be overwritten at any time by calling the setEventItem() method again.

Setting a new event item with setEventItem() causes the new item to be sent to all writers of the logger. However, this does not guarantee that the writers actually record the item. This is because the writers won't know what to do with it unless a formatter object is informed of the new item. Please see the section on Formatters to learn more.

# Log PHP Errors

Zend_Log can also be used to log PHP errors. Calling registerErrorHandler() will add Zend_Log before the current error handler, and will pass the error along as well.

Zend_Log events from PHP errors have the additional fields matching handler ( int $errno , string $errstr [, string $errfile [, int $errline [, array $errcontext ]]] ) from » set_error_handler
Name | Error Handler Paramater | Description
--- | --- | ---
message | errstr | Contains the error message, as a string.
errno | errno | Contains the level of the error raised, as an integer.
file | errfile | Contains the filename that the error was raised in, as a string.
line | errline | Contains the line number the error was raised at, as an integer.
context | errcontext | (optional) An array that points to the active symbol table at the point the error occurred. In other words, errcontext will contain an array of every variable that existed in the scope the error was triggered in. User error handler must not modify error context.

Zend_Log | Zend_Log Programmer's Reference Guide | Writers