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.

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

Adds details about new non-blocking logging mode #1482

Merged
merged 1 commit into from
Feb 3, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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