Skip to content

fix(structured_logs): Remove prefix#443

Merged
msukkari merged 2 commits intomainfrom
msukkarieh/log_prefix
Aug 7, 2025
Merged

fix(structured_logs): Remove prefix#443
msukkari merged 2 commits intomainfrom
msukkarieh/log_prefix

Conversation

@msukkari
Copy link
Contributor

@msukkari msukkari commented Aug 7, 2025 •
edited by coderabbitai bot
Loading

Fixes #437

@GabDug

Summary by CodeRabbit

  • New Features
    • Output prefixing can now be conditionally disabled by setting an environment variable.
  • Behavior Changes
    • When structured logging is enabled, output will no longer be prefixed. Otherwise, original prefixing behavior remains.
  • Bug Fixes
    • Removed unwanted prefix from structured log output for clearer logs.

@msukkari msukkari requested a review from brendan-kellam August 7, 2025 17:36
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 7, 2025 •
edited
Loading

Walkthrough

The prefix-output.sh script was updated to conditionally prefix output lines based on the SOURCEBOT_STRUCTURED_LOGGING_ENABLED environment variable. If this variable is set to "true", the script runs the command without prefixing; otherwise, it prefixes each output line with the process name. No changes were made to public interfaces. Additionally, the changelog was updated with a fixed entry documenting this change.

Changes

Cohort / File(s) Change Summary
Conditional Output Prefixing
prefix-output.sh		 Added logic to check SOURCEBOT_STRUCTURED_LOGGING_ENABLED and conditionally apply output prefixing.
Changelog Update
CHANGELOG.md		 Added a "Fixed" entry under "Unreleased" documenting the removal of prefix from structured log output.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

A rabbit hopped with bashful pride,
Tweaked scripts where log lines used to hide.
Now with a check for logging true,
The prefixes may bid adieu.
If not, the names still lead the way—
A tidy log for every day!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 34b1f49 and a4df266.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch msukkarieh/log_prefix

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
  • 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 explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate unit tests to generate unit tests for 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.

@github-actions

This comment has been minimized.

Sign in to view
coderabbitai[bot]
coderabbitai bot reviewed Aug 7, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (2)
prefix-output.sh (2)

5-9: Make the feature-flag check more robust
The comparison is case-sensitive and treats any non-"true" value (including "TRUE" or "1") as disabled. Consider normalising or using a shell pattern:

case "${SOURCEBOT_STRUCTURED_LOGGING_ENABLED,,}" in
  true|1|yes) exec "$@";;
esac

This allows intuitive truthy values while keeping current behaviour the default.

1-1: Filename deviates from camelCase guideline
prefix-output.sh is kebab-case; the coding guidelines mandate camelCase unless neighbouring files use a different scheme. Rename to prefixOutput.sh for consistency.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a3d9711 and 34b1f49.

📒 Files selected for processing (1)
  • prefix-output.sh (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*

📄 CodeRabbit Inference Engine (.cursor/rules/style.mdc)

Filenames should always be camelCase. Exception: if there are filenames in the same directory with a format other than camelCase, use that format to keep things consistent.

Files:

  • prefix-output.sh
🪛 Shellcheck (0.10.0)
prefix-output.sh

[warning] 11-11: In POSIX sh, process substitution is undefined.

(SC3001)

[warning] 12-12: In POSIX sh, process substitution is undefined.

(SC3001)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build

@msukkari msukkari merged commit 6a60187 into main Aug 7, 2025
6 checks passed
@brendan-kellam brendan-kellam mentioned this pull request Aug 12, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@brendan-kellam brendan-kellam brendan-kellam approved these changes

Assignees

No one assigned

Labels

sourcebot-team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@msukkari @brendan-kellam