mirror of https://github.com/docker/cli.git
Add docs
Signed-off-by: Jamie Hannaford <jamie@limetree.org>
This commit is contained in:
parent
9c9303e113
commit
0450a2f437
|
@ -13,6 +13,12 @@ import (
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var logFn = func(expectedOut string) func(string, types.ContainerLogsOptions) (io.ReadCloser, error) {
|
||||||
|
return func(container string, opts types.ContainerLogsOptions) (io.ReadCloser, error) {
|
||||||
|
return ioutil.NopCloser(strings.NewReader(expectedOut)), nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestRunLogs(t *testing.T) {
|
func TestRunLogs(t *testing.T) {
|
||||||
inspectFn := func(containerID string) (types.ContainerJSON, error) {
|
inspectFn := func(containerID string) (types.ContainerJSON, error) {
|
||||||
return types.ContainerJSON{
|
return types.ContainerJSON{
|
||||||
|
@ -21,12 +27,6 @@ func TestRunLogs(t *testing.T) {
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
logFn := func(expectedOut string) func(string, types.ContainerLogsOptions) (io.ReadCloser, error) {
|
|
||||||
return func(container string, opts types.ContainerLogsOptions) (io.ReadCloser, error) {
|
|
||||||
return ioutil.NopCloser(strings.NewReader(expectedOut)), nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var testcases = []struct {
|
var testcases = []struct {
|
||||||
doc string
|
doc string
|
||||||
options *logsOptions
|
options *logsOptions
|
||||||
|
|
|
@ -25,6 +25,7 @@ Options:
|
||||||
-f, --follow Follow log output
|
-f, --follow Follow log output
|
||||||
--help Print usage
|
--help Print usage
|
||||||
--since string Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
|
--since string Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
|
||||||
|
--until string Show logs before timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
|
||||||
--tail string Number of lines to show from the end of the logs (default "all")
|
--tail string Number of lines to show from the end of the logs (default "all")
|
||||||
-t, --timestamps Show timestamps
|
-t, --timestamps Show timestamps
|
||||||
```
|
```
|
||||||
|
@ -66,3 +67,19 @@ that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap
|
||||||
seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a
|
seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a
|
||||||
fraction of a second no more than nine digits long. You can combine the
|
fraction of a second no more than nine digits long. You can combine the
|
||||||
`--since` option with either or both of the `--follow` or `--tail` options.
|
`--since` option with either or both of the `--follow` or `--tail` options.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Retrieve logs until a specific point in time
|
||||||
|
|
||||||
|
In order to retrieve logs before a specific point in time, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker run --name test -d busybox sh -c "while true; do $(echo date); sleep 1; done"
|
||||||
|
$ date
|
||||||
|
Tue 14 Nov 2017 16:40:00 CET
|
||||||
|
$ docker logs -f --until=2s
|
||||||
|
Tue 14 Nov 2017 16:40:00 CET
|
||||||
|
Tue 14 Nov 2017 16:40:01 CET
|
||||||
|
Tue 14 Nov 2017 16:40:02 CET
|
||||||
|
```
|
|
@ -10,8 +10,8 @@ then continue streaming new output from the container's stdout and stderr.
|
||||||
**Warning**: This command works only for the **json-file** or **journald**
|
**Warning**: This command works only for the **json-file** or **journald**
|
||||||
logging drivers.
|
logging drivers.
|
||||||
|
|
||||||
The `--since` option can be Unix timestamps, date formatted timestamps, or Go
|
The `--since` and `--until` options can be Unix timestamps, date formatted timestamps,
|
||||||
duration strings (e.g. `10m`, `1h30m`) computed relative to the client machine's
|
or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the client machine's
|
||||||
time. Supported formats for date formatted time stamps include RFC3339Nano,
|
time. Supported formats for date formatted time stamps include RFC3339Nano,
|
||||||
RFC3339, `2006-01-02T15:04:05`, `2006-01-02T15:04:05.999999999`,
|
RFC3339, `2006-01-02T15:04:05`, `2006-01-02T15:04:05.999999999`,
|
||||||
`2006-01-02Z07:00`, and `2006-01-02`. The local timezone on the client will be
|
`2006-01-02Z07:00`, and `2006-01-02`. The local timezone on the client will be
|
||||||
|
@ -20,9 +20,21 @@ end of the timestamp. When providing Unix timestamps enter
|
||||||
seconds[.nanoseconds], where seconds is the number of seconds that have elapsed
|
seconds[.nanoseconds], where seconds is the number of seconds that have elapsed
|
||||||
since January 1, 1970 (midnight UTC/GMT), not counting leap seconds (aka Unix
|
since January 1, 1970 (midnight UTC/GMT), not counting leap seconds (aka Unix
|
||||||
epoch or Unix time), and the optional .nanoseconds field is a fraction of a
|
epoch or Unix time), and the optional .nanoseconds field is a fraction of a
|
||||||
second no more than nine digits long. You can combine the `--since` option with
|
second no more than nine digits long. You can combine the `--since` or `--until`
|
||||||
either or both of the `--follow` or `--tail` options.
|
options with either or both of the `--follow` or `--tail` options.
|
||||||
|
|
||||||
The `docker container logs --details` command will add on extra attributes, such as
|
The `docker container logs --details` command will add on extra attributes, such as
|
||||||
environment variables and labels, provided to `--log-opt` when creating the
|
environment variables and labels, provided to `--log-opt` when creating the
|
||||||
container.
|
container.
|
||||||
|
|
||||||
|
In order to retrieve logs before a specific point in time, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker run --name test -d busybox sh -c "while true; do $(echo date); sleep 1; done"
|
||||||
|
$ date
|
||||||
|
Tue 14 Nov 2017 16:40:00 CET
|
||||||
|
$ docker logs -f --until=2s
|
||||||
|
Tue 14 Nov 2017 16:40:00 CET
|
||||||
|
Tue 14 Nov 2017 16:40:01 CET
|
||||||
|
Tue 14 Nov 2017 16:40:02 CET
|
||||||
|
```
|
Loading…
Reference in New Issue