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

Add crash logger #254

Merged
merged 2 commits into from
May 20, 2024
Merged

Add crash logger #254

merged 2 commits into from
May 20, 2024

Conversation

devbugging
Copy link
Contributor

@devbugging devbugging commented May 20, 2024

Closes: #236

Description

This PR builds on #243 with few changes


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the standards mentioned here.
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

Summary by CodeRabbit

  • New Features
    • Enhanced logging functionality for the server, improving transparency and debugging capabilities.

Copy link
Contributor

coderabbitai bot commented May 20, 2024

Walkthrough

The api/server.go file has been updated to enhance logging functionality by incorporating the gethLog package from github.com/onflow/go-ethereum/log. The NewHTTPServer function now includes detailed logging to improve crash reporting and debugging.

Changes

File Change Summary
api/server.go Added import statement for gethLog and enhanced NewHTTPServer with logging functionality using gethLog.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Improve crash reporting (#236)
Log the stack for debugging purposes (#236)
Implement recovery inside APIs (#236)

Poem

In code we trust, with logs we see,
The crashes caught, our minds set free.
The server hums, with gethLog near,
Debugging now, we have no fear.
🐇✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 21099e0 and 01c8a35.
Files selected for processing (1)
  • api/server.go (3 hunks)
Additional comments not posted (2)
api/server.go (2)

20-20: Added import for enhanced logging capabilities.

This import is essential for the new logging functionality described in the PR.


56-67: Enhanced logging mechanism implemented in NewHTTPServer.

The switch-case handling for different log levels is a robust way to ensure that logs are appropriately categorized and recorded. This change aligns well with the PR's objectives.

@devbugging devbugging merged commit 51cbb25 into main May 20, 2024
2 checks passed
@m-Peter m-Peter deleted the gregor/error-log branch July 29, 2024 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Improve crash reporting
2 participants