search

QuokkaStake / cosmos-validators-exporter

A Prometheus exporter to fetch data about your validators in Cosmos-based blockchains.
GNU General Public License v3.0
12 stars 14 forks source link

feat: refactor add consumer needs to sign metric #67

Closed freak12techno closed 4 months ago

freak12techno commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The update introduces new fetchers and generators to the NewApp function, making significant alterations to the structure and functionality of components in the codebase. It adds a ValidatorConsumersFetcher to gather validator consumer data and a ConsumerNeedsToSignGenerator to generate metrics related to consumer chains. Additionally, the changes include reordering constants, adding new structs, and new test functions to ensure the correctness of the implementations.

Changes

Files Change Summaries
pkg/app.go Added ValidatorConsumersFetcher and ConsumerNeedsToSignGenerator in NewApp function.
pkg/constants/constants.go Reordered and renamed FetcherName constants. Added FetcherNameValidatorConsumers.
pkg/fetchers/has_to_validate.go Introduced ValidatorConsumersFetcher struct and related methods.
pkg/generators/consumer_needs_to_sign.go, pkg/generators/consumer_needs_to_sign_test.go Added ConsumerNeedsToSignGenerator struct, methods for Prometheus metrics, and test functions.
pkg/tendermint/rpc.go Added GetValidatorConsumerChains function.
pkg/types/tendermint.go Added ValidatorConsumerChains struct.
assets/validator-consumers.json Introduced JSON object with a list of consumer chain IDs.
pkg/fetchers/has_to_validate_test.go Added comprehensive test functions for ValidatorConsumersFetcher.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App as NewApp
    participant Fetcher as ValidatorConsumersFetcher
    participant Generator as ConsumerNeedsToSignGenerator
    participant RPC as RPC.GetValidatorConsumerChains
    User->>App: Initialize NewApp
    App->>Fetcher: Add ValidatorConsumersFetcher
    App->>Generator: Add ConsumerNeedsToSignGenerator
    Fetcher->>RPC: Fetch validator consumer data
    RPC-->>Fetcher: Return validator consumer chains
    Generator->>App: Generate metrics
    App-->>User: Return initialized App

Poem

A rabbit hops, code changes spring,
Fetchers and generators bring a zing,
Validators, consumers, all in queue,
New data fetched, metrics to view.
Chains align in perfect rhyme,
Our app evolves one hop at a time.
🌟🐇✨

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 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](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.
codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 98.01980% with 2 lines in your changes missing coverage. Please review.

Project coverage is 90.54%. Comparing base (abe5308) to head (4b559cc).

Files Patch % Lines
pkg/app.go 0.00% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #67 +/- ## ========================================== + Coverage 90.22% 90.54% +0.32% ========================================== Files 58 60 +2 Lines 2301 2402 +101 ========================================== + Hits 2076 2175 +99 - Misses 224 226 +2 Partials 1 1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.