coderabbitai[bot]
commented
4 months ago [!CAUTION]
Review failed
The pull request is closed.
Walkthrough
These changes integrate Prometheus metrics into the EVM gateway, significantly enhancing the monitoring of API errors and request response times. Key updates include modifications to the .gitignore and Makefile, the implementation of a metrics collection framework across various API files, and the introduction of configuration support for Prometheus scraping.
Changes
| Files | Change Summaries |
|---|---|
| .gitignore, Makefile | Updated .gitignore to include metrics/data/ and modified Makefile to remove metrics/data/ from the start-local target. |
| api/api.go, api/debug.go, api/server.go | Integrated Prometheus metrics collection into BlockChainAPI, DebugAPI, and httpServer for enhanced error tracking and request duration measurement. |
| bootstrap/bootstrap.go | Added a metrics server and collector for improved metrics tracking during server operations. |
| metrics/collector.go | Established a framework for metrics collection to monitor API performance and errors. |
| tests/helpers.go, tests/integration_test.go | Enhanced test configurations by adding the Prometheus configuration file path to support monitoring in tests. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant BlockChainAPI
participant MetricsCollector
participant Prometheus
User->>BlockChainAPI: Make API Request
BlockChainAPI->>MetricsCollector: Start Request Timer
BlockChainAPI->>BlockChainAPI: Process Request
alt Request Fails
BlockChainAPI->>MetricsCollector: Report API Error
end
BlockChainAPI->>MetricsCollector: Stop Request Timer
MetricsCollector->>Prometheus: Push Metrics Data
Prometheus->>User: Provide Metrics DataAssessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
| Integrate Prometheus to EVM gateway (#359) | ✅ |
Poem
In the code, metrics bloom,
Prometheus watches, no room for gloom.
Errors and times, all recorded fine,
EVM gateway shines, metrics align.
Data flows, insights show,
With Prometheus, we now know. 🐇✨
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?
illia-malachyn
sideninja
Closes: #359
This covers the following requirements:
Measure end-to-end request/response time by method call (track the time taken from the start of a request to the return of the response for each method call to understand relative performance and user experience using percentiles).
api_request_duration_seconds_bucketapi_request_duration_seconds_bucket{resolver="SendRawTransaction"}API requests per time interval metric
rate(api_request_duration_seconds_count{resolver="SendRawTransaction"}[5m])API calls by API endpoint (most used to least used calls)
sort_desc(sum by(resolver) (rate(api_request_duration_seconds_count{resolver="SendRawTransaction"}[5m])))API errors should be submitted to a counter metric
api_errors_totalSummary by CodeRabbit
Summary by CodeRabbit
New Features
Chores
.gitignoreto adjust directory exclusions.Makefileto clean up themetrics/data/directory before running the application.