feat(run): Write logs to <stackdir>/.nitric/run.log

This starts up a little syslog server and writes the logs to file.

Author: asalkeld

go.mod

@@ -38,6 +38,7 @@ require (
 	golang.org/x/net v0.0.0-20211105192438-b53810dc28af // indirect
 	golang.org/x/sys v0.0.0-20211124211545-fe61309f8881 // indirect
 	google.golang.org/grpc v1.41.0
+	gopkg.in/mcuadros/go-syslog.v2 v2.3.0
 	gopkg.in/yaml.v2 v2.4.0
 )
 

go.sum

@@ -2454,6 +2454,8 @@ gopkg.in/ini.v1 v1.56.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
 gopkg.in/ini.v1 v1.62.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
 gopkg.in/ini.v1 v1.63.2 h1:tGK/CyBg7SMzb60vP1M03vNZ3VDu3wGQJwn7Sxi9r3c=
 gopkg.in/ini.v1 v1.63.2/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
+gopkg.in/mcuadros/go-syslog.v2 v2.3.0 h1:kcsiS+WsTKyIEPABJBJtoG0KkOS6yzvJ+/eZlhD79kk=
+gopkg.in/mcuadros/go-syslog.v2 v2.3.0/go.mod h1:l5LPIyOOyIdQquNg+oU6Z3524YwrcqEm0aKH+5zpt2U=
 gopkg.in/natefinch/lumberjack.v2 v2.0.0/go.mod h1:l0ndWWf7gzL7RNwBG7wST/UCcT4T24xpD6X8LsfU/+k=
 gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo=
 gopkg.in/square/go-jose.v2 v2.2.2/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI=

mocks/mock_containerengine/mock_containerengine.go

