Merge pull request #1178 from docker/tail_logs

gtardif · web-flow · commit fd906c6c919f · 2021-01-29T15:54:38.000+01:00
introduce compose logs --tail and --follow options
diff --git a/api/compose/api.go b/api/compose/api.go
@@ -122,6 +122,8 @@ type ServiceStatus struct {
 // LogOptions defines optional parameters for the `Log` API
 type LogOptions struct {
 	Services []string
+	Tail     string
+	Follow   bool
 }
 
 const (
diff --git a/cli/cmd/compose/compose.go b/cli/cmd/compose/compose.go
@@ -97,7 +97,7 @@ func Command(contextType string) *cobra.Command {
 		stopCommand(&opts),
 		psCommand(&opts),
 		listCommand(),
-		logsCommand(&opts),
+		logsCommand(&opts, contextType),
 		convertCommand(&opts),
 		runCommand(&opts),
 	)
diff --git a/cli/cmd/compose/logs.go b/cli/cmd/compose/logs.go
@@ -24,15 +24,18 @@ import (
 
 	"github.com/docker/compose-cli/api/client"
 	"github.com/docker/compose-cli/api/compose"
+	"github.com/docker/compose-cli/api/context/store"
 	"github.com/docker/compose-cli/cli/formatter"
 )
 
 type logsOptions struct {
 	*projectOptions
 	composeOptions
+	follow bool
+	tail   string
 }
 
-func logsCommand(p *projectOptions) *cobra.Command {
+func logsCommand(p *projectOptions, contextType string) *cobra.Command {
 	opts := logsOptions{
 		projectOptions: p,
 	}
@@ -43,6 +46,10 @@ func logsCommand(p *projectOptions) *cobra.Command {
 			return runLogs(cmd.Context(), opts, args)
 		},
 	}
+	logsCmd.Flags().BoolVar(&opts.follow, "follow", false, "Follow log output.")
+	if contextType == store.DefaultContextType {
+		logsCmd.Flags().StringVar(&opts.tail, "tail", "all", "Number of lines to show from the end of the logs for each container.")
+	}
 	return logsCmd
 }
 
@@ -59,5 +66,7 @@ func runLogs(ctx context.Context, opts logsOptions, services []string) error {
 	consumer := formatter.NewLogConsumer(ctx, os.Stdout)
 	return c.ComposeService().Logs(ctx, projectName, consumer, compose.LogOptions{
 		Services: services,
+		Follow:   opts.follow,
+		Tail:     opts.tail,
 	})
 }
diff --git a/ecs/aws.go b/ecs/aws.go
@@ -63,7 +63,7 @@ type API interface {
 	InspectSecret(ctx context.Context, id string) (secrets.Secret, error)
 	ListSecrets(ctx context.Context) ([]secrets.Secret, error)
 	DeleteSecret(ctx context.Context, id string, recover bool) error
-	GetLogs(ctx context.Context, name string, consumer func(service, container, message string)) error
+	GetLogs(ctx context.Context, name string, consumer func(service string, container string, message string), follow bool) error
 	DescribeService(ctx context.Context, cluster string, arn string) (compose.ServiceStatus, error)
 	DescribeServiceTasks(ctx context.Context, cluster string, project string, service string) ([]compose.ContainerSummary, error)
 	getURLWithPortMapping(ctx context.Context, targetGroupArns []string) ([]compose.PortPublisher, error)
diff --git a/ecs/aws_mock.go b/ecs/aws_mock.go
diff --git a/ecs/logs.go b/ecs/logs.go
@@ -26,7 +26,7 @@ func (b *ecsAPIService) Logs(ctx context.Context, projectName string, consumer c
 	if len(options.Services) > 0 {
 		consumer = filteredLogConsumer(consumer, options.Services)
 	}
-	err := b.aws.GetLogs(ctx, projectName, consumer.Log)
+	err := b.aws.GetLogs(ctx, projectName, consumer.Log, options.Follow)
 	return err
 }
 
diff --git a/ecs/sdk.go b/ecs/sdk.go
@@ -805,7 +805,7 @@ func (s sdk) DeleteSecret(ctx context.Context, id string, recover bool) error {
 	return err
 }
 
-func (s sdk) GetLogs(ctx context.Context, name string, consumer func(service, container, message string)) error {
+func (s sdk) GetLogs(ctx context.Context, name string, consumer func(service string, container string, message string), follow bool) error {
 	logGroup := fmt.Sprintf("/docker-compose/%s", name)
 	var startTime int64
 	for {
@@ -837,6 +837,9 @@ func (s sdk) GetLogs(ctx context.Context, name string, consumer func(service, co
 				}
 			}
 		}
+		if !follow {
+			return nil
+		}
 		time.Sleep(500 * time.Millisecond)
 	}
 }
diff --git a/local/compose/create.go b/local/compose/create.go
@@ -35,7 +35,6 @@ import (
 	"github.com/docker/go-connections/nat"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
-	"golang.org/x/sync/errgroup"
 
 	"github.com/docker/compose-cli/api/compose"
 	"github.com/docker/compose-cli/api/progress"
@@ -77,15 +76,11 @@ func (s *composeService) Create(ctx context.Context, project *types.Project, opt
 	orphans := observedState.filter(isNotService(project.ServiceNames()...))
 	if len(orphans) > 0 {
 		if opts.RemoveOrphans {
-			eg, _ := errgroup.WithContext(ctx)
 			w := progress.ContextWriter(ctx)
-			err := s.removeContainers(ctx, w, eg, orphans)
+			err := s.removeContainers(ctx, w, orphans)
 			if err != nil {
 				return err
 			}
-			if eg.Wait() != nil {
-				return err
-			}
 		} else {
 			logrus.Warnf("Found orphan containers (%s) for this project. If "+
 				"you removed or renamed this service in your compose "+
diff --git a/local/compose/down.go b/local/compose/down.go
@@ -33,7 +33,6 @@ import (
 )
 
 func (s *composeService) Down(ctx context.Context, projectName string, options compose.DownOptions) error {
-	eg, _ := errgroup.WithContext(ctx)
 	w := progress.ContextWriter(ctx)
 
 	if options.Project == nil {
@@ -55,25 +54,21 @@ func (s *composeService) Down(ctx context.Context, projectName string, options c
 
 	err = InReverseDependencyOrder(ctx, options.Project, func(c context.Context, service types.ServiceConfig) error {
 		serviceContainers, others := containers.split(isService(service.Name))
-		err := s.removeContainers(ctx, w, eg, serviceContainers)
+		err := s.removeContainers(ctx, w, serviceContainers)
 		containers = others
 		return err
 	})
+	if err != nil {
+		return err
+	}
 
-	if options.RemoveOrphans {
-		err := s.removeContainers(ctx, w, eg, containers)
+	if options.RemoveOrphans && len(containers) > 0 {
+		err := s.removeContainers(ctx, w, containers)
 		if err != nil {
 			return err
 		}
 	}
 
-	if err != nil {
-		return err
-	}
-	err = eg.Wait()
-	if err != nil {
-		return err
-	}
 	networks, err := s.apiClient.NetworkList(ctx, moby.NetworkListOptions{
 		Filters: filters.NewArgs(
 			projectFilter(projectName),
@@ -82,14 +77,15 @@ func (s *composeService) Down(ctx context.Context, projectName string, options c
 	if err != nil {
 		return err
 	}
+
+	eg, _ := errgroup.WithContext(ctx)
 	for _, n := range networks {
 		networkID := n.ID
 		networkName := n.Name
 		eg.Go(func() error {
 			return s.ensureNetworkDown(ctx, networkID, networkName)
 		})
 	}
-
 	return eg.Wait()
 }
 
@@ -108,15 +104,14 @@ func (s *composeService) stopContainers(ctx context.Context, w progress.Writer,
 	return nil
 }
 
-func (s *composeService) removeContainers(ctx context.Context, w progress.Writer, eg *errgroup.Group, containers []moby.Container) error {
+func (s *composeService) removeContainers(ctx context.Context, w progress.Writer, containers []moby.Container) error {
+	eg, _ := errgroup.WithContext(ctx)
 	for _, container := range containers {
 		toDelete := container
 		eg.Go(func() error {
 			eventName := "Container " + getCanonicalContainerName(toDelete)
-			w.Event(progress.StoppingEvent(eventName))
 			err := s.stopContainers(ctx, w, []moby.Container{container})
 			if err != nil {
-				w.Event(progress.ErrorMessageEvent(eventName, "Error while Stopping"))
 				return err
 			}
 			w.Event(progress.RemovingEvent(eventName))
diff --git a/local/compose/logs.go b/local/compose/logs.go
@@ -64,7 +64,8 @@ func (s *composeService) Logs(ctx context.Context, projectName string, consumer
 			r, err := s.apiClient.ContainerLogs(ctx, container.ID, types.ContainerLogsOptions{
 				ShowStdout: true,
 				ShowStderr: true,
-				Follow:     true,
+				Follow:     options.Follow,
+				Tail:       options.Tail,
 			})
 			defer r.Close() // nolint errcheck
 
diff --git a/local/compose/stop.go b/local/compose/stop.go
@@ -19,17 +19,14 @@ package compose
 import (
 	"context"
 
+	"github.com/compose-spec/compose-go/types"
 	moby "github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/filters"
 
 	"github.com/docker/compose-cli/api/progress"
-
-	"github.com/compose-spec/compose-go/types"
-	"golang.org/x/sync/errgroup"
 )
 
 func (s *composeService) Stop(ctx context.Context, project *types.Project) error {
-	eg, _ := errgroup.WithContext(ctx)
 	w := progress.ContextWriter(ctx)
 
 	var containers Containers
@@ -41,15 +38,7 @@ func (s *composeService) Stop(ctx context.Context, project *types.Project) error
 		return err
 	}
 
-	err = InReverseDependencyOrder(ctx, project, func(c context.Context, service types.ServiceConfig) error {
-		serviceContainers, others := containers.split(isService(service.Name))
-		err := s.stopContainers(ctx, w, serviceContainers)
-		containers = others
-		return err
+	return InReverseDependencyOrder(ctx, project, func(c context.Context, service types.ServiceConfig) error {
+		return s.stopContainers(ctx, w, containers.filter(isService(service.Name)))
 	})
-	if err != nil {
-		return err
-	}
-
-	return eg.Wait()
 }

Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,8 @@ type ServiceStatus struct {`
`122`	`122`	// LogOptions defines optional parameters for the `Log` API
`123`	`123`	`type LogOptions struct {`
`124`	`124`	`Services []string`
	`125`	`+ Tail string`
	`126`	`+ Follow bool`
`125`	`127`	`}`
`126`	`128`
`127`	`129`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ func Command(contextType string) *cobra.Command {`
`97`	`97`	`stopCommand(&opts),`
`98`	`98`	`psCommand(&opts),`
`99`	`99`	`listCommand(),`
`100`		`- logsCommand(&opts),`
	`100`	`+ logsCommand(&opts, contextType),`
`101`	`101`	`convertCommand(&opts),`
`102`	`102`	`runCommand(&opts),`
`103`	`103`	`)`
Original file line number	Diff line number	Diff line change
`@@ -24,15 +24,18 @@ import (`
`24`	`24`
`25`	`25`	`"github.com/docker/compose-cli/api/client"`
`26`	`26`	`"github.com/docker/compose-cli/api/compose"`
	`27`	`+ "github.com/docker/compose-cli/api/context/store"`
`27`	`28`	`"github.com/docker/compose-cli/cli/formatter"`
`28`	`29`	`)`
`29`	`30`
`30`	`31`	`type logsOptions struct {`
`31`	`32`	`*projectOptions`
`32`	`33`	`composeOptions`
	`34`	`+ follow bool`
	`35`	`+ tail string`
`33`	`36`	`}`
`34`	`37`
`35`		`-func logsCommand(p projectOptions) cobra.Command {`
	`38`	`+func logsCommand(p projectOptions, contextType string) cobra.Command {`
`36`	`39`	`opts := logsOptions{`
`37`	`40`	`projectOptions: p,`
`38`	`41`	`}`
`@@ -43,6 +46,10 @@ func logsCommand(p projectOptions) cobra.Command {`
`43`	`46`	`return runLogs(cmd.Context(), opts, args)`
`44`	`47`	`},`
`45`	`48`	`}`
	`49`	`+ logsCmd.Flags().BoolVar(&opts.follow, "follow", false, "Follow log output.")`
	`50`	`+ if contextType == store.DefaultContextType {`
	`51`	`+ logsCmd.Flags().StringVar(&opts.tail, "tail", "all", "Number of lines to show from the end of the logs for each container.")`
	`52`	`+ }`
`46`	`53`	`return logsCmd`
`47`	`54`	`}`
`48`	`55`
`@@ -59,5 +66,7 @@ func runLogs(ctx context.Context, opts logsOptions, services []string) error {`
`59`	`66`	`consumer := formatter.NewLogConsumer(ctx, os.Stdout)`
`60`	`67`	`return c.ComposeService().Logs(ctx, projectName, consumer, compose.LogOptions{`
`61`	`68`	`Services: services,`
	`69`	`+ Follow: opts.follow,`
	`70`	`+ Tail: opts.tail,`
`62`	`71`	`})`
`63`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ func (b *ecsAPIService) Logs(ctx context.Context, projectName string, consumer c`
`26`	`26`	`if len(options.Services) > 0 {`
`27`	`27`	`consumer = filteredLogConsumer(consumer, options.Services)`
`28`	`28`	`}`
`29`		`- err := b.aws.GetLogs(ctx, projectName, consumer.Log)`
	`29`	`+ err := b.aws.GetLogs(ctx, projectName, consumer.Log, options.Follow)`
`30`	`30`	`return err`
`31`	`31`	`}`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -805,7 +805,7 @@ func (s sdk) DeleteSecret(ctx context.Context, id string, recover bool) error {`
`805`	`805`	`return err`
`806`	`806`	`}`
`807`	`807`
`808`		`-func (s sdk) GetLogs(ctx context.Context, name string, consumer func(service, container, message string)) error {`
	`808`	`+func (s sdk) GetLogs(ctx context.Context, name string, consumer func(service string, container string, message string), follow bool) error {`
`809`	`809`	`logGroup := fmt.Sprintf("/docker-compose/%s", name)`
`810`	`810`	`var startTime int64`
`811`	`811`	`for {`
`@@ -837,6 +837,9 @@ func (s sdk) GetLogs(ctx context.Context, name string, consumer func(service, co`
`837`	`837`	`}`
`838`	`838`	`}`
`839`	`839`	`}`
	`840`	`+ if !follow {`
	`841`	`+ return nil`
	`842`	`+ }`
`840`	`843`	`time.Sleep(500 * time.Millisecond)`
`841`	`844`	`}`
`842`	`845`	`}`