Skip to content

Commit

Permalink
display logs for multiple containers at the same time
Browse files Browse the repository at this point in the history
add the ability for users to specify more than one container at a time
while using podman logs.  If more than one container is being displayed,
podman will also prepend a shortened container id of the container on
the log line.

also, enabled the podman-remote logs command during the refactoring of
the above ability.

fixes issue #2219

Signed-off-by: baude <bbaude@redhat.com>
  • Loading branch information
baude committed Mar 13, 2019
1 parent 22fc5a3 commit 3a33d18
Show file tree
Hide file tree
Showing 12 changed files with 392 additions and 52 deletions.
2 changes: 0 additions & 2 deletions cmd/podman/commands.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ func getMainCommands() []*cobra.Command {
&_psCommand,
_loginCommand,
_logoutCommand,
_logsCommand,
_mountCommand,
_pauseCommand,
_portCommand,
Expand Down Expand Up @@ -63,7 +62,6 @@ func getContainerSubCommands() []*cobra.Command {
_execCommand,
_exportCommand,
_killCommand,
_logsCommand,
_mountCommand,
_pauseCommand,
_portCommand,
Expand Down
1 change: 1 addition & 0 deletions cmd/podman/container.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ var (
_containerExistsCommand,
_inspectCommand,
_listSubCommand,
_logsCommand,
}
)

Expand Down
58 changes: 17 additions & 41 deletions cmd/podman/logs.go
Original file line number Diff line number Diff line change
@@ -1,37 +1,44 @@
package main

import (
"os"
"time"

"github.com/containers/libpod/cmd/podman/cliconfig"
"github.com/containers/libpod/cmd/podman/libpodruntime"
"github.com/containers/libpod/libpod"
"github.com/containers/libpod/pkg/logs"
"github.com/containers/libpod/pkg/adapter"
"github.com/containers/libpod/pkg/util"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/spf13/cobra"
)

var (
logsCommand cliconfig.LogsValues
logsDescription = `Retrieves logs for a container.
logsDescription = `Retrieves logs for one or more containers.
This does not guarantee execution order when combined with podman run (i.e. your run may not have generated any logs at the time you execute podman logs.
`
_logsCommand = &cobra.Command{
Use: "logs [flags] CONTAINER",
Use: "logs [flags] CONTAINER [CONTAINER...]",
Short: "Fetch the logs of a container",
Long: logsDescription,
RunE: func(cmd *cobra.Command, args []string) error {
logsCommand.InputArgs = args
logsCommand.GlobalFlags = MainGlobalOpts
return logsCmd(&logsCommand)
},
Args: func(cmd *cobra.Command, args []string) error {
if len(args) > 0 && logsCommand.Latest {
return errors.New("no containers can be specified when using 'latest'")
}
if !logsCommand.Latest && len(args) < 1 {
return errors.New("specifify at least one container name or ID to log")
}
return nil
},
Example: `podman logs ctrID
podman logs --tail 2 mywebserver
podman logs --follow=true --since 10m ctrID`,
podman logs --follow=true --since 10m ctrID
podman logs mywebserver mydbserver`,
}
)

Expand All @@ -54,20 +61,14 @@ func init() {
}

func logsCmd(c *cliconfig.LogsValues) error {
var ctr *libpod.Container
var err error

runtime, err := libpodruntime.GetRuntime(&c.PodmanCommand)
runtime, err := adapter.GetRuntime(&c.PodmanCommand)
if err != nil {
return errors.Wrapf(err, "could not get runtime")
}
defer runtime.Shutdown(false)

args := c.InputArgs
if len(args) != 1 && !c.Latest {
return errors.Errorf("'podman logs' requires exactly one container name/ID")
}

sinceTime := time.Time{}
if c.Flag("since").Changed {
// parse time, error out if something is wrong
Expand All @@ -78,38 +79,13 @@ func logsCmd(c *cliconfig.LogsValues) error {
sinceTime = since
}

opts := &logs.LogOptions{
opts := &libpod.LogOptions{
Details: c.Details,
Follow: c.Follow,
Since: sinceTime,
Tail: c.Tail,
Timestamps: c.Timestamps,
}

if c.Latest {
ctr, err = runtime.GetLatestContainer()
} else {
ctr, err = runtime.LookupContainer(args[0])
}
if err != nil {
return err
}

logPath := ctr.LogPath()

state, err := ctr.State()
if err != nil {
return err
}

// If the log file does not exist yet and the container is in the
// Configured state, it has never been started before and no logs exist
// Exit cleanly in this case
if _, err := os.Stat(logPath); err != nil {
if state == libpod.ContainerStateConfigured {
logrus.Debugf("Container has not been started, no logs exist yet")
return nil
}
}
return logs.ReadLogs(logPath, ctr, opts)
return runtime.Log(c, opts)
}
1 change: 1 addition & 0 deletions cmd/podman/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ var mainCommands = []*cobra.Command{
_inspectCommand,
_killCommand,
_loadCommand,
_logsCommand,
podCommand.Command,
_pullCommand,
_pushCommand,
Expand Down
10 changes: 10 additions & 0 deletions cmd/podman/varlink/io.podman.varlink
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ type StringResponse (
message: string
)

type LogLine (
device: string,
parseLogType : string,
time: string,
msg: string,
cid: string
)

# ContainerChanges describes the return struct for ListContainerChanges
type ContainerChanges (
changed: []string,
Expand Down Expand Up @@ -522,6 +530,8 @@ method ListContainerProcesses(name: string, opts: []string) -> (container: []str
# capability of varlink if the client invokes it.
method GetContainerLogs(name: string) -> (container: []string)

method GetContainersLogs(names: []string, follow: bool, latest: bool, since: string, tail: int, timestamps: bool) -> (log: LogLine)

# ListContainerChanges takes a name or ID of a container and returns changes between the container and
# its base image. It returns a struct of changed, deleted, and added path names.
method ListContainerChanges(name: string) -> (container: ContainerChanges)
Expand Down
6 changes: 3 additions & 3 deletions docs/podman-logs.1.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
% podman-logs(1)

## NAME
podman\-logs - Fetch the logs of a container
podman\-logs - Fetch the logs of one or more containers

## SYNOPSIS
**podman** **logs** [*options*] *container*
**podman** **logs** [*options*] *container* [*container...*]

## DESCRIPTION
The podman logs command batch-retrieves whatever logs are present for a container at the time of execution.
The podman logs command batch-retrieves whatever logs are present for one or more containers at the time of execution.
This does not guarantee execution order when combined with podman run (i.e. your run may not have generated
any logs at the time you execute podman logs

Expand Down
208 changes: 208 additions & 0 deletions libpod/container_log.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
package libpod

import (
"fmt"
"io/ioutil"
"strings"
"sync"
"time"

"github.com/hpcloud/tail"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
)

const (
// logTimeFormat is the time format used in the log.
// It is a modified version of RFC3339Nano that guarantees trailing
// zeroes are not trimmed, taken from
// https://github.com/golang/go/issues/19635
logTimeFormat = "2006-01-02T15:04:05.000000000Z07:00"
)

// LogOptions is the options you can use for logs
type LogOptions struct {
Details bool
Follow bool
Since time.Time
Tail uint64
Timestamps bool
Multi bool
WaitGroup *sync.WaitGroup
}

// LogLine describes the information for each line of a log
type LogLine struct {
Device string
ParseLogType string
Time time.Time
Msg string
CID string
}

// Log is a runtime function that can read one or more container logs.
func (r *Runtime) Log(containers []*Container, options *LogOptions, logChannel chan *LogLine) error {
for _, ctr := range containers {
if err := ctr.ReadLog(options, logChannel); err != nil {
return err
}
}
return nil
}

// ReadLog reads a containers log based on the input options and returns loglines over a channel
func (c *Container) ReadLog(options *LogOptions, logChannel chan *LogLine) error {
t, tailLog, err := getLogFile(c.LogPath(), options)
if err != nil {
return errors.Wrapf(err, "unable to read log file %s for %s ", c.ID(), c.LogPath())
}
options.WaitGroup.Add(1)
if len(tailLog) > 0 {
for _, nll := range tailLog {
nll.CID = c.ID()
if nll.Since(options.Since) {
logChannel <- nll
}
}
}

go func() {
var partial string
for line := range t.Lines {
nll, err := newLogLine(line.Text)
if err != nil {
logrus.Error(err)
continue
}
if nll.Partial() {
partial = partial + nll.Msg
continue
} else if !nll.Partial() && len(partial) > 1 {
nll.Msg = partial
partial = ""
}
nll.CID = c.ID()
if nll.Since(options.Since) {
logChannel <- nll
}
}
options.WaitGroup.Done()
}()
return nil
}

// getLogFile returns an hp tail for a container given options
func getLogFile(path string, options *LogOptions) (*tail.Tail, []*LogLine, error) {
var (
whence int
err error
logTail []*LogLine
)
// whence 0=origin, 2=end
if options.Tail > 0 {
whence = 2
logTail, err = getTailLog(path, int(options.Tail))
if err != nil {
return nil, nil, err
}
}
seek := tail.SeekInfo{
Offset: 0,
Whence: whence,
}

t, err := tail.TailFile(path, tail.Config{Poll: true, Follow: options.Follow, Location: &seek, Logger: tail.DiscardingLogger})
return t, logTail, err
}

func getTailLog(path string, tail int) ([]*LogLine, error) {
var (
tailLog []*LogLine
nlls []*LogLine
tailCounter int
partial string
)
content, err := ioutil.ReadFile(path)
if err != nil {
return nil, err
}
splitContent := strings.Split(string(content), "\n")
// We read the content in reverse and add each nll until we have the same
// number of F type messages as the desired tail
for i := len(splitContent) - 1; i >= 0; i-- {
if len(splitContent[i]) == 0 {
continue
}
nll, err := newLogLine(splitContent[i])
if err != nil {
return nil, err
}
nlls = append(nlls, nll)
if !nll.Partial() {
tailCounter = tailCounter + 1
}
if tailCounter == tail {
break
}
}
// Now we iterate the results and assemble partial messages to become full messages
for _, nll := range nlls {
if nll.Partial() {
partial = partial + nll.Msg
} else {
nll.Msg = nll.Msg + partial
tailLog = append(tailLog, nll)
partial = ""
}
}
return tailLog, nil
}

// String converts a logline to a string for output given whether a detail
// bool is specified.
func (l *LogLine) String(options *LogOptions) string {
var out string
if options.Multi {
cid := l.CID
if len(cid) > 12 {
cid = cid[:12]
}
out = fmt.Sprintf("%s ", cid)
}
if options.Timestamps {
out = out + fmt.Sprintf("%s ", l.Time.Format(logTimeFormat))
}
return out + l.Msg
}

// Since returns a bool as to whether a log line occurred after a given time
func (l *LogLine) Since(since time.Time) bool {
return l.Time.After(since)
}

// newLogLine creates a logLine struct from a container log string
func newLogLine(line string) (*LogLine, error) {
splitLine := strings.Split(line, " ")
if len(splitLine) < 4 {
return nil, errors.Errorf("'%s' is not a valid container log line", line)
}
logTime, err := time.Parse(time.RFC3339Nano, splitLine[0])
if err != nil {
return nil, errors.Wrapf(err, "unable to convert time %s from container log", splitLine[0])
}
l := LogLine{
Time: logTime,
Device: splitLine[1],
ParseLogType: splitLine[2],
Msg: strings.Join(splitLine[3:], " "),
}
return &l, nil
}

// Partial returns a bool if the log line is a partial log type
func (l *LogLine) Partial() bool {
if l.ParseLogType == "P" {
return true
}
return false
}
Loading

0 comments on commit 3a33d18

Please sign in to comment.