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

create logging defaults #1050

Merged
merged 2 commits into from
Feb 11, 2025
Merged

create logging defaults #1050

merged 2 commits into from
Feb 11, 2025

Conversation

mcalhoun
Copy link
Member

@mcalhoun mcalhoun commented Feb 11, 2025

what

Add sane defaults for logging when not provided via atmos.yaml or args

why

To ensure logging still works, even if not specified in config.

Summary by CodeRabbit

  • New Features
    • Improved default logging behavior, which now automatically directs log output to a standard error channel with an informational verbosity.
    • Updated configuration file handling to ensure files are processed only when present, enhancing overall stability and error handling.

@mcalhoun mcalhoun requested a review from a team as a code owner February 11, 2025 20:33
@mcalhoun mcalhoun added the no-release Do not create a new release (wait for additional code changes) label Feb 11, 2025
@mcalhoun mcalhoun self-assigned this Feb 11, 2025
@mcalhoun mcalhoun enabled auto-merge (squash) February 11, 2025 20:34
Copy link
Contributor

coderabbitai bot commented Feb 11, 2025

📝 Walkthrough

Walkthrough

The changes update the configuration logic in the package by introducing explicit default settings for logging within the CLI initialization. In the InitCliConfig function, the defaults for log file (/dev/stderr) and log level (Info) are now set. Additionally, the processConfigFile function now includes logic to open the configuration file only after confirming its existence, enhancing the control flow and error handling.

Changes

File Change Summary
pkg/config/config.go - In InitCliConfig, added defaults: log file set to /dev/stderr and log level set to Info.
- In processConfigFile, added step to open the file after existence check.

Sequence Diagram(s)

sequenceDiagram
    participant CLI
    participant Config
    CLI->>Config: Call InitCliConfig()
    Config->>Config: Set default log file to "/dev/stderr"
    Config->>Config: Set default log level to "Info"
    CLI->>Config: Call processConfigFile(filename)
    Config->>Config: Check if file exists
    Config->>Config: Open file if exists
Loading

Suggested labels

minor


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 145bfe1 and 4b9adb4.

📒 Files selected for processing (1)
  • pkg/config/config.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Build (windows-latest, windows)
  • GitHub Check: Summary
🔇 Additional comments (2)
pkg/config/config.go (2)

137-139: LGTM! Default logging configuration aligns with best practices.

The default logging configuration is well-structured and follows Unix philosophy by using /dev/stderr for logs. The "Info" level is a sensible default that balances verbosity with usefulness.


389-389: LGTM! Improved error handling flow.

The explicit file opening after the existence check follows the check-then-act pattern, making the code more robust and maintainable.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary or @auto-summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@mcalhoun mcalhoun merged commit f10f64c into main Feb 11, 2025
44 checks passed
@mcalhoun mcalhoun deleted the add-logging-defaults branch February 11, 2025 21:44
Copy link

These changes were released in v1.160.5.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-release Do not create a new release (wait for additional code changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants