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

chore: incorrect error usage in the logs #175

Merged
merged 1 commit into from
Jun 4, 2024

Conversation

rustatian
Copy link
Member

@rustatian rustatian commented Jun 4, 2024

Reason for This PR

"msg":"plugin returned an error from the Serve ","!BADKEY":"/roadrunner-temporal/plugin.go:196: github.com/temporalio/roadrunner-temporal/v4.(*Plugin).Serve.func1: temporal_plugin_serve: error during reset: &errors.Error{Op:\"workflow_definition_init\", Kind:0xc8, Err:(*errors.Error)(0xc000964aa0), Raised:\"2024-06-04T14:39:28+02:00\", stack:errors.stack{callers:[]uintptr{0x105de9488, 0x105df2fd0, 0x105df33ec, 0x105df0034, 0x105df1b98, 0x105ea643c, 0x105ea6508, 0x105eacca4, 0x105eab58c, 0x104fe0954}}}, event: process exited, pid: 16762","plugin":"*rrtemporal.Plugin"

Description of Changes

  • Use slog.Any for the errors.

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the MIT license.

PR Checklist

[Author TODO: Meet these criteria.]
[Reviewer TODO: Verify that these criteria are met. Request changes if not]

  • All commits in this PR are signed (git commit -s).
  • The reason for this PR is clearly provided (issue no. or explanation).
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this PR.
  • Any user-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.

Summary by CodeRabbit

  • Bug Fixes
    • Improved error logging to provide more detailed and accurate error messages during plugin operations.

Signed-off-by: Valery Piashchynski <[email protected]>
@rustatian rustatian added the C-Enhancement Category: enhancement label Jun 4, 2024
@rustatian rustatian requested a review from wolfy-j June 4, 2024 12:40
@rustatian rustatian self-assigned this Jun 4, 2024
Copy link

coderabbitai bot commented Jun 4, 2024

Walkthrough

The recent updates enhance error logging in the Endure struct's poll and stop methods. By switching to slog.Any for error messages, the logs now provide more detailed and structured information about errors encountered during the Serve and stop processes. This change improves debugging and error handling capabilities.

Changes

File Change Summary
poller.go Updated error logging in the poll method to use slog.Any for more detailed error information.
stop.go Modified error logging in the stop method to use slog.Any for better error handling.

Poem

In code's deep forest, where errors roam,
We’ve built a bridge to bring them home.
With slog.Any, our path is clear,
To catch each bug, both far and near.
Now logs will sing a truthful song,
In Endure’s realm, where we belong.


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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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

@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 02d7980 and c5dffb7.

Files ignored due to path filters (1)
  • go.work.sum is excluded by !**/*.sum
Files selected for processing (2)
  • poller.go (1 hunks)
  • stop.go (1 hunks)
Additional context used
golangci-lint
poller.go

8-8: undefined: Endure (typecheck)


24-24: undefined: Endure (typecheck)


9-9: undefined: result (typecheck)


29-29: undefined: Result (typecheck)

stop.go

15-15: undefined: Endure (typecheck)


35-35: undefined: Service (typecheck)


41-41: undefined: StopMethodName (typecheck)

Additional comments not posted (2)
poller.go (1)

15-15: LGTM! The use of slog.Any for error logging enhances the clarity and specificity of the log messages.

stop.go (1)

56-56: LGTM! The updated error logging using slog.Any is consistent with the PR objectives and improves the clarity of the log messages.

@rustatian rustatian merged commit bb96681 into master Jun 4, 2024
6 checks passed
@rustatian rustatian deleted the chore/error_usage_in_logs branch June 4, 2024 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Enhancement Category: enhancement
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

1 participant