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 containers#2219

Signed-off-by: baude <[email protected]>
  • Loading branch information
baude committed Mar 15, 2019
1 parent 6e4c329 commit 5e86acd
Show file tree
Hide file tree
Showing 13 changed files with 410 additions and 53 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 @@ -53,6 +53,7 @@ var (
_containerExistsCommand,
_contInspectSubCommand,
_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("specify 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
19 changes: 18 additions & 1 deletion cmd/podman/search.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package main

import (
"reflect"
"strings"

"github.com/containers/buildah/pkg/formats"
Expand Down Expand Up @@ -79,7 +80,10 @@ func searchCmd(c *cliconfig.SearchValues) error {
return err
}
format := genSearchFormat(c.Format)
out := formats.StdoutTemplateArray{Output: searchToGeneric(results), Template: format, Fields: results[0].HeaderMap()}
if len(results) == 0 {
return nil
}
out := formats.StdoutTemplateArray{Output: searchToGeneric(results), Template: format, Fields: genSearchOutputMap()}
formats.Writer(out).Out()
return nil
}
Expand All @@ -99,3 +103,16 @@ func searchToGeneric(params []image.SearchResult) (genericParams []interface{})
}
return genericParams
}

func genSearchOutputMap() map[string]string {
io := image.SearchResult{}
v := reflect.Indirect(reflect.ValueOf(io))
values := make(map[string]string)

for i := 0; i < v.NumField(); i++ {
key := v.Type().Field(i).Name
value := key
values[key] = strings.ToUpper(splitCamelCase(value))
}
return values
}
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
Loading

0 comments on commit 5e86acd

Please sign in to comment.