Add max-size, max-file logging options documentation #3243
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@tgjamin thanks! LGTM Ping, @shin- @dnephin @nathanleclaire @thaJeztah for a second look, then we can merge it. |
|
@tgjamin LGTM, I'm going to merge this and make a few minor copyedits after. Thanks much! |
thaJeztah
reviewed
May 15, 2017
| @@ -764,6 +764,27 @@ Logging options are key-value pairs. An example of `syslog` options: | |||
| options: | |||
| syslog-address: "tcp://192.168.0.42:123" | |||
|
|
|||
| To limit the amount of logs stored there are two options key-value pairs: | |||
There was a problem hiding this comment.
We should be careful documenting this as-is, because these options depend on the logging driver that's in use. For example, max-file and max-size are only used for the default (json-file) logging driver.
I do think this information is useful but;
- we should point out that these options are specific to that driver
- more clearly mention that these options differ per driver, and refer to https://docs.docker.com/engine/admin/logging/overview/ - I see it's being referred to above as well
|
@thaJeztah thanks, I'll create another PR with these notes, and maybe you and @tgjamin can review and / or add to it as appropriate |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Add documentation for logging options max-size and max-file that were previously undocumented. Formatting was checked locally with docker-compose build.
Related issues (optional)
Fixes: #3178