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: add supply metric #78

Closed freak12techno closed 3 months ago

freak12techno commented 3 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

This update introduces a comprehensive token supply management system, encompassing the creation of new fetchers and generators, enhanced error handling, and detailed testing. Key components include a structured JSON representation of token supply, new functionality to fetch and generate supply metrics, and robust testing to ensure reliability across multiple scenarios.

Changes

Files Change Summary
assets/supply.json New JSON structure for token supply with denomination and pagination metadata.
pkg/app.go, pkg/fetchers/supply.go, pkg/generators/supply.go Introduced NewSupplyFetcher and NewSupplyGenerator for handling supply data in the application.
pkg/app_test.go Added nil check for request body in health check test to prevent runtime panic.
pkg/constants/constants.go Introduced FetcherNameSupply constant for unified fetcher naming.
pkg/fetchers/supply.go Implemented SupplyFetcher struct for concurrent fetching of supply data from multiple chains.
pkg/fetchers/supply_test.go Added unit tests for SupplyFetcher covering various scenarios like success, errors, and disabled queries.
pkg/generators/supply.go Created SupplyGenerator for generating Prometheus metrics related to supply data.
pkg/generators/supply_test.go Unit tests for SupplyGenerator, validating behavior with empty and populated states.
pkg/tendermint/rpc.go Introduced GetTotalSupply method in RPC struct to fetch total token supply.
pkg/types/tendermint.go Added SupplyResponse struct to represent supply-related data responses.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant SupplyFetcher
    participant RPC

    User->>App: Request Supply Data
    App->>SupplyFetcher: Fetch Supply Data
    SupplyFetcher->>RPC: GetTotalSupply()
    RPC-->>SupplyFetcher: Return Supply Data
    SupplyFetcher-->>App: Supply Data
    App-->>User: Supply Data

πŸ°πŸ’– "In fields of code where bunnies hop,
New features bloom, our hearts won't stop!
Fetchers and generators, all in a line,
Metrics and supplies, oh, how they shine!
With tests that guard and ensure delight,
Our token tale is now just right!" 🌼✨


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.