-
Notifications
You must be signed in to change notification settings - Fork 0
EndpointAvailability #12
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @auricom, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the monitoring capabilities for JSON-RPC endpoints by introducing a dedicated metric for tracking endpoint availability and refining the existing request duration metrics. These changes provide more granular insights into the health and performance of connected EVM nodes, allowing for better operational visibility and faster detection of potential issues. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces metrics for endpoint availability and improves JSON-RPC request duration monitoring by using a summary for percentile tracking instead of a static SLO gauge. The changes are logical and well-implemented. I've provided two suggestions for improvement: one to enhance build reproducibility by pinning the Go version in mise.toml, and another to refactor a small piece of code in internal/jsonrpc/monitor.go to be more concise and adhere to the DRY principle.
| if err != nil { | ||
| // Record endpoint as unreachable | ||
| m.RecordEndpointAvailability(chainID, evmClient.GetRPCURL(), false) | ||
| return err | ||
| } | ||
|
|
||
| // Record endpoint as reachable | ||
| m.RecordEndpointAvailability(chainID, evmClient.GetRPCURL(), true) | ||
| m.RecordJsonRpcRequestDuration(chainID, duration) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The logic for recording endpoint availability is present in both the success and failure paths of the health check, leading to some code repetition. You can make this more concise and adhere to the DRY (Don't Repeat Yourself) principle by recording the availability based on the error status before checking the error, and then returning if an error occurred.
| if err != nil { | |
| // Record endpoint as unreachable | |
| m.RecordEndpointAvailability(chainID, evmClient.GetRPCURL(), false) | |
| return err | |
| } | |
| // Record endpoint as reachable | |
| m.RecordEndpointAvailability(chainID, evmClient.GetRPCURL(), true) | |
| m.RecordJsonRpcRequestDuration(chainID, duration) | |
| m.RecordEndpointAvailability(chainID, evmClient.GetRPCURL(), err == nil) | |
| if err != nil { | |
| return err | |
| } | |
| m.RecordJsonRpcRequestDuration(chainID, duration) |
| @@ -0,0 +1,2 @@ | |||
| [tools] | |||
| go = "latest" | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using go = "latest" can lead to non-reproducible builds. When a new version of Go is released, your build environment could change unexpectedly, potentially causing build failures or introducing subtle bugs. It is a best practice to pin dependencies and tool versions to ensure consistent builds across all environments. The go.mod file specifies version 1.24.6, so it would be best to align with that here.
| go = "latest" | |
| go = "1.24.6" |
Overview