Skip to content

fix: Log to stderr per default#1028

Closed
mss wants to merge 3 commits intocloudposse:mainfrom
mss:fix/gh-1026
Closed

fix: Log to stderr per default#1028
mss wants to merge 3 commits intocloudposse:mainfrom
mss:fix/gh-1026

Conversation

@mss
Copy link
Contributor

@mss mss commented Feb 5, 2025 •
edited by coderabbitai bot
Loading

what

  • Sync the default value for logs.file with the one shipped in atmos.yaml.

why

references

Summary by CodeRabbit

  • Chores
    • Updated the default logging destination from standard output to standard error, which may change where logs are visible if no specific log file is provided.

@mss
fix: Log to stderr per default
596112f 
This syncs the default value with the one shipped in `atmos.yaml`. It
avoids the logging bug in cloudposse#1026.
@mss mss requested a review from a team as a code owner February 5, 2025 13:34
@mergify mergify bot added the triage Needs triage label Feb 5, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

📝 Walkthrough

Walkthrough

This update changes the default logging output for Atmos. The persistent flag in the CLI command and the corresponding config variable have been updated to use "/dev/stderr" instead of "/dev/stdout". No changes have been made to the underlying logging logic; only the default destination for logs has been modified.

Changes

Files Change Summary
cmd/root.go, pkg/config/config.go Changed default log file destination from "/dev/stdout" to "/dev/stderr" in CLI flag and config.

Assessment against linked issues

Objective Addressed Explanation
Weird escape code issues with v1.158.0 [#1026] ✅

Possibly related PRs

Suggested labels

patch

Suggested reviewers

  • osterman
  • aknysh

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.
📜 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 300ca0f and 596112f.

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

186-186: LGTM! The default logging output is now synchronized.

The change aligns the default value with the default atmos.yaml configuration.

Let's verify that this change doesn't affect existing logging behavior:

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Search for any custom log file configurations in the codebase
rg -A 2 "logs-file|logs.file" --type yaml

Length of output: 6336

Default logging behavior verified:
The output from our search confirms that the atmos configuration files document the use of the logs-file flag with the same default (/dev/stderr) as set in cmd/root.go. There’s no evidence that the change inadvertently affects existing logging behavior.

pkg/config/config.go (1)

78-78: LGTM! The default config is now consistent.

The change ensures that the default CLI configuration matches the persistent flag's default value.

✨ 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.

@mergify mergify bot removed the triage Needs triage label Feb 5, 2025
@osterman osterman added the patch A minor, backward compatible change label Feb 5, 2025
@osterman
Copy link
Member

osterman commented Feb 5, 2025

@mss looks like snapshots need to be updated for a few tests.

https://github.com/cloudposse/atmos/actions/runs/13159121518/job/36723834716?pr=1028

Just run the following, replacing <failing test> with the test that needs a new snapshot.

go test ./tests -v -run 'TestCLICommands/<failing test>' -timeout 2m -regenerate-snapshots

@osterman
Copy link
Member

osterman commented Feb 5, 2025

works around (but does not fix) #1026.

Re: the "does not fix" part, is the issue when we write to /dev/stdout that the TTY is not rendering ansi?

@mss
Copy link
Contributor Author

mss commented Feb 5, 2025

works around (but does not fix) #1026.

Re: the "does not fix" part, is the issue when we write to /dev/stdout that the TTY is not rendering ansi?

Yes, as soon as the logging goes to stdout weird escape sequences appear. I guess the logging library (wasn't that changed recently?) is fighting with the regular colored output.

@osterman osterman mentioned this pull request Feb 5, 2025
Merged
@osterman
Copy link
Member

osterman commented Feb 5, 2025

@mss will fix this today in #1029

@aknysh aknysh closed this in #1029 Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@osterman osterman osterman approved these changes

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

No one assigned

Labels

patch A minor, backward compatible change

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mss @osterman @aknysh