@@ -39,7 +39,7 @@ func TestCreateBaseDev(t *testing.T) {
 
 	me.EXPECT().Build(gomock.Any(), dir, "nitric-ts-dev", map[string]string{})
 
-	containerengine.MockEngine = me
+	containerengine.DiscoveredEngine = me
 
 	if err := CreateBaseDev(dir, map[string]string{"ts": "nitric-ts-dev"}); err != nil {
 		t.Errorf("CreateBaseDev() error = %v", err)

pkg/build/build_test.go

@@ -29,6 +29,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/nitrictech/newcli/pkg/build"
+	"github.com/nitrictech/newcli/pkg/containerengine"
 	"github.com/nitrictech/newcli/pkg/run"
 	"github.com/nitrictech/newcli/pkg/stack"
 	"github.com/nitrictech/newcli/pkg/tasklet"
@@ -56,6 +57,12 @@ var runCmd = &cobra.Command{
 			cobra.CheckErr(err)
 		}
 
+		ce, err := containerengine.Discover()
+		cobra.CheckErr(err)
+
+		logger := ce.Logger(contextDir)
+		cobra.CheckErr(logger.Start())
+
 		createBaseImage := tasklet.Runner{
 			StartMsg: "Creating Dev Image",
 			Runner: func(tCtx tasklet.TaskletContext) error {
@@ -80,9 +87,18 @@ var runCmd = &cobra.Command{
 				}(memerr)
 
 				for {
+					select {
+					case err := <-memerr:
+						// catch any early errors from Start()
+						if err != nil {
+							return err
+						}
+					default:
+					}
 					if ls.Running() {
 						break
 					}
+					tCtx.Spinner().UpdateText("Waiting for Local Services to be ready")
 					time.Sleep(time.Second)
 				}
 				return nil
@@ -127,6 +143,7 @@ var runCmd = &cobra.Command{
 			}
 		}
 
+		_ = logger.Stop()
 		// Stop the membrane
 		cobra.CheckErr(ls.Stop())
 	},

pkg/cmd/run/root.go

@@ -123,7 +123,6 @@ var stackDescribeCmd = &cobra.Command{
 	Long:  `Describes stack dependencies`,
 	Run: func(cmd *cobra.Command, args []string) {
 		contextDir := stack.StackPath()
-
 		cc, err := codeconfig.New(contextDir, args[0])
 		cobra.CheckErr(err)
 

pkg/cmd/stack/root.go

@@ -22,7 +22,9 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"log"
 	"os/exec"
+	"path"
 	"strings"
 	"time"
 
@@ -40,7 +42,8 @@ import (
 )
 
 type docker struct {
-	cli *client.Client
+	cli    *client.Client
+	syslog *localSyslog
 }
 
 var _ ContainerEngine = &docker{}
@@ -67,6 +70,10 @@ func newDocker() (ContainerEngine, error) {
 	return &docker{cli: cli}, err
 }
 
+func (d *docker) Type() string {
+	return "docker"
+}
+
 func tarContextDir(relDockerfile, contextDir string) (io.ReadCloser, error) {
 	excludes, err := build.ReadDockerignore(contextDir)
 	if err != nil {
@@ -137,7 +144,7 @@ func print(rd io.Reader) error {
 			return err
 		}
 		if len(line.Stream) > 0 {
-			fmt.Print(line.Stream)
+			log.Default().Print(line.Stream)
 		}
 	}
 
@@ -278,3 +285,12 @@ func (d *docker) ContainerExec(containerName string, cmd []string, workingDir st
 		return fmt.Errorf("%s %v exited with %d", containerName, cmd, res.ExitCode)
 	}
 }
+
+func (d *docker) Logger(stackPath string) ContainerLogger {
+	if d.syslog == nil {
+		d.syslog = &localSyslog{
+			logPath: path.Join(utils.NitricLogDir(stackPath), "run.log"),
+		}
+	}
+	return d.syslog
+}

pkg/containerengine/docker.go

@@ -22,6 +22,7 @@ import (
 	"fmt"
 	"io"
 	"os/exec"
+	"path"
 	"strings"
 	"time"
 
@@ -30,6 +31,8 @@ import (
 	"github.com/docker/docker/api/types/network"
 	"github.com/docker/docker/client"
 	"github.com/pkg/errors"
+
+	"github.com/nitrictech/newcli/pkg/utils"
 )
 
 // use docker client to podman socket.
@@ -75,6 +78,10 @@ func newPodman() (ContainerEngine, error) {
 	return &podman{docker: &docker{cli: cli}}, err
 }
 
+func (p *podman) Type() string {
+	return "podman"
+}
+
 func (p *podman) Build(dockerfile, path, imageTag string, buildArgs map[string]string) error {
 	return p.docker.Build(dockerfile, path, imageTag, buildArgs)
 }
@@ -122,3 +129,23 @@ func (p *podman) RemoveByLabel(name, value string) error {
 func (p *podman) ContainerExec(containerName string, cmd []string, workingDir string) error {
 	return p.docker.ContainerExec(containerName, cmd, workingDir)
 }
+
+func (p *podman) Logger(stackPath string) ContainerLogger {
+	return &jsonfile{logPath: path.Join(utils.NitricLogDir(stackPath), "run.log")}
+}
+
+type jsonfile struct {
+	logPath string
+}
+
+func (j *jsonfile) Config() *container.LogConfig {
+	return &container.LogConfig{
+		Type: "json-file",
+		Config: map[string]string{
+			"path": j.logPath,
+		},
+	}
+}
+
+func (j *jsonfile) Stop() error  { return nil }
+func (j *jsonfile) Start() error { return nil }

pkg/containerengine/podman.go

@@ -0,0 +1,108 @@
+// Copyright Nitric Pty Ltd.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at:
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package containerengine
+
+import (
+	"fmt"
+	"log"
+	slog "log/syslog"
+	"net"
+	"os"
+	"path"
+
+	"github.com/docker/docker/api/types/container"
+	"github.com/hashicorp/consul/sdk/freeport"
+	"gopkg.in/mcuadros/go-syslog.v2"
+
+	"github.com/nitrictech/newcli/pkg/utils"
+)
+
+type localSyslog struct {
+	logPath string
+	file    *os.File
+	port    int
+	server  *syslog.Server
+}
+
+func (s *localSyslog) Stop() error {
+	errList := utils.NewErrorList()
+
+	errList.Add(s.server.Kill())
+	s.server.Wait()
+	errList.Add(s.file.Close())
+
+	return errList.Aggregate()
+}
+
+func (s *localSyslog) Config() *container.LogConfig {
+	return &container.LogConfig{
+		Type: "syslog",
+		Config: map[string]string{
+			"syslog-address": "udp://" + net.JoinHostPort("localhost", fmt.Sprint(s.port)),
+			"tag":            "{{.ImageName}}/{{.Name}}/{{.ID}}",
+		},
+	}
+}
+
+func (s *localSyslog) Start() error {
+	ports, err := freeport.Take(1)
+	if err != nil {
+		return err
+	}
+	s.port = ports[0]
+
+	channel := make(syslog.LogPartsChannel)
+	handler := syslog.NewChannelHandler(channel)
+
+	s.server = syslog.NewServer()
+	s.server.SetFormat(syslog.Automatic)
+	s.server.SetHandler(handler)
+	err = s.server.ListenUDP(net.JoinHostPort("0.0.0.0", fmt.Sprint(s.port)))
+	if err != nil {
+		return err
+	}
+
+	err = s.server.Boot()
+	if err != nil {
+		return err
+	}
+
+	err = os.MkdirAll(path.Dir(s.logPath), 0777)
+	if err != nil {
+		return err
+	}
+
+	s.file, err = os.OpenFile(s.logPath, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0666)
+	if err != nil {
+		return err
+	}
+
+	go func(channel syslog.LogPartsChannel) {
+		for logParts := range channel {
+			fmt.Fprintf(s.file, "%s %s %s\n", logParts["timestamp"], logParts["tag"], logParts["content"])
+		}
+	}(channel)
+
+	// set up the log client
+	logwriter, err := slog.Dial("udp", net.JoinHostPort("localhost", fmt.Sprint(s.port)), slog.LOG_DEBUG, "nitric-run")
+	if err != nil {
+		return err
+	}
+	log.SetOutput(logwriter)
+
+	return nil
+}

pkg/containerengine/syslog.go

@@ -27,7 +27,7 @@ import (
 	"github.com/spf13/viper"
 )
 
-var MockEngine ContainerEngine
+var DiscoveredEngine ContainerEngine
 
 type Image struct {
 	ID         string `yaml:"id"`
@@ -36,7 +36,14 @@ type Image struct {
 	CreatedAt  string `yaml:"createdAt,omitempty"`
 }
 
+type ContainerLogger interface {
+	Start() error
+	Stop() error
+	Config() *container.LogConfig
+}
+
 type ContainerEngine interface {
+	Type() string
 	Build(dockerfile, path, imageTag string, buildArgs map[string]string) error
 	ListImages(stackName, containerName string) ([]Image, error)
 	ImagePull(rawImage string) error
@@ -49,19 +56,21 @@ type ContainerEngine interface {
 	ContainersListByLabel(match map[string]string) ([]types.Container, error)
 	RemoveByLabel(name, value string) error
 	ContainerExec(containerName string, cmd []string, workingDir string) error
+	Logger(stackPath string) ContainerLogger
 }
 
 func Discover() (ContainerEngine, error) {
-	if MockEngine != nil {
-		// for unit testing
-		return MockEngine, nil
+	if DiscoveredEngine != nil {
+		return DiscoveredEngine, nil
 	}
 	pm, err := newPodman()
 	if err == nil {
+		DiscoveredEngine = pm
 		return pm, nil
 	}
 	dk, err := newDocker()
 	if err == nil {
+		DiscoveredEngine = dk
 		return dk, nil
 	}
 	return nil, errors.New("neither podman nor docker found")

pkg/containerengine/types.go

@@ -73,6 +73,7 @@ func (f *Function) Start() error {
 				Target: "/app",
 			},
 		},
+		LogConfig: *f.ce.Logger(f.runCtx).Config(),
 	}
 	if runtime.GOOS == "linux" {
 		// setup host.docker.internal to route to host gateway