pokt-network / poktroll

The official Shannon upgrade implementation of the Pocket Network Protocol implemented using Rollkit.dev
MIT License
15 stars 6 forks source link

[Observability] Add claim relays counter #644

Open bryanchriswhite opened 2 days ago

bryanchriswhite commented 2 days ago

Summary

image

NB: changes outlined in red.

Issue

Type of change

Select one or more:

Testing

Documentation changes (only if making doc changes)

Local Testing (only if making code changes)

PR Testing (only if making code changes)

Sanity Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 2 days ago

[!WARNING]

Rate limit exceeded

@bryanchriswhite has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 36 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between df546c635b8cbae4c625ae9be885f7cae89e7545 and 54b1c4c4a4abc7640091c66df15311c89a2a2616.

Walkthrough

The updates introduce significant changes to stress test dashboard metrics, telemetry counters, and logic in the tokenomics and proof modules. Key adjustments include restructuring telemetry tracking, refining claims handling, updating expression capitalizations in Grafana dashboards, and enhancing test file consistency.

Changes

Files Change Summary
localnet/grafana-dashboards/stress-test-dashboard.json Changes made to expr values, specifically altering the capitalization of metric filter strings for improved data aggregation and visualization.
telemetry/event_counters.go Enhanced error handling within ClaimRelaysCounter function by adding parameters and incorporating error labels without incrementing counters on failure.
x/proof/keeper/msg_server_create_claim.go Restructured telemetry tracking in CreateClaim function to differentiate counters for relays and compute units.
x/proof/keeper/msg_server_submit_proof.go Updated SubmitProof method to use ClaimRelaysCounter for tracking relays and rearranged arguments for better clarity.
x/tokenomics/keeper/settle_pending_claims.go Refactored SettlePendingClaims function, introducing structs settledResult and expiredResult for managing claim results, streamlining the control flow.
x/tokenomics/module/abci.go Modified EndBlocker function to utilize structured settledResult and expiredResult objects, enriched telemetry counters with additional relay and compute unit data.
x/tokenomics/types/types.go Introduced PendingClaimsResult struct and NewClaimSettlementResult function to initialize claim results data.
load-testing/tests/relays_stress_test.go Adjusted test file to replace references to plans with s.plans ensuring consistency in accessing data within the test suite.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Grafana
    participant Telemetry
    participant Tokenomics

    User->>Grafana: Update Dashboard (Capitalization changes)
    Grafana->>Telemetry: Query with uppercase strings

    User->>Tokenomics: SettlePendingClaims request
    Tokenomics->>Telemetry: Send claim result (settledResult, expiredResult)
    Tokenomics->>Telemetry: Increment counters (relays, compute units)

    User->>Tokenomics: CreateClaim request
    Tokenomics->>Telemetry: Track claim relays (ClaimRelaysCounter updated)

Poem

🐇 In dashboards bright and keen, strings now align,\ Telemetry counts each relay in time,\ Claims settled, results in structured rhyme,\ Errors watched, counters in prime.\ Our code refined, like a perfect chime,\ Metrics and tests, in sync they climb. 🌟


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.