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

Use new logging framework #62

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Use new logging framework #62

merged 2 commits into from
Jan 15, 2025

Conversation

jschlyter
Copy link
Member

@jschlyter jschlyter commented Jan 15, 2025

Summary by CodeRabbit

Release Notes

  • New Features

    • Added option to enable JSON logging via command-line argument
    • Enhanced logging configuration with more flexible log level settings
  • Dependencies

    • Updated dnstapir package to version v1.3.0
  • Version

    • Incremented project version to 1.1.0.dev3

@jschlyter jschlyter requested a review from a team as a code owner January 15, 2025 07:28
Copy link

coderabbitai bot commented Jan 15, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • poetry.lock is excluded by !**/*.lock

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces modifications to the evrec/server.py and pyproject.toml files. In server.py, the logging configuration has been refactored with a new setup_logging function that provides more flexible logging options, including a new --log-json command-line argument. The pyproject.toml file has been updated with a version increment and an updated dependency for the dnstapir package.

Changes

File Changes
evrec/server.py - Replaced configure_json_logging() with setup_logging() function
- Added --log-json CLI argument
- Improved logging configuration with dynamic log level setting
pyproject.toml - Bumped version from "1.1.0.dev1" to "1.1.0.dev3"
- Updated dnstapir dependency from v1.2.3 to v1.3.0

Poem

🐰 Logging leaps with JSON's grace,
Configurations now embrace
A cleaner, brighter debug space!
Version bumps and packages dance,
In CodeRabbit's coding trance! 🔍


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

@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

🧹 Nitpick comments (1)
evrec/server.py (1)

135-135: Consider adding error handling for logging setup.

While the logging setup looks correct, it would be beneficial to add error handling in case the logging configuration fails. This is particularly important as it's a critical initialization step.

-    setup_logging(json_logs=args.log_json, log_level="DEBUG" if args.debug else "INFO")
+    try:
+        setup_logging(json_logs=args.log_json, log_level="DEBUG" if args.debug else "INFO")
+    except Exception as e:
+        print(f"Failed to configure logging: {e}", file=sys.stderr)
+        sys.exit(1)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5b601e7 and 643503e.

⛔ Files ignored due to path filters (1)
  • poetry.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • evrec/server.py (3 hunks)
  • pyproject.toml (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • pyproject.toml
🔇 Additional comments (3)
evrec/server.py (3)

15-15: LGTM! Clean import of the new logging setup function.

The import is well-organized and follows the existing import structure.


125-125: LGTM! Well-structured CLI argument addition.

The --log-json argument follows consistent naming and documentation patterns with existing arguments.


135-135: Verify compatibility with existing log consumers.

Since this change modifies the logging configuration, please ensure that:

  1. Existing log consumers can handle both JSON and non-JSON formats
  2. Log levels are properly recognized by log aggregation systems
  3. No critical log fields are missing in the new format
✅ Verification successful

Logging changes are safe to proceed

The logging setup is minimal and uses standard practices:

  • Uses an established logging module (dnstapir.logging)
  • Standard log levels (DEBUG/INFO)
  • Simple log messages without complex formatting
  • JSON logging is optional and controlled by a flag
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for log parsing or processing logic in the codebase
rg -g '!*.pyc' -g '!*.log' -A 3 'logging\.(debug|info|warning|error|critical)'

# Look for log configuration files
fd -e yaml -e yml -e json -e conf -e config --exec grep -l 'log'

Length of output: 676


Script:

#!/bin/bash
# Find setup_logging implementation
ast-grep --pattern 'def setup_logging($$$)'

# Search for any logging configuration or setup
rg -g '!*.pyc' 'setup_logging|logging\.basicConfig|logging\.config'

# Search for any log format strings or handlers
rg -g '!*.pyc' 'logging\.(Formatter|Handler|FileHandler|StreamHandler)'

Length of output: 352

@jschlyter jschlyter merged commit 957801f into main Jan 15, 2025
5 checks passed
@jschlyter jschlyter deleted the structlog branch January 15, 2025 07:31
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.

1 participant