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

feat: add default logger level setting to set the logger level to dis… #2451

Merged
merged 1 commit into from
Jan 17, 2025

Conversation

snobbee
Copy link
Contributor

@snobbee snobbee commented Jan 17, 2025

Relates to

No linked issue.

Risks

Low.
This change introduces a default logger level, which affects logging outputs. Potential risks include unexpected logging behavior if the DEFAULT_LOG_LEVEL environment variable is misconfigured or missing.

Background

What does this PR do?

This PR introduces a default logger level setting, allowing developers to set the logging verbosity through a DEFAULT_LOG_LEVEL environment variable. If the variable is not set, the logger defaults to "info" level.

What kind of change is this?

  • Features: Adds functionality to configure the default logger level via an environment variable.

Documentation changes needed?

My changes require a change to the project documentation.

  • Add details about the new DEFAULT_LOG_LEVEL environment variable in the relevant setup/configuration documentation.

Testing

Where should a reviewer start?

  • Review changes in .env.example for the new environment variable.
  • Review the implementation in packages/core/src/logger.ts for setting the logger level.

Detailed testing steps

  1. Add DEFAULT_LOG_LEVEL to your .env file and set it to a specific value (e.g., debug).
  2. Start the application.
  3. Verify that the logs are displayed according to the specified level.
  4. Remove DEFAULT_LOG_LEVEL from .env and restart the application.
  5. Verify that the logs default to the info level.

Screenshots

No UI changes.

Deploy Notes

No specific deployment changes. Ensure the .env file includes the new DEFAULT_LOG_LEVEL variable, if desired, for customized logging behavior.

Database changes

None.

Deployment instructions

No additional instructions. Standard deployment process applies.

Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

📝 Walkthrough

Walkthrough

The pull request introduces a new configuration mechanism for logging levels across the application. By adding a DEFAULT_LOG_LEVEL environment variable in the .env.example file and modifying the logger configuration, the system now supports dynamic log level configuration with a default setting of "info" if no specific level is specified.

Changes

File Change Summary
.env.example Added DEFAULT_LOG_LEVEL=info configuration variable under logging section
packages/core/src/logger.ts Introduced defaultLevel constant to retrieve log level from environment variable, updated options object to use dynamic log level

📜 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 94ee57b and 8e5de7b.

📒 Files selected for processing (2)
  • .env.example (1 hunks)
  • packages/core/src/logger.ts (1 hunks)
🔇 Additional comments (3)
packages/core/src/logger.ts (2)

29-30: LGTM! Clean implementation of default level.

The implementation correctly uses optional chaining and nullish coalescing for safe environment variable access.


32-32: LGTM! Proper integration with logger options.

The defaultLevel is correctly applied to the logger configuration.

.env.example (1)

22-22: LGTM! Well-documented environment variable.

The new variable is properly placed in the Logging section with a sensible default value.

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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

@wtfsayo wtfsayo merged commit 9e0af0e into elizaOS:develop Jan 17, 2025
6 of 7 checks passed
@snobbee snobbee deleted the feat/default-logger-level branch January 24, 2025 22:49
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