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 inflation metric #77

Closed freak12techno closed 3 months ago

freak12techno commented 3 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes introduce robust functionalities for handling inflation data within the application. Key additions include an inflation JSON configuration file, a dedicated fetcher and generator for inflation data, and an enhanced RPC structure for querying inflation metrics. These updates streamline data retrieval and monitoring, laying the groundwork for comprehensive financial analysis capabilities.

Changes

Files Change Summary
assets/inflation.json Added a JSON file with a high-precision inflation rate.
pkg/app.go Enhanced NewApp function by adding inflation fetcher and generator instances.
pkg/constants/constants.go Introduced FetcherNameInflation constant for improved data fetching.
pkg/fetchers/inflation.go Implemented InflationFetcher for fetching inflation data; added methods and struct definitions.
pkg/fetchers/inflation_test.go Added unit tests for the InflationFetcher functionality.
pkg/generators/inflation.go Defined InflationGenerator for generating inflation metrics; included methods for metric collection.
pkg/generators/inflation_test.go Added unit tests for the InflationGenerator functionality.
pkg/tendermint/rpc.go Introduced GetInflation method in RPC struct to fetch inflation data from a URL.
pkg/types/tendermint.go Added InflationResponse type to model inflation data responses.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App as Application
    participant Fetcher as InflationFetcher
    participant RPC as RPC Client
    participant Generator as InflationGenerator
    participant Metrics as Prometheus

    User->>App: Request Inflation Data
    App->>Fetcher: Fetch Inflation Data
    Fetcher->>RPC: GetInflation()
    RPC-->>Fetcher: Return InflationResponse
    Fetcher-->>App: Provide Inflation Data
    App->>Generator: Generate Metrics
    Generator->>Metrics: Collect Inflation Metrics
    Metrics-->>App: Metrics Updated
    App-->>User: Respond with Inflation Data

Poem

πŸ‡ In fields of data, I hop and play,
With inflation metrics brightening the day.
Fetchers and generators, a wondrous sight,
Helping us measure with all of their might!
So let’s cheer for changes, both big and small,
A leap in our app, we celebrate all! πŸŽ‰


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

Codecov Report

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

Project coverage is 100.00%. Comparing base (058a297) to head (4a1f2c4).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #77 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 63 65 +2 Lines 2585 2657 +72 ========================================= + Hits 2585 2657 +72 ```

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