Use a single logger instance

[boekkooi-fresh]

By using a single logger instance we avoid adding log entries to the logs written by Stack.summarizePlanAllErrors.

Summary by CodeRabbit

• Refactor
  • Updated how logging context is handled, now extending the existing logger with additional information instead of creating a new instance.
  • Removed an unused logging utility function, streamlining internal logging behavior.

No user-facing features or visible changes in functionality.

[brikis98]

Thanks for the PR! Could you provide a bit more context on what this does? What's the issue you're trying to fix? What does the log output look like now and what will it look like with this change?

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for submitting this pull request.

[coderabbitai]

Walkthrough

This update tweaks how logging is handled when cloning TerragruntOptions. Instead of creating a brand-new logger every time, the code now reuses the existing logger and simply adds a working directory prefix for context. The helper function that built new logger entries with custom writers has been removed, and the cloning logic now attaches the prefix directly. No changes were made to method signatures, but the internal approach to logger management is streamlined and less redundant.

Changes

File(s)	Change Summary
options/options.go	Updated TerragruntOptions.Clone to reuse the existing logger and add a "prefix" field instead of creating a new logger instance.
util/logger.go	Removed the CreateLogEntryWithWriter function and its related imports (fmt, io).

Poem

Logs once cloned with brand new flair,
Now just add a prefix—less wear and tear!
Out goes the helper, no more to write,
Logger’s reused, the change feels right.
A simpler path, with context in tow,
Terragrunt’s loggers now easier to know.
🪵✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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 to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

options/options.go (1)

264-264: Good change to reuse the logger instance 👍

This is a smart improvement! Instead of creating a completely new logger each time we clone the options, we're now reusing the existing logger and just adding contextual information with the WithField method.

This approach:

1. Prevents duplicate log entries (the main goal of this PR)
2. Maintains the logging context while adding new information
3. Is more efficient than creating new logger instances

The logrus library is designed exactly for this use case - creating derived loggers with additional context.

You might consider using a more descriptive field name like "workingDir" instead of "prefix" to make it even clearer what this field represents in the logs.

-Logger: terragruntOptions.Logger.WithField("prefix", workingDir),
+Logger: terragruntOptions.Logger.WithField("workingDir", workingDir),

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aff9c3e and 813ad75.

📒 Files selected for processing (2)

• options/options.go (1 hunks)
• util/logger.go (0 hunks)

💤 Files with no reviewable changes (1)

• util/logger.go

[yhakbar]

This has gone stale. I'm sorry about that @boekkooi-fresh .

We've done quite a bit of work on our logging, and we hope this is resolved.