Download the PHP package popphp/pop-log without Composer
On this page you can find all versions of the php package popphp/pop-log. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package pop-log
pop-log
- Overview
- Install
- Quickstart
- Writers
- File
- Database
- HTTP
- Context
- Limits
Overview
pop-log
is a logging component that provides a way of logging events following the standard
BSD syslog protocol outlined in RFC-3164. Support is built-in for writing log messages
to a file or database table or deploying them via email or HTTP. The eight available log message
severity values are:
- EMERG (0)
- ALERT (1)
- CRIT (2)
- ERR (3)
- WARN (4)
- NOTICE (5)
- INFO (6)
- DEBUG (7)
and are available via their respective methods:
- $log->emergency($message);
- $log->alert($message);
- $log->critical($message);
- $log->error($message);
- $log->warning($message);
- $log->notice($message);
- $log->info($message);
- $log->debug($message);
pop-log
is a component of the Pop PHP Framework.
Top
Install
Install pop-log
using Composer.
composer require popphp/pop-log
Or, require it in your composer.json file
"require": {
"popphp/pop-log" : "^4.0.0"
}
Top
Quickstart
This is a basic example using the file writer:
Then, your 'app.log' file will contain:
Top
Writers
There are four available log writers, but others can be created if they implement the
Pop\Log\Writer\WriterInterface
.
File
The file log writer simply stores the log output to a log file on disk. The log file format is derived from the log filename. Supported log file types include:
- Plain text (
.log
or.txt
) - CSV (
.csv
) - TSV (
.tsv
) - XML (
.xml
) - JSON (
.json
)
The above code creates a CSV file with the log entry:
Top
The mail log writer sends the log entries via email using the popphp/pop-mail
component.
The constructor requires a Pop\Mail\Mailer
object and at least one email as the second
argument. An optional third argument allows you to pass in additional email headers, like
a subject and CC addresses.
Then the emails listed above will receive a series of emails like this:
Top
Database
Writing a log to a table in a database requires the popphp/pop-db
component.
The database writer constructor takes an instance of Pop\Db\Adapter\AbstractAdapter
and also an optional $table
argument (the default table name is pop_log
).
In this case, the logs are written to a database table that has the columns
id
, timestamp
, level
, name
and message
. So, after the example above,
your database table would look like this:
Id | Timestamp | Level | Name | Message |
---|---|---|---|---|
1 | 2015-07-11 12:32:32 | 6 | INFO | Just a info message |
2 | 2015-07-11 12:32:33 | 1 | ALERT | Look Out! Something serious happened! |
Top
HTTP
Using the HTTP writer requires the pop-http
component. It creates a request and sends
it to the HTTP logging resource. (Refer to the pop-http
documentation for more information
on how to use the HTTP client.)
The log writer will send HTTP requests with the log data to the HTTP service with the following HTTP data fields:
timestamp
level
name
message
context
Top
Context
For additional contextual information, the $context
array can be passed to the methods
called to trigger the log entry. It can contain:
Top
Limits
Log level limits can be set for the log writer objects to enforce the severity of which log messages actually get logged:
The app_prod.log
file will contain:
And the app_dev.log
file will contain: