-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #548 from oauth2-proxy/move-logging-options
Separate logging options out of main options structure
- Loading branch information
Showing
5 changed files
with
157 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| package options | ||
|
|
||
| import ( | ||
| "github.com/oauth2-proxy/oauth2-proxy/pkg/logger" | ||
| "github.com/spf13/pflag" | ||
| ) | ||
|
|
||
| // Logging contains all options required for configuring the logging | ||
| type Logging struct { | ||
| AuthEnabled bool `flag:"auth-logging" cfg:"auth_logging"` | ||
| AuthFormat string `flag:"auth-logging-format" cfg:"auth_logging_format"` | ||
| RequestEnabled bool `flag:"request-logging" cfg:"request_logging"` | ||
| RequestFormat string `flag:"request-logging-format" cfg:"request_logging_format"` | ||
| StandardEnabled bool `flag:"standard-logging" cfg:"standard_logging"` | ||
| StandardFormat string `flag:"standard-logging-format" cfg:"standard_logging_format"` | ||
| ExcludePaths []string `flag:"exclude-logging-path" cfg:"exclude_logging_paths"` | ||
| LocalTime bool `flag:"logging-local-time" cfg:"logging_local_time"` | ||
| SilencePing bool `flag:"silence-ping-logging" cfg:"silence_ping_logging"` | ||
| File LogFileOptions `cfg:",squash"` | ||
| } | ||
|
|
||
| // LogFileOptions contains options for configuring logging to a file | ||
| type LogFileOptions struct { | ||
| Filename string `flag:"logging-filename" cfg:"logging_filename"` | ||
| MaxSize int `flag:"logging-max-size" cfg:"logging_max_size"` | ||
| MaxAge int `flag:"logging-max-age" cfg:"logging_max_age"` | ||
| MaxBackups int `flag:"logging-max-backups" cfg:"logging_max_backups"` | ||
| Compress bool `flag:"logging-compress" cfg:"logging_compress"` | ||
| } | ||
|
|
||
| func loggingFlagSet() *pflag.FlagSet { | ||
| flagSet := pflag.NewFlagSet("logging", pflag.ExitOnError) | ||
|
|
||
| flagSet.Bool("auth-logging", true, "Log authentication attempts") | ||
| flagSet.String("auth-logging-format", logger.DefaultAuthLoggingFormat, "Template for authentication log lines") | ||
| flagSet.Bool("standard-logging", true, "Log standard runtime information") | ||
| flagSet.String("standard-logging-format", logger.DefaultStandardLoggingFormat, "Template for standard log lines") | ||
| flagSet.Bool("request-logging", true, "Log HTTP requests") | ||
| flagSet.String("request-logging-format", logger.DefaultRequestLoggingFormat, "Template for HTTP request log lines") | ||
|
|
||
| flagSet.StringSlice("exclude-logging-path", []string{}, "Exclude logging requests to paths (eg: '/path1,/path2,/path3')") | ||
| flagSet.Bool("logging-local-time", true, "If the time in log files and backup filenames are local or UTC time") | ||
| flagSet.Bool("silence-ping-logging", false, "Disable logging of requests to ping endpoint") | ||
|
|
||
| flagSet.String("logging-filename", "", "File to log requests to, empty for stdout") | ||
| flagSet.Int("logging-max-size", 100, "Maximum size in megabytes of the log file before rotation") | ||
| flagSet.Int("logging-max-age", 7, "Maximum number of days to retain old log files") | ||
| flagSet.Int("logging-max-backups", 0, "Maximum number of old log files to retain; 0 to disable") | ||
| flagSet.Bool("logging-compress", false, "Should rotated log files be compressed using gzip") | ||
|
|
||
| return flagSet | ||
| } | ||
|
|
||
| // loggingDefaults creates a Logging structure, populating each field with its default value | ||
| func loggingDefaults() Logging { | ||
| return Logging{ | ||
| ExcludePaths: nil, | ||
| LocalTime: true, | ||
| SilencePing: false, | ||
| AuthEnabled: true, | ||
| AuthFormat: logger.DefaultAuthLoggingFormat, | ||
| RequestEnabled: true, | ||
| RequestFormat: logger.DefaultRequestLoggingFormat, | ||
| StandardEnabled: true, | ||
| StandardFormat: logger.DefaultStandardLoggingFormat, | ||
| File: LogFileOptions{ | ||
| Filename: "", | ||
| MaxSize: 100, | ||
| MaxAge: 7, | ||
| MaxBackups: 0, | ||
| Compress: false, | ||
| }, | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| package validation | ||
|
|
||
| import ( | ||
| "os" | ||
|
|
||
| "github.com/oauth2-proxy/oauth2-proxy/pkg/apis/options" | ||
| "github.com/oauth2-proxy/oauth2-proxy/pkg/logger" | ||
| "gopkg.in/natefinch/lumberjack.v2" | ||
| ) | ||
|
|
||
| // configureLogger is responsible for configuring the logger based on the options given | ||
| func configureLogger(o options.Logging, pingPath string, msgs []string) []string { | ||
| // Setup the log file | ||
| if len(o.File.Filename) > 0 { | ||
| // Validate that the file/dir can be written | ||
| file, err := os.OpenFile(o.File.Filename, os.O_WRONLY|os.O_CREATE, 0666) | ||
| if err != nil { | ||
| if os.IsPermission(err) { | ||
| return append(msgs, "unable to write to log file: "+o.File.Filename) | ||
| } | ||
| } | ||
| file.Close() | ||
|
|
||
| logger.Printf("Redirecting logging to file: %s", o.File.Filename) | ||
|
|
||
| logWriter := &lumberjack.Logger{ | ||
| Filename: o.File.Filename, | ||
| MaxSize: o.File.MaxSize, // megabytes | ||
| MaxAge: o.File.MaxAge, // days | ||
| MaxBackups: o.File.MaxBackups, | ||
| LocalTime: o.LocalTime, | ||
| Compress: o.File.Compress, | ||
| } | ||
|
|
||
| logger.SetOutput(logWriter) | ||
| } | ||
|
|
||
| // Supply a sanity warning to the logger if all logging is disabled | ||
| if !o.StandardEnabled && !o.AuthEnabled && !o.RequestEnabled { | ||
| logger.Print("Warning: Logging disabled. No further logs will be shown.") | ||
| } | ||
|
|
||
| // Pass configuration values to the standard logger | ||
| logger.SetStandardEnabled(o.StandardEnabled) | ||
| logger.SetAuthEnabled(o.AuthEnabled) | ||
| logger.SetReqEnabled(o.RequestEnabled) | ||
| logger.SetStandardTemplate(o.StandardFormat) | ||
| logger.SetAuthTemplate(o.AuthFormat) | ||
| logger.SetReqTemplate(o.RequestFormat) | ||
|
|
||
| excludePaths := o.ExcludePaths | ||
| if o.SilencePing { | ||
| excludePaths = append(excludePaths, pingPath) | ||
| } | ||
| logger.SetExcludePaths(excludePaths) | ||
|
|
||
| if !o.LocalTime { | ||
| logger.SetFlags(logger.Flags() | logger.LUTC) | ||
| } | ||
|
|
||
| return msgs | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters