search

onflow / flow-evm-gateway

FlowEVM Gateway implements an Ethereum-equivalent JSON-RPC API for EVM clients to use
https://developers.flow.com/evm/about
Apache License 2.0
11 stars 10 forks source link

Ingestion index health metric #409

Closed illia-malachyn closed 3 months ago

illia-malachyn commented 3 months ago

This covers "Ingestion index health is a boolean value that is being set to false if the latest indexed EVM height falls behind the latest EVM height by X".

This PR is based on top of https://github.com/onflow/flow-evm-gateway/pull/406

I'm pushing a straightforward variation to keep things simple. However, the fact that I need to add a getter to a collector makes it look odd. I'm not sure if there's a way to avoid this

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

This update enhances the application's metrics collection and monitoring capabilities by introducing new parameters and structures related to ingestion index health. Key modifications include the integration of a metrics collector in various functions and the addition of configurable parameters for monitoring ingestion index health. Overall, these changes improve observability and allow for better performance tracking and issue diagnosis within the event ingestion process.

Changes

Files Change Summary
bootstrap/bootstrap.go, config/config.go, services/ingestion/engine.go, services/ingestion/engine_test.go, tests/helpers.go, tests/integration_test.go Added new metrics collector parameter and ingestion index health configuration options, improving monitoring and observability capabilities.
metrics/collector.go, metrics/noop_collector.go, metrics/ingestion_index_health_tracker.go Expanded Collector interface and NoopCollector, introduced IngestionIndexHealthTracker for monitoring ingestion index health.
go.mod Updated dependencies, adding github.com/prometheus/client_model as a direct dependency.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Application
    participant Collector
    participant EVM

    User->>Application: Start Ingestion
    Application->>Collector: Initialize metrics collector
    Application->>EVM: Get latest block height
    Application->>Collector: Report EVM block indexed
    Application->>Collector: Check Ingestion Index Health
    EVM-->>Application: Return block height
    Application->>Collector: Update health status

🐰 Hop, hop, the changes are grand,
Metrics to track, oh how they expand!
Ingestion health, we’ll monitor tight,
With each indexed block, our future looks bright!
Collecting the data, we’re swift as a hare,
Performance and insights, we’ll always be aware! 🌟

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
illia-malachyn commented 3 months ago

As we talked about before, we're postponing this PR because it might not be needed. We have EVM block height in this PR https://github.com/onflow/flow-evm-gateway/pull/406. We also might have the network height as a metric in flow-go repo. So, we will reuse those to create index health in Grafana tracking the difference between two metrics.