Skip to content

Commit

Permalink
Adds details about new non-blocking logging mode
Browse files Browse the repository at this point in the history
This functionality was added in moby/moby#28762.
It allows a user to specify what to do in cases when a log message can't
be sent, block the container's stdio or drop messages.

Also removes an erronious entry about a `nats` log driver, which does
not exist.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
  • Loading branch information
cpuguy83 committed Feb 2, 2017
1 parent fa26b7a commit cc5f378
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 89 deletions.
88 changes: 0 additions & 88 deletions engine/admin/logging/nats.md

This file was deleted.

8 changes: 7 additions & 1 deletion engine/admin/logging/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ for its configurable options, if applicable.
| `splunk` | Writes log messages to `splunk` using the HTTP Event Collector.|
| `etwlogs` | Writes log messages as Event Tracing for Windows (ETW) events. Only available on Windows platforms. |
| `gcplogs` | Writes log messages to Google Cloud Platform (GCP) Logging. |
| `nats` | NATS logging driver for Docker. Publishes log entries to a NATS server.|

## Limitations of logging drivers

Expand Down Expand Up @@ -124,6 +123,13 @@ This example starts an `alpine` container with the `none` log driver.
$ docker run -it --log-driver none alpine ash
```

### Options for all drivers
| Option | Description | Example value |
|-------------------|-------------|---------------|
| `mode` | Sets the logging mode, accepted values are `blocking` (default), and `non-blocking`. When `non-blocking` is set, if the log buffer fills up, log messages will be lost. How messages are dropped is left undefined. | `--log-opt mode=non-blocking`
| `max-buffer-size` | Applicable only when `mode` is set to `non-blocking`, this sets the maxmimum size of the log buffer. Once this size is reach, log messages will be dropped. | `--log-opt max-buffer-size 5m`


## `json-file`

`json-file` is the default logging driver, and returns logging output in JSON
Expand Down

0 comments on commit cc5f378

Please sign in to comment.