Conversation
0ec6854 to
4871c09
Compare
📝 WalkthroughWalkthroughThe pull request introduces enhanced logging configuration handling in the command-line interface. The changes focus on improving log management by adding new flags for log level and log file, implementing more robust configuration validation, and expanding the test suite for the logger package. The modifications aim to provide more granular control over logging behavior and improve error reporting during configuration initialization. Changes
Possibly related PRs
Suggested Labels
Suggested Reviewers
Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
cmd/root.go (1)
46-51: Consider consolidating configuration structures.The code creates two separate structures (
errorConfigandconfigAndStacksInfo) with identical logging information. This could lead to maintenance issues if the logging configuration evolves.Consider consolidating into a single structure or extracting the logging configuration into a shared type:
+type LoggingConfig struct { + Level string + File string +} -errorConfig := schema.AtmosConfiguration{ - Logs: schema.Logs{ - Level: logsLevel, - File: logsFile, - }, -} -configAndStacksInfo := schema.ConfigAndStacksInfo{ - LogsLevel: logsLevel, - LogsFile: logsFile, -} +loggingConfig := LoggingConfig{ + Level: logsLevel, + File: logsFile, +} +errorConfig := schema.AtmosConfiguration{ + Logs: schema.Logs(loggingConfig), +} +configAndStacksInfo := schema.ConfigAndStacksInfo(loggingConfig)Also applies to: 53-56
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
cmd/root.go(1 hunks)pkg/logger/logger_test.go(2 hunks)pkg/utils/log_utils.go(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- pkg/utils/log_utils.go
🧰 Additional context used
🪛 golangci-lint (1.62.2)
pkg/logger/logger_test.go
250-250: Error return value of io.Copy is not checked
(errcheck)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
🔇 Additional comments (5)
cmd/root.go (2)
43-44: LGTM! Proper flag retrieval.The code correctly retrieves the log level and log file flags, which were previously defined in the
initfunction.
58-64: LGTM! Robust configuration validation.The code properly validates the configuration and handles errors, with a special case for the
NotFounderror which is expected in some scenarios.pkg/logger/logger_test.go (3)
68-93: LGTM! Comprehensive test cases for log level parsing.The test cases cover a wide range of scenarios including empty strings, valid levels, and various invalid formats. The table-driven test approach is well-structured and maintainable.
179-215: LGTM! Well-structured level enablement tests.The test cases thoroughly verify the hierarchical nature of log levels and their enablement rules.
273-339: LGTM! Comprehensive CLI config tests.The test cases effectively verify the logger initialization from CLI configuration, including default values and error handling.
|
These changes were released in v1.150.0. |
what
Added logs validation on root level to block all the incorrect log level usages
e.g
atmos version --check --logs-level=asdasdwhy
Latest release validation only validates usage in env level
e.g
ATMOS_LOGS_LEVEL=Trsace atmos terraform plan asd --stack dev --logs-level=TraEvidence:
references
Summary by CodeRabbit
New Features
logs-levelwith default "Info"logs-filewith default "/dev/stdout"Tests
Bug Fixes
Chores