Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to transport documentation #262

Merged
merged 2 commits into from
Sep 30, 2014
Merged

Updates to transport documentation #262

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9aaf5eb
Added documentation for the DailyRotateFile transport
dtex May 30, 2013
6296bcb
Minor change. Just updating the number of options for Console.
dtex May 30, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion docs/transports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ There are several [core transports](#winston-core) included in `winston`, which
* **[Winston Core](#winston-core)**
* [Console](#console-transport)
* [File](#file-transport)
* [DailyRotateFile](#dailyrotatefile-transport)
* [Http](#http-transport)
* [Webhook](#webhook-transport)

Expand All @@ -29,6 +30,7 @@ There are several core transports included in `winston`, which leverage the buil

* [Console](#console-transport)
* [File](#file-transport)
* [DailyRotateFile](#dailyrotatefile-transport)
* [Http](#http-transport)
* [Webhook](#webhook-transport)

Expand All @@ -38,7 +40,7 @@ There are several core transports included in `winston`, which leverage the buil
winston.add(winston.transports.Console, options)
```

The Console transport takes two simple options:
The Console transport takes four simple options:

* __level:__ Level of messages that this transport should log (default 'debug').
* __silent:__ Boolean flag indicating whether to suppress output (default false).
Expand Down Expand Up @@ -67,6 +69,31 @@ The File transport should really be the 'Stream' transport since it will accept

*Metadata:* Logged via util.inspect(meta);

### DailyRotateFile Transport

``` js
winston.add(winston.transports.DailyRotateFile, options)
```

The DailyRotateFile transport can rotate files by minute, hour, day, month or year. Its options are identical to the File transport with the lone addition of the 'datePattern' option:

* __datePattern:__ A string representing the pattern to be used when appending the date to the filename (default '.yyyy-MM-dd'). The meta characters used in this string will dictate the frequency of the file rotation. For example if your datePattern is simply '.HH' you will end up with 24 log files that are picked up and appended to every day.

Valid meta characters in the datePattern are:

* __yy:__ Last two digits of the year.
* __yyyy:__ Full year.
* __M:__ The month.
* __MM:__ The zero padded month.
* __d:__ The day.
* __dd:__ The zero padded day.
* __H:__ The hour.
* __HH:__ The zero padded hour.
* __m:__ The minute.
* __mm:__ The zero padded minute.

*Metadata:* Logged via util.inspect(meta);

### Http Transport

``` js
Expand Down