docs: add info for events backlog and scope#1999
Merged
thaJeztah merged 1 commit intodocker:masterfrom Jul 11, 2019
Merged
Conversation
1. Adds `docker events` description info on the two scope types of events. 2. Adds `docker events` note in two places about backlog limit of event log. Further info and background info in Issue 727 Signed-off-by: Bret Fisher <bret@bretfisher.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Member
Author
|
This was already reviewed; I'll merge once CI finishes |
Codecov Report
@@ Coverage Diff @@
## master #1999 +/- ##
=======================================
Coverage 56.78% 56.78%
=======================================
Files 311 311
Lines 21832 21832
=======================================
Hits 12398 12398
Misses 8519 8519
Partials 915 915 |
Member
Author
|
All green 🎉
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
carries #809
closes #809
Fixes #727
- What I did
docker eventsdescription info on the two scope types of events.docker eventsnote in two places about backlog limit of event log.- How I did it
After testing and using the events feature and discovering these undocumented things, I edited some markdown lines with my bare hands :)
- How to verify it
Like @joaofnfernandes mentioned in docker/docs#5432 (comment) we may need @cpuguy83 and/or @thaJeztah to validate the 1000 message buffer limit.
- Description for the changelog
Added documentation on docker events scope and buffer limits.
- A picture of a cute animal (not mandatory but encouraged)
Signed-off-by: Bret Fisher bret@bretfisher.com