Skip to content
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.

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

feat: add log file support #1813

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions docs/arguments.md
Original file line number Diff line number Diff line change
@@ -123,6 +123,25 @@ Environment Variable: WATCHTOWER_TRACE
Default: false
```

## Enable Log File
Enable logging to a file. The file will be located at `/var/log/watchtower.log` by default inside the container.

```text
Argument: --enable-log-file
Environment Variable: WATCHTOWER_ENABLE_LOG_FILE
Type: Boolean
Default: false
```

To change the location of the log file, use the `--log-file-path` argument.

```text
Argument: --log-file-path
Environment Variable: WATCHTOWER_LOG_FILE_PATH
Type: String
Default: "/var/log/watchtower.log"
```

## Maximum log level

The maximum log level that will be written to STDERR (shown in `docker log` when used in a container).
27 changes: 27 additions & 0 deletions internal/flags/flags.go
Original file line number Diff line number Diff line change
@@ -4,6 +4,7 @@ import (
"bufio"
"errors"
"fmt"
"io"
"os"
"regexp"
"strings"
@@ -200,6 +201,16 @@ func RegisterSystemFlags(rootCmd *cobra.Command) {
envString("WATCHTOWER_LOG_LEVEL"),
"The maximum log level that will be written to STDERR. Possible values: panic, fatal, error, warn, info, debug or trace")

flags.Bool(
"enable-log-file",
envBool("WATCHTOWER_ENABLE_LOG_FILE"),
"Enable logging to file")

flags.String(
"log-file-path",
envString("WATCHTOWER_LOG_FILE_PATH"),
"The file to write logs to. If not specified, logs will be written to STDERR")

flags.BoolP(
"health-check",
"",
@@ -430,6 +441,8 @@ func SetDefaults() {
viper.SetDefault("WATCHTOWER_NOTIFICATION_SLACK_IDENTIFIER", "watchtower")
viper.SetDefault("WATCHTOWER_LOG_LEVEL", "info")
viper.SetDefault("WATCHTOWER_LOG_FORMAT", "auto")
viper.SetDefault("WATCHTOWER_ENABLE_LOG_FILE", false)
viper.SetDefault("WATCHTOWER_LOG_FILE_PATH", "/var/log/watchtower.log")
}

// EnvConfig translates the command-line options into environment variables
@@ -636,6 +649,8 @@ func ProcessFlagAliases(flags *pflag.FlagSet) {
func SetupLogging(f *pflag.FlagSet) error {
logFormat, _ := f.GetString(`log-format`)
noColor, _ := f.GetBool("no-color")
logToFile := flagIsEnabled(f, `enable-log-file`)
path, _ := f.GetString(`log-file-path`)

switch strings.ToLower(logFormat) {
case "auto":
@@ -669,6 +684,18 @@ func SetupLogging(f *pflag.FlagSet) error {
log.SetLevel(logLevel)
}

if logToFile {
logFile, err := os.OpenFile(path, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
if err != nil {
logFile, err = os.Create(path)
if err != nil {
return fmt.Errorf("failed to open log file: %e", err)
}
}
multiWriter := io.MultiWriter(os.Stdout, os.Stderr, logFile)
log.SetOutput(multiWriter)
}

return nil
}