components/docker/files/man/docker-logs.1
author Jesse Butler <jesse.butler@oracle.com>
Wed, 20 Jul 2016 17:19:20 -0700
changeset 6468 af5d82385cd7
permissions -rw-r--r--
PSARC/2016/354 Docker Engine 1.10.3 23499922 Docker Engine for Solaris 23757816 Docker on Solaris could use a support utility
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6468
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     1
.TH "DOCKER" "1" " Docker User Manuals" "Docker Community" "JUNE 2014"  ""
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     2
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     3
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     4
.SH NAME
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     5
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     6
docker\-logs \- Fetch the logs of a container
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     7
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     8
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     9
.SH SYNOPSIS
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    10
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    11
\fBdocker logs\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    12
[\fB\-f\fP|\fB\-\-follow\fP]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    13
[\fB\-\-help\fP]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    14
[\fB\-\-since\fP[=\fISINCE\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    15
[\fB\-t\fP|\fB\-\-timestamps\fP]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    16
[\fB\-\-tail\fP[=\fI"all"\fP]]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    17
CONTAINER
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    18
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    19
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    20
.SH DESCRIPTION
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    21
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    22
The \fBdocker logs\fP command batch\-retrieves whatever logs are present for
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    23
a container at the time of execution. This does not guarantee execution
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    24
order when combined with a docker run (i.e., your run may not have generated
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    25
any logs at the time you execute docker logs).
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    26
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    27
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    28
The \fBdocker logs \-\-follow\fP command combines commands \fBdocker logs\fP and
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    29
\fBdocker attach\fP. It will first return all logs from the beginning and
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    30
then continue streaming new output from the container’s stdout and stderr.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    31
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    32
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    33
\fBWarning\fP: This command works only for the \fBjson\-file\fP or \fBjournald\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    34
logging drivers.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    35
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    36
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    37
.SH OPTIONS
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    38
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    39
\fB\-\-help\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    40
  Print usage statement
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    41
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    42
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    43
\fB\-f\fP, \fB\-\-follow\fP=\fItrue\fP|\fIfalse\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    44
   Follow log output. The default is \fIfalse\fP.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    45
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    46
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    47
\fB\-\-since\fP=""
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    48
   Show logs since timestamp
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    49
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    50
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    51
\fB\-t\fP, \fB\-\-timestamps\fP=\fItrue\fP|\fIfalse\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    52
   Show timestamps. The default is \fIfalse\fP.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    53
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    54
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    55
\fB\-\-tail\fP="\fIall\fP"
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    56
   Output the specified number of lines at the end of logs (defaults to all logs)
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    57
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    58
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    59
The \fB\fC\-\-since\fR option can be Unix timestamps, date formated timestamps, or Go
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    60
duration strings (e.g. \fB\fC10m\fR, \fB\fC1h30m\fR) computed relative to the client machine’s
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    61
time. Supported formats for date formated time stamps include RFC3339Nano,
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    62
RFC3339, \fB\fC2006\-01\-02T15:04:05\fR, \fB\fC2006\-01\-02T15:04:05.999999999\fR,
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    63
\fB\fC2006\-01\-02Z07:00\fR, and \fB\fC2006\-01\-02\fR. The local timezone on the client will be
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    64
used if you do not provide either a \fB\fCZ\fR or a \fB\fC+\-00:00\fR timezone offset at the
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    65
end of the timestamp.  When providing Unix timestamps enter
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    66
seconds[.nanoseconds], where seconds is the number of seconds that have elapsed
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    67
since January 1, 1970 (midnight UTC/GMT), not counting leap  seconds (aka Unix
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    68
epoch or Unix time), and the optional .nanoseconds field is a fraction of a
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    69
second no more than nine digits long. You can combine the \fB\fC\-\-since\fR option with
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    70
either or both of the \fB\fC\-\-follow\fR or \fB\fC\-\-tail\fR options.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    71
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    72
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    73
.SH HISTORY
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    74
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    75
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    76
based on docker.com source material and internal work.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    77
June 2014, updated by Sven Dowideit 
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    78
\[la][email protected]\[ra]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    79
July 2014, updated by Sven Dowideit 
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    80
\[la][email protected]\[ra]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    81
April 2015, updated by Ahmet Alp Balkan 
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    82
\[la][email protected]\[ra]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    83
October 2015, updated by Mike Brown 
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    84
\[la][email protected]\[ra]