Merge pull request #164 from arangodb-helper/feature/logging-overhaul

Improve logging

Author: ewoutp

Makefile

@@ -23,6 +23,7 @@ ifndef BUILDDIR
 endif
 GOBUILDDIR := $(BUILDDIR)/.gobuild
 SRCDIR := $(SCRIPTDIR)
+CACHEVOL := $(PROJECT)-gocache
 BINDIR := $(BUILDDIR)/bin
 
 ORGPATH := github.com/arangodb-helper
@@ -32,7 +33,7 @@ REPODIR := $(ORGDIR)/$(REPONAME)
 REPOPATH := $(ORGPATH)/$(REPONAME)
 
 GOPATH := $(GOBUILDDIR)
-GOVERSION := 1.10.1-alpine
+GOVERSION := 1.10.3-alpine
 
 ifndef GOOS
 	GOOS := linux
@@ -96,20 +97,29 @@ deps:
 
 $(GOBUILDDIR):
 	@mkdir -p $(ORGDIR)
+	@mkdir -p $(GOBUILDDIR)/src/golang.org
 	@rm -f $(REPODIR) && ln -s $(GOBUILDLINKTARGET) $(REPODIR)
 	@rm -f $(GOBUILDDIR)/src/github.com/aktau && ln -s ../../../vendor/github.com/aktau $(GOBUILDDIR)/src/github.com/aktau
 	@rm -f $(GOBUILDDIR)/src/github.com/arangodb && ln -s ../../../vendor/github.com/arangodb $(GOBUILDDIR)/src/github.com/arangodb
 	@rm -f $(GOBUILDDIR)/src/github.com/dchest && ln -s ../../../vendor/github.com/dchest $(GOBUILDDIR)/src/github.com/dchest
 	@rm -f $(GOBUILDDIR)/src/github.com/dustin && ln -s ../../../vendor/github.com/dustin $(GOBUILDDIR)/src/github.com/dustin
 	@rm -f $(GOBUILDDIR)/src/github.com/kballard && ln -s ../../../vendor/github.com/kballard $(GOBUILDDIR)/src/github.com/kballard
+	@rm -f $(GOBUILDDIR)/src/github.com/rs && ln -s ../../../vendor/github.com/rs $(GOBUILDDIR)/src/github.com/rs
 	@rm -f $(GOBUILDDIR)/src/github.com/shavac && ln -s ../../../vendor/github.com/shavac $(GOBUILDDIR)/src/github.com/shavac
 	@rm -f $(GOBUILDDIR)/src/github.com/voxelbrain && ln -s ../../../vendor/github.com/voxelbrain $(GOBUILDDIR)/src/github.com/voxelbrain
+	@rm -f $(GOBUILDDIR)/src/golang.org/x && ln -s ../../../vendor/golang.org/x $(GOBUILDDIR)/src/golang.org/x
 
-$(BIN): $(GOBUILDDIR) $(SOURCES)
+.PHONY: $(CACHEVOL)
+$(CACHEVOL):
+	@docker volume create $(CACHEVOL)
+
+$(BIN): $(GOBUILDDIR) $(SOURCES) $(CACHEVOL)
 	@mkdir -p $(BINDIR)
 	docker run \
 		--rm \
 		-v $(SRCDIR):/usr/code \
+		-v $(CACHEVOL):/usr/gocache \
+		-e GOCACHE=/usr/gocache \
 		-e GOPATH=/usr/code/.gobuild \
 		-e GOOS=$(GOOS) \
 		-e GOARCH=$(GOARCH) \

certificates.go

@@ -29,9 +29,9 @@ import (
 func init() {
 	certificates.AddCommands(cmdMain, func(err error, msg string) {
 		if err != nil {
-			log.Fatalf("%s: %s", msg, err)
+			log.Fatal().Err(err).Msg(msg)
 		} else {
-			log.Fatal(msg)
+			log.Fatal().Msg(msg)
 		}
 	}, cmdShowUsage)
 }

docs/Manual/Programs/Starter/Options.md

@@ -273,17 +273,35 @@ This indicates whether or not a DB server instance should be started
 path to rr executable to use if non-empty (default ""). Expert and
 debugging only.
 
+- `--log.color=bool`
+
+If set to `true`, console log output is colorized.
+The default is `true` when a terminal is attached to stdin,
+`false` otherwise or when running on Windows.
+
+- `--log.console=bool`
+
+If set to `true`, log output is written to the console (default `true`).
+
+- `--log.file=bool`
+
+If set to `true`, log output is written to the file (default `true`).
+The log file, called `arangodb.log`, can be found in the directory
+specified using `--log.dir` or if that is not set, the directory
+specified using `--starter.data-dir`.
+
 - `--log.verbose=bool`
 
-show more information (default false).
+show more information (default `false`).
 
 - `--log.dir=path`
 
 set a custom directory to which all log files will be written to.
 When using the Starter in docker, make sure that this directory is
 mounted as a volume for the Starter.
 
-Note: When using a custom log directory, all files will be named as `arangod-<role>-<port>.log`.
+Note: When using a custom log directory, all database server files will be named as `arangod-<role>-<port>.log`.
+The log for the starter itself is still called `arangodb.log`.
 
 - `--log.rotate-files-to-keep=int`
 

examples/systemd/arangodb.service

@@ -12,6 +12,7 @@ ExecStartPre=/usr/bin/sh -c "mkdir -p $(dirname $CLUSTERSECRETPATH)"
 ExecStartPre=/usr/bin/sh -c "mkdir -p ${DATADIR}"
 ExecStartPre=/usr/bin/sh -c "echo ${CLUSTERSECRET} > ${CLUSTERSECRETPATH}"
 ExecStart=/usr/bin/arangodb \
+    --log.file=false \
     --starter.data-dir=${DATADIR} \
     --starter.join=${STARTERENDPOINTS} \
     --server.storage-engine=rocksdb \

help.go

@@ -204,7 +204,7 @@ func showSyncMasterJWTSecretMissingHelp() {
 // underneeth and the exit with code 1.
 // Backticks in the lines are colored yellow.
 func showFatalHelp(title string, lines ...string) {
-	log.Error(highlight(title))
+	log.Error().Msg(highlight(title))
 	content := strings.Join(lines, "\n")
 	fmt.Println(highlight(content))
 	os.Exit(1)