client/container_logs.go
4f0d95fa
 package client // import "github.com/docker/docker/client"
7c36a1af
 
 import (
7d62e40f
 	"context"
7c36a1af
 	"io"
 	"net/url"
 	"time"
 
 	"github.com/docker/docker/api/types"
 	timetypes "github.com/docker/docker/api/types/time"
48cfe3f0
 	"github.com/pkg/errors"
7c36a1af
 )
 
 // ContainerLogs returns the logs generated by a container in an io.ReadCloser.
 // It's up to the caller to close the stream.
48829ddf
 //
 // The stream format on the response will be in one of two formats:
 //
 // If the container is using a TTY, there is only a single stream (stdout), and
 // data is copied directly from the container output stream, no extra
 // multiplexing or headers.
 //
 // If the container is *not* using a TTY, streams for stdout and stderr are
 // multiplexed.
 // The format of the multiplexed stream is as follows:
 //
 //    [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT}
 //
 // STREAM_TYPE can be 1 for stdout and 2 for stderr
 //
 // SIZE1, SIZE2, SIZE3, and SIZE4 are four bytes of uint32 encoded as big endian.
 // This is the size of OUTPUT.
 //
 // You can use github.com/docker/docker/pkg/stdcopy.StdCopy to demultiplex this
 // stream.
7c36a1af
 func (cli *Client) ContainerLogs(ctx context.Context, container string, options types.ContainerLogsOptions) (io.ReadCloser, error) {
 	query := url.Values{}
 	if options.ShowStdout {
 		query.Set("stdout", "1")
 	}
 
 	if options.ShowStderr {
 		query.Set("stderr", "1")
 	}
 
 	if options.Since != "" {
 		ts, err := timetypes.GetTimestamp(options.Since, time.Now())
 		if err != nil {
48cfe3f0
 			return nil, errors.Wrap(err, `invalid value for "since"`)
7c36a1af
 		}
 		query.Set("since", ts)
 	}
 
e8d9a61f
 	if options.Until != "" {
 		ts, err := timetypes.GetTimestamp(options.Until, time.Now())
 		if err != nil {
48cfe3f0
 			return nil, errors.Wrap(err, `invalid value for "until"`)
e8d9a61f
 		}
 		query.Set("until", ts)
 	}
 
7c36a1af
 	if options.Timestamps {
 		query.Set("timestamps", "1")
 	}
 
 	if options.Details {
 		query.Set("details", "1")
 	}
 
 	if options.Follow {
 		query.Set("follow", "1")
 	}
 	query.Set("tail", options.Tail)
 
 	resp, err := cli.get(ctx, "/containers/"+container+"/logs", query, nil)
 	if err != nil {
2d6fb87c
 		return nil, wrapResponseError(err, resp, "container", container)
7c36a1af
 	}
 	return resp.body, nil
 }