Skip to content

Commit 722d421

Browse files
committed
Docs tweaks
1 parent a0b984a commit 722d421

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

Diff for: README.mdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Monolog - Logging for PHP 5.3+ [![Build Status](https://secure.travis-ci.org/Seldaek/monolog.png)](http://travis-ci.org/Seldaek/monolog)
1+
# Monolog - Logging for PHP [![Build Status](https://img.shields.io/travis/Seldaek/monolog.svg)](https://travis-ci.org/Seldaek/monolog)
22

3-
[![Total Downloads](https://poser.pugx.org/monolog/monolog/downloads.png)](https://packagist.org/packages/monolog/monolog)
4-
[![Latest Stable Version](https://poser.pugx.org/monolog/monolog/v/stable.png)](https://packagist.org/packages/monolog/monolog)
3+
[![Total Downloads](https://img.shields.io/packagist/dt/monolog/monolog.svg)](https://packagist.org/packages/monolog/monolog)
4+
[![Latest Stable Version](https://img.shields.io/packagist/v/monolog/monolog.svg)](https://packagist.org/packages/monolog/monolog)
55
[![Reference Status](https://www.versioneye.com/php/monolog:monolog/reference_badge.svg)](https://www.versioneye.com/php/monolog:monolog/references)
66

77

Diff for: doc/02-handlers-formatters-processors.md

+16-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
# Handlers, Formatters and Processors
22

33
- [Handlers](#handlers)
4+
- [Log to files and syslog](#log-to-files-and-syslog)
5+
- [Send alerts and emails](#send-alerts-and-emails)
6+
- [Log specific servers and networked logging](#log-specific-servers-and-networked-logging)
7+
- [Logging in development](#logging-in-development)
8+
- [Log to databases](#log-to-databases)
9+
- [Wrappers / Special Handlers](#wrappers--special-handlers)
410
- [Formatters](#formatters)
511
- [Processors](#processors)
612
- [Third Party Packages](#third-party-packages)
713

8-
# Handlers
14+
## Handlers
915

10-
## Log to files and syslog
16+
### Log to files and syslog
1117

1218
- _StreamHandler_: Logs records into any PHP stream, use this for log files.
1319
- _RotatingFileHandler_: Logs records to a file and creates one logfile per day.
@@ -18,7 +24,7 @@
1824
- _ErrorLogHandler_: Logs records to PHP's
1925
[`error_log()`](http://docs.php.net/manual/en/function.error-log.php) function.
2026

21-
## Send alerts and emails
27+
### Send alerts and emails
2228

2329
- _NativeMailerHandler_: Sends emails using PHP's
2430
[`mail()`](http://php.net/manual/en/function.mail.php) function.
@@ -30,7 +36,7 @@
3036
- _MandrillHandler_: Sends emails via the Mandrill API using a [`Swift_Message`](http://swiftmailer.org/) instance.
3137
- _FleepHookHandler_: Logs records to a [Fleep](https://fleep.io/) conversation using Webhooks.
3238

33-
## Log specific servers and networked logging
39+
### Log specific servers and networked logging
3440

3541
- _SocketHandler_: Logs records to [sockets](http://php.net/fsockopen), use this
3642
for UNIX and TCP sockets. See an [example](doc/sockets.md).
@@ -47,7 +53,7 @@
4753
- _SyslogUdpHandler_: Logs records to a remote [Syslogd](http://www.rsyslog.com/) server.
4854
- _LogEntriesHandler_: Logs records to a [LogEntries](http://logentries.com/) account.
4955

50-
## Logging in development
56+
### Logging in development
5157

5258
- _FirePHPHandler_: Handler for [FirePHP](http://www.firephp.org/), providing
5359
inline `console` messages within [FireBug](http://getfirebug.com/).
@@ -58,7 +64,7 @@
5864
- _PHPConsoleHandler_: Handler for [PHP Console](https://chrome.google.com/webstore/detail/php-console/nfhmhhlpfleoednkpnnnkolmclajemef), providing
5965
inline `console` and notification popup messages within Chrome.
6066

61-
## Log to databases
67+
### Log to databases
6268

6369
- _RedisHandler_: Logs records to a [redis](http://redis.io) server.
6470
- _MongoDBHandler_: Handler to write records in MongoDB via a
@@ -68,7 +74,7 @@
6874
- _ElasticSearchHandler_: Logs records to an Elastic Search server.
6975
- _DynamoDbHandler_: Logs records to a DynamoDB table with the [AWS SDK](https://github.com/aws/aws-sdk-php).
7076

71-
## Wrappers / Special Handlers
77+
### Wrappers / Special Handlers
7278

7379
- _FingersCrossedHandler_: A very interesting wrapper. It takes a logger as
7480
parameter and will accumulate log records of all levels until a record
@@ -99,7 +105,7 @@
99105
- _TestHandler_: Used for testing, it records everything that is sent to it and
100106
has accessors to read out the information.
101107

102-
# Formatters
108+
## Formatters
103109

104110
- _LineFormatter_: Formats a log record into a one-line string.
105111
- _HtmlFormatter_: Used to format log records into a human readable html table, mainly suitable for emails.
@@ -115,7 +121,7 @@
115121
- _FlowdockFormatter_: Used to format log records into Flowdock messages, only useful for the FlowdockHandler.
116122
- _MongoDBFormatter_: Converts \DateTime instances to \MongoDate and objects recursively to arrays, only useful with the MongoDBHandler.
117123

118-
# Processors
124+
## Processors
119125

120126
- _IntrospectionProcessor_: Adds the line/file/class/method from which the log call originated.
121127
- _WebProcessor_: Adds the current request URI, request method and client IP to a log record.
@@ -126,7 +132,7 @@
126132
- _GitProcessor_: Adds the current git branch and commit to a log record.
127133
- _TagProcessor_: Adds an array of predefined tags to a log record.
128134

129-
# Third Party Packages
135+
## Third Party Packages
130136

131137
Third party handlers, formatters and processors are
132138
[listed in the wiki](https://github.com/Seldaek/monolog/wiki/Third-Party-Packages). You

0 commit comments

Comments
 (0)