Add streaming API for tasks #2773
Open
Conversation
This file contains 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
| @@ -170,3 +180,43 @@ func (s *Server) ListTasks(ctx context.Context, request *api.ListTasksRequest) ( | |||
| Tasks: tasks, | |||
| }, nil | |||
| } | |||
|
|
|||
| // ListTasksStream is the same as ListTasks, but instead of sending back all | |||
| // tasks as one gRPC message, it brakes the messages up into chunks and sends | |||
manager/controlapi/task.go
Outdated
| // slice the first set of tasks off | ||
| var theseTasks []*api.Task | ||
| theseTasks, tasks = tasks[:maxTasksInResponse], tasks[maxTasksInResponse:] | ||
| stream.Send(&api.ListTasksResponse{Tasks: theseTasks}) |
There was a problem hiding this comment.
I guess stream.Send can return an error, shouldn't it be checked ?
manager/controlapi/task.go
Outdated
| // send, as the last message, an empty list of tasks, if we happen to have | ||
| // a number of tasks that aligns to a maxTasksInResponse size. this | ||
| // behavior is fine and expected. | ||
| stream.Send(&api.ListTasksResponse{Tasks: tasks}) |
|
Given that this changes the API; is this still a candidate for backporting to the 18.09 codebase? (maybe yes, maybe no, just leaving this here as I think of it now 😄 ) |
|
@thaJeztah: it actually doesn't change the public API of the docker engine. it changes the swarmkit API, but that API is more-or-less nonpublic, especially as far as the engine is concerned. you'll see in a bit, i'm running tests on the moby/moby branch right now before i push up that pull request. |
dperny
force-pushed
the
stream-task-list
branch
from
011e36e
to
657c0aa
Compare
As documented in moby/moby#37997, if there are too many tasks, then attempting to list them all may cause the size of the response to exceed the gRPC max message size. To avoid this case, introduct a ListTasksStream endpoint, which uses the gRPC streaming API to send tasks as a stream, avoiding exceeding the max message size. Signed-off-by: Drew Erny <drew.erny@docker.com>
dperny
force-pushed
the
stream-task-list
branch
from
657c0aa
to
102bbc2
Compare
wk8
approved these changes
Nov 3, 2018
|
ping @dperny looks like this needs a rebase |
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.
- What I did
As documented in moby/moby#37997, if there are too many tasks, then attempting to list them all may cause the size of the response to exceed the gRPC max message size.
To avoid this case, introduct a ListTasksStream endpoint, which uses the gRPC streaming API to send tasks as a stream, avoiding exceeding the max message size.
- How I did it
Adds a new RPC to the ControlAPI server called
ListTasksStream, which returns tasks as a stream instead of as one giant response.- How to test it
Includes automated test.