Skip to content

Commit d4c0027

Browse files
authored
Add --debug as shortcut for --log-level debug (#964)
## Changes This PR exposes simpler interfaces to end users. ## Tests <img width="724" alt="image" src="https://github.com/databricks/cli/assets/259697/8bd25110-33f0-4197-8f00-2b8198c4aba6">
1 parent d4d4b74 commit d4c0027

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

cmd/root/logger.go

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ type logFlags struct {
7373
file flags.LogFileFlag
7474
level flags.LogLevelFlag
7575
output flags.Output
76+
debug bool
7677
}
7778

7879
func (f *logFlags) makeLogHandler(opts slog.HandlerOptions) (slog.Handler, error) {
@@ -95,6 +96,10 @@ func (f *logFlags) makeLogHandler(opts slog.HandlerOptions) (slog.Handler, error
9596
}
9697

9798
func (f *logFlags) initializeContext(ctx context.Context) (context.Context, error) {
99+
if f.debug {
100+
f.level.Set("debug")
101+
}
102+
98103
opts := slog.HandlerOptions{}
99104
opts.Level = f.level.Level()
100105
opts.AddSource = true
@@ -137,9 +142,17 @@ func initLogFlags(cmd *cobra.Command) *logFlags {
137142
f.output.Set(v)
138143
}
139144

140-
cmd.PersistentFlags().Var(&f.file, "log-file", "file to write logs to")
141-
cmd.PersistentFlags().Var(&f.level, "log-level", "log level")
142-
cmd.PersistentFlags().Var(&f.output, "log-format", "log output format (text or json)")
145+
flags := cmd.PersistentFlags()
146+
flags.BoolVar(&f.debug, "debug", false, "enable debug logging")
147+
flags.Var(&f.file, "log-file", "file to write logs to")
148+
flags.Var(&f.level, "log-level", "log level")
149+
flags.Var(&f.output, "log-format", "log output format (text or json)")
150+
151+
// mark fine-grained flags hidden from global --help
152+
flags.MarkHidden("log-file")
153+
flags.MarkHidden("log-level")
154+
flags.MarkHidden("log-format")
155+
143156
cmd.RegisterFlagCompletionFunc("log-file", f.file.Complete)
144157
cmd.RegisterFlagCompletionFunc("log-level", f.level.Complete)
145158
cmd.RegisterFlagCompletionFunc("log-format", f.output.Complete)

0 commit comments

Comments
 (0)