2014-04-16 14:07:55 -04:00
|
|
|
% DOCKER(1) Docker User Manuals
|
2014-06-30 22:58:04 -04:00
|
|
|
% Docker Community
|
|
|
|
% JUNE 2014
|
2014-04-16 14:07:55 -04:00
|
|
|
# NAME
|
|
|
|
docker-logs - Fetch the logs of a container
|
|
|
|
|
|
|
|
# SYNOPSIS
|
2014-06-30 22:58:04 -04:00
|
|
|
**docker logs**
|
2015-12-23 09:37:06 -05:00
|
|
|
[**-f**|**--follow**]
|
2014-10-15 17:14:12 -04:00
|
|
|
[**--help**]
|
2015-04-14 00:36:12 -04:00
|
|
|
[**--since**[=*SINCE*]]
|
2015-12-23 09:37:06 -05:00
|
|
|
[**-t**|**--timestamps**]
|
2014-07-22 22:40:10 -04:00
|
|
|
[**--tail**[=*"all"*]]
|
2014-06-30 22:58:04 -04:00
|
|
|
CONTAINER
|
2014-04-16 14:07:55 -04:00
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
The **docker logs** command batch-retrieves whatever logs are present for
|
2014-04-17 11:36:58 -04:00
|
|
|
a container at the time of execution. This does not guarantee execution
|
2015-01-06 23:23:32 -05:00
|
|
|
order when combined with a docker run (i.e., your run may not have generated
|
2014-04-17 11:36:58 -04:00
|
|
|
any logs at the time you execute docker logs).
|
2014-04-16 14:07:55 -04:00
|
|
|
|
|
|
|
The **docker logs --follow** command combines commands **docker logs** and
|
2014-04-21 16:28:25 -04:00
|
|
|
**docker attach**. It will first return all logs from the beginning and
|
2016-05-20 14:15:57 -04:00
|
|
|
then continue streaming new output from the container's stdout and stderr.
|
2014-04-16 14:07:55 -04:00
|
|
|
|
Add log reading to the journald log driver
If a logdriver doesn't register a callback function to validate log
options, it won't be usable. Fix the journald driver by adding a dummy
validator.
Teach the client and the daemon's "logs" logic that the server can also
supply "logs" data via the "journald" driver. Update documentation and
tests that depend on error messages.
Add support for reading log data from the systemd journal to the
journald log driver. The internal logic uses a goroutine to scan the
journal for matching entries after any specified cutoff time, formats
the messages from those entries as JSONLog messages, and stuffs the
results down a pipe whose reading end we hand back to the caller.
If we are missing any of the 'linux', 'cgo', or 'journald' build tags,
however, we don't implement a reader, so the 'logs' endpoint will still
return an error.
Make the necessary changes to the build setup to ensure that support for
reading container logs from the systemd journal is built.
Rename the Jmap member of the journald logdriver's struct to "vars" to
make it non-public, and to make it easier to tell that it's just there
to hold additional variable values that we want journald to record along
with log data that we're sending to it.
In the client, don't assume that we know which logdrivers the server
implements, and remove the check that looks at the server. It's
redundant because the server already knows, and the check also makes
using older clients with newer servers (which may have new logdrivers in
them) unnecessarily hard.
When we try to "logs" and have to report that the container's logdriver
doesn't support reading, send the error message through the
might-be-a-multiplexer so that clients which are expecting multiplexed
data will be able to properly display the error, instead of tripping
over the data and printing a less helpful "Unrecognized input header"
error.
Signed-off-by: Nalin Dahyabhai <nalin@redhat.com> (github: nalind)
2015-07-23 11:02:56 -04:00
|
|
|
**Warning**: This command works only for the **json-file** or **journald**
|
|
|
|
logging drivers.
|
2015-02-05 19:24:47 -05:00
|
|
|
|
2014-04-16 14:07:55 -04:00
|
|
|
# OPTIONS
|
2014-10-15 17:14:12 -04:00
|
|
|
**--help**
|
|
|
|
Print usage statement
|
|
|
|
|
2016-04-08 12:15:08 -04:00
|
|
|
**--details**=*true*|*false*
|
|
|
|
Show extra details provided to logs
|
|
|
|
|
2014-06-30 22:58:04 -04:00
|
|
|
**-f**, **--follow**=*true*|*false*
|
|
|
|
Follow log output. The default is *false*.
|
|
|
|
|
2015-04-14 00:36:12 -04:00
|
|
|
**--since**=""
|
|
|
|
Show logs since timestamp
|
|
|
|
|
2014-06-30 22:58:04 -04:00
|
|
|
**-t**, **--timestamps**=*true*|*false*
|
|
|
|
Show timestamps. The default is *false*.
|
2014-04-16 14:07:55 -04:00
|
|
|
|
2015-11-09 20:33:55 -05:00
|
|
|
**--tail**="*all*"
|
2014-07-22 22:40:10 -04:00
|
|
|
Output the specified number of lines at the end of logs (defaults to all logs)
|
|
|
|
|
2016-02-22 14:22:20 -05:00
|
|
|
The `--since` option can be Unix timestamps, date formatted timestamps, or Go
|
2016-05-20 14:15:57 -04:00
|
|
|
duration strings (e.g. `10m`, `1h30m`) computed relative to the client machine's
|
2016-02-22 14:22:20 -05:00
|
|
|
time. Supported formats for date formatted time stamps include RFC3339Nano,
|
2015-10-29 13:51:36 -04:00
|
|
|
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
|
|
|
|
used if you do not provide either a `Z` or a `+-00:00` timezone offset at the
|
|
|
|
end of the timestamp. When providing Unix timestamps enter
|
|
|
|
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
|
|
|
|
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
|
|
|
|
either or both of the `--follow` or `--tail` options.
|
2015-05-12 15:59:34 -04:00
|
|
|
|
2016-04-08 12:15:08 -04:00
|
|
|
The `docker logs --details` command will add on extra attributes, such as
|
|
|
|
environment variables and labels, provided to `--log-opt` when creating the
|
|
|
|
container.
|
|
|
|
|
2014-04-16 14:07:55 -04:00
|
|
|
# HISTORY
|
|
|
|
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
2014-07-01 20:30:25 -04:00
|
|
|
based on docker.com source material and internal work.
|
2014-06-30 22:58:04 -04:00
|
|
|
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
2014-07-22 22:40:10 -04:00
|
|
|
July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
2015-04-14 00:36:12 -04:00
|
|
|
April 2015, updated by Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
|
2015-10-29 13:51:36 -04:00
|
|
|
October 2015, updated by Mike Brown <mikebrow@gmail.com>
|