Merge pull request #4874 from dokku/josegonzalez-patch-1

Upgrade vector log integration to 0.17.x

plugins/common/log.go

@@ -1,11 +1,11 @@
 package common
 
 import (
-	"bufio"
 	"fmt"
 	"os"
 	"strconv"
 	"strings"
+	"sync"
 )
 
 // ErrWithExitCode wraps error and exposes an ExitCode method
@@ -13,6 +13,37 @@ type ErrWithExitCode interface {
 	ExitCode() int
 }
 
+type writer struct {
+	mu     *sync.Mutex
+	source string
+}
+
+// Write prints the data to either stdout or stderr using the log helper functions
+func (w *writer) Write(bytes []byte) (int, error) {
+	w.mu.Lock()
+	defer w.mu.Unlock()
+
+	if w.source == "stdout" {
+		for _, line := range strings.Split(string(bytes), "\n") {
+			if line == "" {
+				continue
+			}
+
+			LogVerboseQuiet(line)
+		}
+	} else {
+		for _, line := range strings.Split(string(bytes), "\n") {
+			if line == "" {
+				continue
+			}
+
+			LogVerboseStderrQuiet(line)
+		}
+	}
+
+	return len(bytes), nil
+}
+
 // LogFail is the failure log formatter
 // prints text to stderr and exits with status 1
 func LogFail(text string) {
@@ -81,6 +112,12 @@ func LogVerbose(text string) {
 	fmt.Println(fmt.Sprintf("       %s", text))
 }
 
+// LogVerboseStderr is the verbose log formatter
+// prints indented text to stderr
+func LogVerboseStderr(text string) {
+	fmt.Fprintln(os.Stderr, fmt.Sprintf(" !     %s", text))
+}
+
 // LogVerboseQuiet is the verbose log formatter
 // prints indented text to stdout (with quiet option)
 func LogVerboseQuiet(text string) {
@@ -89,25 +126,17 @@ func LogVerboseQuiet(text string) {
 	}
 }
 
+// LogVerboseStderrQuiet is the verbose log formatter
+// prints indented text to stderr (with quiet option)
+func LogVerboseStderrQuiet(text string) {
+	if os.Getenv("DOKKU_QUIET_OUTPUT") == "" {
+		LogVerboseStderr(text)
+	}
+}
+
 // LogVerboseQuietContainerLogs is the verbose log formatter for container logs
 func LogVerboseQuietContainerLogs(containerID string) {
-	sc := NewShellCmdWithArgs(DockerBin(), "container", "logs", containerID)
-	sc.ShowOutput = false
-	b, err := sc.CombinedOutput()
-	if err != nil {
-		LogExclaim(fmt.Sprintf("Failed to fetch container logs: %s", containerID))
-	}
-
-	output := strings.TrimSpace(string(b))
-	if len(output) == 0 {
-		return
-	}
-
-	for _, line := range strings.Split(output, "\n") {
-		if line != "" {
-			LogVerboseQuiet(line)
-		}
-	}
+	LogVerboseQuietContainerLogsTail(containerID, 0, false)
 }
 
 // LogVerboseQuietContainerLogsTail is the verbose log formatter for container logs with tail mode enabled
@@ -119,17 +148,25 @@ func LogVerboseQuietContainerLogsTail(containerID string, lines int, tail bool)
 	if tail {
 		args = append(args, "--follow")
 	}
-	sc := NewShellCmdWithArgs(DockerBin(), args...)
-	stdout, _ := sc.Command.StdoutPipe()
-	sc.Command.Start()
 
-	scanner := bufio.NewScanner(stdout)
-	scanner.Split(bufio.ScanLines)
-	for scanner.Scan() {
-		m := scanner.Text()
-		LogVerboseQuiet(m)
+	sc := NewShellCmdWithArgs(DockerBin(), args...)
+	var mu sync.Mutex
+	sc.Command.Stdout = &writer{
+		mu:     &mu,
+		source: "stdout",
+	}
+	sc.Command.Stderr = &writer{
+		mu:     &mu,
+		source: "stderr",
+	}
+
+	if err := sc.Command.Start(); err != nil {
+		LogExclaim(fmt.Sprintf("Failed to fetch container logs: %s", containerID))
+	}
+
+	if err := sc.Command.Wait(); err != nil {
+		LogExclaim(fmt.Sprintf("Failed to fetch container logs: %s", containerID))
 	}
-	sc.Command.Wait()
 }
 
 // LogWarn is the warning log formatter

plugins/logs/functions.go

@@ -205,7 +205,7 @@ func writeVectorConfig() error {
 
 	if len(data.Sinks) == 0 {
 		// write logs to a blackhole
-		sink, err := sinkValueToConfig("--null", "blackhole://?print_amount=1")
+		sink, err := sinkValueToConfig("--null", VectorDefaultSink)
 		if err != nil {
 			return err
 		}

plugins/logs/logs.go

@@ -24,7 +24,10 @@ var (
 )
 
 // VectorImage contains the default vector image to run
-const VectorImage = "timberio/vector:0.16.X-debian"
+const VectorImage = "timberio/vector:0.17.X-debian"
+
+// VectorDefaultSink contains the default sink in use for vector log shipping
+const VectorDefaultSink = "blackhole://?print_interval_secs=1"
 
 // GetFailedLogs outputs failed deploy logs for a given app
 func GetFailedLogs(appName string) error {

tests/unit/logs.bats

@@ -396,6 +396,14 @@ teardown() {
 }
 
 @test "(logs) logs:set max-size with alternate log-driver daemon " {
+  if [[ "$REMOTE_CONTAINERS" == "true" ]]; then
+    skip "skipping due non-existent docker service in remote dev container"
+  fi
+
+  if [[ ! -f /etc/docker/daemon.json ]]; then
+    echo "{}" >/etc/docker/daemon.json
+  fi
+
   driver="$(jq -r '."log-driver"' /etc/docker/daemon.json)"
   local TMP_FILE=$(mktemp "/tmp/dokku.me.XXXX")