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

fix(logger): respect log level from environment variable in dev mode #4083

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

meeehdi-dev
Copy link

@meeehdi-dev meeehdi-dev commented Feb 17, 2025

#4082

Summary by CodeRabbit

  • Refactor

    • Enhanced the logging configuration so that when a custom log level is explicitly set, it will take precedence over default settings. This improvement ensures more predictable and controlled log behavior based on your environment configurations.
  • Bug Fixes

    • Fixed a logger issue, improving overall logging functionality.

Copy link
Contributor

coderabbitai bot commented Feb 17, 2025

Walkthrough

This change updates the log level determination within the CreateApp function in the v2/internal/app/app_dev.go file. A new variable, appLogLevel, is introduced to initially capture the default log level from the application options. The code then checks for the presence of the loglevel environment variable and, if set along with an explicitly configured flag, overrides the default log level with the provided value. This modification refines the control flow for log level configuration without altering the overall application structure.

Changes

File(s) Change Summary
v2/internal/app/app_dev.go Updated log level logic: introduced appLogLevel to capture default value from app options; now conditionally overrides default with env var value if explicitly set.
website/src/pages/changelog.mdx Added entry in the changelog under "Fixed" section for logger issue resolution by @meeehdi-dev, complementing existing documentation.

Sequence Diagram(s)

sequenceDiagram
    participant App as CreateApp Function
    participant Env as Environment Variable ("loglevel")
    participant Options as AppOptions
    participant LogFlag as LogLevelFlag

    App->>Options: Retrieve default log level
    App->>Env: Check "loglevel" environment variable
    alt Environment variable is provided and flag is explicitly set
        App->>LogFlag: Set log level to env var value
    else
        App->>LogFlag: Set log level to default value
    end
Loading

Possibly related PRs

  • fix dev mode logging bug #3972: Modifies similar log level handling logic within the CreateApp function, refining the process of setting the log level based on the environment variable.

Poem

I'm a rabbit hopping with delight,
In code where log levels shine bright.
With env vars and defaults in play,
My little checks lead the way.
Hopping through changes in pure delight! 🐇✨


📜 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 a36870f and dea39fd.

📒 Files selected for processing (1)
  • website/src/pages/changelog.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • website/src/pages/changelog.mdx

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.
  • @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.

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: 0

🔭 Outside diff range comments (1)
v2/internal/app/app_dev.go (1)

97-105: ⚠️ Potential issue

Fix inconsistency in log level comparison.

The comparison at line 97 uses appoptions.LogLevel.String() instead of appLogLevel, which could lead to unexpected behavior when the environment variable is set. This means the environment variable value might be ignored when checking if the flag was explicitly set.

Apply this fix:

-if loglevelFlag != nil && devFlags.Lookup("loglevel").Value.String() != appoptions.LogLevel.String() {
+if loglevelFlag != nil && devFlags.Lookup("loglevel").Value.String() != appLogLevel {
🧹 Nitpick comments (1)
v2/internal/app/app_dev.go (1)

77-82: LGTM! Consider adding validation for environment variable value.

The changes improve the log level configuration by respecting the environment variable. However, consider validating the environment variable value before using it.

Add validation for the environment variable value:

 appLogLevel := appoptions.LogLevel.String()
 if loglevel != "" {
+    if loggerLevel, err := pkglogger.StringToLogLevel(loglevel); err == nil {
+        appLogLevel = loglevel
+    } else {
+        myLogger.Warning("Invalid log level in environment variable: %s", loglevel)
+    }
-    appLogLevel = loglevel
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f6aba68 and ba0b1c7.

📒 Files selected for processing (1)
  • v2/internal/app/app_dev.go (1 hunks)

@leaanthony
Copy link
Member

Thanks 🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

@meeehdi-dev
Copy link
Author

Thanks 🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

Sure no problem, do you also want me to rebase the branch or do you prefer handling it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants