docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Make the specification of max-buffer-size discoverable. (#20562) 

* Make the specification of max-buffer-size discoverable.

It's not obvious what type of strings are accepted by `max-buffer-size` nor is it obvious what e.g. `4m` means. Four _minutes_? (to me, it looks like something accepted by [ParseDuration](https://pkg.go.dev/time#ParseDuration).

Instead we should direct users to the relevant documentation to explain clearly what's allowed and what the units are.

* Update configure.md
This commit is contained in:
Antony Southworth 2024-08-14 19:54:08 +12:00 committed by GitHub
parent fd2dbcf9b4
commit ebfe67a54a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
content/engine/logging/configure.md
View File

@ -150,9 +150,11 @@ STDERR or STDOUT streams block.
The `mode` log option controls whether to use the `blocking` (default) or
`non-blocking` message delivery.
The `max-buffer-size` log option controls the size of the buffer used for
intermediate message storage when `mode` is set to `non-blocking`. `max-buffer-size`
defaults to 1 megabyte.
The `max-buffer-size` controls the size of the buffer used for
intermediate message storage when `mode` is set to `non-blocking`.
The default is `1m` meaning 1 MB (1 million bytes).
See [function `FromHumanSize()` in the `go-units` package](https://pkg.go.dev/github.com/docker/go-units#FromHumanSize) for the allowed format strings,
some examples are `1KiB` for 1024 bytes, `2g` for 2 billion bytes.
The following example starts an Alpine container with log output in non-blocking
mode and a 4 megabyte buffer: