diff options
| author | Joffrey F <joffrey@docker.com> | 2015-02-12 13:15:59 -0800 |
|---|---|---|
| committer | Joffrey F <joffrey@docker.com> | 2015-02-12 13:15:59 -0800 |
| commit | 1a7e3a2d6d8ed36c00fa7333d6a5a7b15f51288e (patch) | |
| tree | c32d27c7e058e8e7ee277690ae4760277b9e4a3f /docs | |
| parent | 1565464ff052c0a7cb25c32a0500eb9137515b13 (diff) | |
| parent | c50795a08abdac3f8dfded9bd32f38d137d36e13 (diff) | |
| download | docker-py-1a7e3a2d6d8ed36c00fa7333d6a5a7b15f51288e.tar.gz | |
Merge branch 'add-stats-api-support' of https://github.com/nir0s/docker-py into nir0s-add-stats-api-support
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.md | 21 | ||||
| -rw-r--r-- | docs/change_log.md | 8 |
2 files changed, 29 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md index b07cbfa..a523878 100644 --- a/docs/api.md +++ b/docs/api.md @@ -708,6 +708,27 @@ from. Optionally a single string joining container id's with commas None ``` +## stats + +The Docker API parallel to the `docker stats` command. +This will stream statistics for a specific container. + +**Params**: + +* container (str): The container to start + +```python +>>> from docker import Client +>>> cli = Client(base_url='tcp://127.0.0.1:2375') +>>> stats_obj = cli.stats('elasticsearch') +>>> for stat in stats: +>>> print(stat) +{"read":"2015-02-11T21:47:30.49388286+02:00","network":{"rx_bytes":666052,"rx_packets":4409 ... +... +... +... +``` + ## stop Stops a container. Similar to the `docker stop` command. diff --git a/docs/change_log.md b/docs/change_log.md index d2e8cd7..ccfa49b 100644 --- a/docs/change_log.md +++ b/docs/change_log.md @@ -1,6 +1,14 @@ Change Log ========== +0.7.3 +----- + +### Features + +* Added support for `stats` API. + + 0.7.2 ----- |