docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fixed docs

This commit is contained in:
nir0s 2015-02-12 09:49:45 +02:00
parent 52702f7da0
commit bbc2121951
1 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api.md
View File

@ -669,9 +669,6 @@ None
The Docker API parallel to the `docker stats` command. The Docker API parallel to the `docker stats` command.
This will stream statistics for a specific container. This will stream statistics for a specific container.
`aggregate`, if 0 will return an iterable stream object of messages.
If aggregate is above 0, an iterable stream object of a list of messages in the size of `aggregate` will be returned.
**Params**: **Params**:
* container (str): The container to start * container (str): The container to start
@ -679,12 +676,11 @@ If aggregate is above 0, an iterable stream object of a list of messages in the
```python ```python
>>> from docker import Client >>> from docker import Client
>>> aggregate = 10
>>> cli = Client(base_url='tcp://127.0.0.1:2375') >>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> stats_obj = cli.stats('elasticsearch', aggregate=aggregate) >>> stats_obj = cli.stats('elasticsearch')
>>> for stat in stats: >>> for stat in stats:
>>> print(stat) >>> print(stat)
['{"read":"2015-02-11T21:47:30.49388286+02:00","network":{"rx_bytes":666052,"rx_packets":4409 ... {"read":"2015-02-11T21:47:30.49388286+02:00","network":{"rx_bytes":666052,"rx_packets":4409 ...
... ...
... ...
... ...