diff options
| author | Brian Goff <cpuguy83@gmail.com> | 2020-02-07 15:55:06 -0800 |
|---|---|---|
| committer | Brian Goff <cpuguy83@gmail.com> | 2020-02-28 09:54:37 -0800 |
| commit | ce1ceeb25768cd402c662973fd1ae3caeee1ab05 (patch) | |
| tree | d3a8c6e291077f3150ff818d9ea217b795b39f67 /docs/api | |
| parent | 40b2b4b083064d56be6aeb74c04da6e4a8f73d59 (diff) | |
| download | docker-ce1ceeb25768cd402c662973fd1ae3caeee1ab05.tar.gz | |
Add stats options to not prime the stats
Metrics collectors generally don't need the daemon to prime the stats
with something to compare since they already have something to compare
with.
Before this change, the API does 2 collection cycles (which takes
roughly 2s) in order to provide comparison for CPU usage over 1s. This
was primarily added so that `docker stats --no-stream` had something to
compare against.
Really the CLI should have just made a 2nd call and done the comparison
itself rather than forcing it on all API consumers.
That ship has long sailed, though.
With this change, clients can set an option to just pull a single stat,
which is *at least* a full second faster:
Old:
```
time curl --unix-socket
/go/src/github.com/docker/docker/bundles/test-integration-shell/docker.sock
http://./containers/test/stats?stream=false\&one-shot=false > /dev/null
2>&1
real0m1.864s
user0m0.005s
sys0m0.007s
time curl --unix-socket
/go/src/github.com/docker/docker/bundles/test-integration-shell/docker.sock
http://./containers/test/stats?stream=false\&one-shot=false > /dev/null
2>&1
real0m1.173s
user0m0.010s
sys0m0.006s
```
New:
```
time curl --unix-socket
/go/src/github.com/docker/docker/bundles/test-integration-shell/docker.sock
http://./containers/test/stats?stream=false\&one-shot=true > /dev/null
2>&1
real0m0.680s
user0m0.008s
sys0m0.004s
time curl --unix-socket
/go/src/github.com/docker/docker/bundles/test-integration-shell/docker.sock
http://./containers/test/stats?stream=false\&one-shot=true > /dev/null
2>&1
real0m0.156s
user0m0.007s
sys0m0.007s
```
This fixes issues with downstreams ability to use the stats API to
collect metrics.
Signed-off-by: Brian Goff <cpuguy83@gmail.com>
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/version-history.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/api/version-history.md b/docs/api/version-history.md index 8366ac866f..8a11e4d0e2 100644 --- a/docs/api/version-history.md +++ b/docs/api/version-history.md @@ -57,6 +57,8 @@ keywords: "API, Docker, rcli, REST, documentation" service. * `GET /tasks/{id}` now includes `JobIteration` on the task if spawned from a job-mode service. +* `GET /containers/{id}/stats` now accepts a query param (`one-shot`) which, when used with `stream=false` fetches a + single set of stats instead of waiting for two collection cycles to have 2 CPU stats over a 1 second period. ## v1.40 API changes |