Skip to content

show logs on watch #11511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gabilaza wants to merge 1 commit into from
Closed

show logs on watch #11511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions cmd/compose/watch.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"github.com/compose-spec/compose-go/v2/types"

"github.com/docker/cli/cli/command"
"github.com/docker/compose/v2/cmd/formatter"
"github.com/docker/compose/v2/internal/locker"
"github.com/docker/compose/v2/pkg/api"
"github.com/sirupsen/logrus"
Expand All @@ -31,8 +32,12 @@ import (

type watchOptions struct {
*ProjectOptions
quiet bool
noUp bool
quiet bool
noUp bool
logs bool
noColor bool
noPrefix bool
timestamp bool
}

func watchCommand(p *ProjectOptions, dockerCli command.Cli, backend api.Service) *cobra.Command {
Expand All @@ -59,6 +64,10 @@ func watchCommand(p *ProjectOptions, dockerCli command.Cli, backend api.Service)

cmd.Flags().BoolVar(&watchOpts.quiet, "quiet", false, "hide build output")
cmd.Flags().BoolVar(&watchOpts.noUp, "no-up", false, "Do not build & start services before watching")
cmd.Flags().BoolVar(&watchOpts.logs, "logs", false, "Show containers logs")
cmd.Flags().BoolVar(&watchOpts.noColor, "no-color", false, "Produce monochrome output in logs")
cmd.Flags().BoolVar(&watchOpts.noPrefix, "no-log-prefix", false, "Don't print prefix in logs")
cmd.Flags().BoolVar(&watchOpts.timestamp, "timestamps", false, "Show timestamps in logs")
return cmd
}

Expand Down Expand Up @@ -86,6 +95,11 @@ func runWatch(ctx context.Context, dockerCli command.Cli, backend api.Service, w
return fmt.Errorf("cannot take exclusive lock for project %q: %w", project.Name, err)
}

var consumer api.LogConsumer
if watchOpts.logs {
consumer = formatter.NewLogConsumer(ctx, dockerCli.Out(), dockerCli.Err(), !watchOpts.noColor, !watchOpts.noPrefix, watchOpts.timestamp)
}

if !watchOpts.noUp {
for index, service := range project.Services {
if service.Build != nil && service.Develop != nil {
Expand All @@ -105,7 +119,7 @@ func runWatch(ctx context.Context, dockerCli command.Cli, backend api.Service, w
},
Start: api.StartOptions{
Project: project,
Attach: nil,
Attach: consumer,
CascadeStop: false,
Services: services,
},
Expand All @@ -115,6 +129,7 @@ func runWatch(ctx context.Context, dockerCli command.Cli, backend api.Service, w
}
}
return backend.Watch(ctx, project, services, api.WatchOptions{
Build: build,
Build: build,
Attach: consumer,
})
}
2 changes: 2 additions & 0 deletions pkg/api/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ type VizOptions struct {
// WatchOptions group options of the Watch API
type WatchOptions struct {
Build BuildOptions
// Attach to container and forward logs if not nil
Attach LogConsumer
}

// BuildOptions group options of the Build API
Expand Down
9 changes: 5 additions & 4 deletions pkg/compose/watch.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ func (s *composeService) watch(ctx context.Context, project *types.Project, name
case batch := <-batchEvents:
start := time.Now()
logrus.Debugf("batch start: service[%s] count[%d]", name, len(batch))
if err := s.handleWatchBatch(ctx, project, name, options.Build, batch, syncer); err != nil {
if err := s.handleWatchBatch(ctx, project, name, options, batch, syncer); err != nil {
logrus.Warnf("Error handling changed files for service %s: %v", name, err)
}
logrus.Debugf("batch complete: service[%s] duration[%s] count[%d]",
Expand Down Expand Up @@ -431,7 +431,7 @@ func (t tarDockerClient) Untar(ctx context.Context, id string, archive io.ReadCl
})
}

func (s *composeService) handleWatchBatch(ctx context.Context, project *types.Project, serviceName string, build api.BuildOptions, batch []fileEvent, syncer sync.Syncer) error {
func (s *composeService) handleWatchBatch(ctx context.Context, project *types.Project, serviceName string, options api.WatchOptions, batch []fileEvent, syncer sync.Syncer) error {
pathMappings := make([]sync.PathMapping, len(batch))
restartService := false
for i := range batch {
Expand All @@ -443,15 +443,16 @@ func (s *composeService) handleWatchBatch(ctx context.Context, project *types.Pr
strings.Join(append([]string{""}, batch[i].HostPath), "\n - "),
)
// restrict the build to ONLY this service, not any of its dependencies
build.Services = []string{serviceName}
options.Build.Services = []string{serviceName}
err := s.Up(ctx, project, api.UpOptions{
Create: api.CreateOptions{
Build: &build,
Build: &options.Build,
Services: []string{serviceName},
Inherit: true,
},
Start: api.StartOptions{
Services: []string{serviceName},
Attach: options.Attach,
Project: project,
},
})
Expand Down