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 13 forks source link

feat: allow ignoring denoms #73

Closed freak12techno closed 2 months ago

freak12techno commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

This update introduces the ability to ignore specific denominations (denoms) in various configurations and metric exports. By adding an ignore flag to the denoms array in the configuration, you can now exclude certain denominational data from metrics and processing logic. The changes span multiple files, adding checks to ensure exclusions and adjusted validations accordingly.

Changes

File/Group Change Summary
config.example.toml Added ignore field to denoms array to mark denominations for exclusion.
pkg/config/denom_info.go Updated DenomInfo struct and methods to handle the Ignore field.
pkg/generators/active_set_tokens.go Added checks to skip processing if the denomination should be ignored.
pkg/generators/balance.go Enhanced loops to skip balances with ignored denominations.
pkg/generators/commission.go Modified to bypass processing for ignored denominations.
pkg/generators/rewards.go Added conditions to skip ignored denomination rewards.
pkg/generators/self_delegation.go Implemented nil checks and ignored denomination logic.
pkg/generators/single_validator_info.go Incorporated new checks for delegations of ignored denominations.
pkg/generators/validators_info.go Added a new conditional to handle ignored denomination totals.
Test updates in pkg/generators/..._test.go Included tests for the new ignore functionality across different generators. Updated imports and assertions to align with new logic.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant ConfigParser as Config Parser
    participant DenomInfo as DenomInfo Struct
    participant MetricsExporter as Metrics Exporter

    User->>ConfigParser: Provide config with denoms
    ConfigParser->>DenomInfo: Parse denoms with `ignore` field
    DenomInfo->>MetricsExporter: Skip denoms with `ignore=true`
    MetricsExporter-->>User: Export metrics excluding ignored denoms

Poem

In the den of code, some coins take flight, An option to ignore them feels just right. With careful checks, we ensure our task, Denominations hidden, no need to ask. Metrics clean and crisp, with ease they flow, A rabbit's touch in the silence of code. 🐇✨


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 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (3a4edb8) to head (b1262f4).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #73 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 63 63 Lines 2567 2585 +18 ========================================= + Hits 2567 2585 +18 ```

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