[OTE-849] Add metrics to track revenue shares #2449

affanv14 · 2024-10-03T14:56:08Z

Changelist

Adding metrics to track unconditional and affiliate rev shares
Also added metrics to track remaining fees after revshare is subtracted

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

New Features
- Introduced new constants for tracking affiliate and unconditional revenue share distributions.
- Enhanced metrics for revenue share processing, allowing for more detailed tracking of different revenue share types.
- Added new metric for tracking net fees post-revenue share distribution.
- Added a new metric emission for the fee collector share to improve visibility into fee distribution.
Bug Fixes
- Improved error handling for invalid revenue share types during asset transfers.

linear · 2024-10-03T14:56:11Z

OTE-849 Emit metrics to track revshare

coderabbitai · 2024-10-03T14:56:16Z

Warning

Rate limit exceeded

@affanv14 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 34 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 for further information.

📥 Commits

Files that changed from the base of the PR and between a04d5da and 2832216.

Walkthrough

The changes in this pull request introduce new constants in the protocol/lib/metrics/constants.go file related to revenue share distributions for subaccounts. Additionally, the protocol/x/subaccounts/keeper/transfer.go file has been modified to enhance the handling of revenue share metrics, incorporating new logic for different types of revenue shares and improving error handling. These adjustments aim to provide more granular metrics and better visibility into the fee distribution process.

Changes

File Path	Change Summary
`protocol/lib/metrics/constants.go`	Added four new constants: `AffiliateRevenueShareDistribution`, `UnconditionalRevenueShareDistribution`, `NetFeesPostRevenueShareDistribution`, and `RevenueShareDistribution`.
`protocol/x/subaccounts/keeper/transfer.go`	Enhanced revenue share metrics handling, added error logging for invalid types, and introduced a new metric for the fee collector share.

Possibly related PRs

[TRA-444] Emit a metric to record market mapper revenue per market #1810: Adds a new constant MarketMapperRevenueDistribution in the same constants.go file, related to revenue sharing metrics.
[OTE-777][OTE-690][OTE-688] Update clob code to add revshare logic #2251: Updates the clob code to add revenue share logic, directly relating to the revenue sharing constants introduced in the main PR.
Update GetAllRevshare to handle liquidations #2413: Enhances the revenue sharing logic in the GetAllRevShares method, closely related to the changes made in the main PR regarding revenue share constants and calculations.

Suggested labels

feature:indexer/affiliates

Suggested reviewers

vincentwschau
teddyding

🐇 In the land of metrics, constants grow,
Affiliate shares, now in a row.
Revenue flows, with labels so bright,
Error handling shines, a newfound light.
Hopping through changes, we track with glee,
A world of data, for you and me! 🌟

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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 using 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (1)

protocol/x/subaccounts/keeper/transfer.go (1)
302-302: Typo in comment: "fee colletor" should be "fee collector"

There's a typographical error in the comment. Correcting it improves code readability.

Apply this diff to fix the typo:
-       // Emit fee colletor metric
+       // Emit fee collector metric

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 12c2ee9 and 163a3e0.

📒 Files selected for processing (2)

protocol/lib/metrics/constants.go (1 hunks)
protocol/x/subaccounts/keeper/transfer.go (2 hunks)

protocol/lib/metrics/constants.go

protocol/x/subaccounts/keeper/transfer.go

teddyding · 2024-10-03T16:12:00Z

protocol/x/subaccounts/keeper/transfer.go

+		labels := []metrics.Label{}
+		var metricName string
+		switch revShare.RevShareType {
+		case revsharetypes.REV_SHARE_TYPE_MARKET_MAPPER:


This switching casing code seems redundant, why not just emit a generic rev share variable with the rev share type + recipient as labels?

If you need a separate metrics for market_mapper, then conditionally add a marketId label if revShare.RevShareType == revsharetypes.REV_SHARE_TYPE_MARKET_MAPPER

Wanted to keep existing metric as is for marketmapper

Will update the other metrics though!

affanv14 · 2024-10-03T18:40:17Z

@Mergifyio backport release/protocol/v7.x

mergify · 2024-10-03T18:40:23Z

backport release/protocol/v7.x

✅ Backports have been created

#2457 [OTE-849] Add metrics to track revenue shares (backport #2449) has been created for branch release/protocol/v7.x

(cherry picked from commit c87960e)

Co-authored-by: Mohammed Affan <[email protected]>

affanv14 requested a review from a team as a code owner October 3, 2024 14:56

github-actions bot added the protocol label Oct 3, 2024

coderabbitai bot reviewed Oct 3, 2024

View reviewed changes

protocol/lib/metrics/constants.go Outdated Show resolved Hide resolved

protocol/x/subaccounts/keeper/transfer.go Outdated Show resolved Hide resolved

protocol/x/subaccounts/keeper/transfer.go Outdated Show resolved Hide resolved

affanv14 force-pushed the affan/revshare-stats branch from 163a3e0 to e59632e Compare October 3, 2024 15:08

add metrics to track revenue shares

e3a56ac

affanv14 force-pushed the affan/revshare-stats branch from e59632e to e3a56ac Compare October 3, 2024 15:09

teddyding reviewed Oct 3, 2024

View reviewed changes

affanv14 force-pushed the affan/revshare-stats branch 2 times, most recently from 775974e to bcbf113 Compare October 3, 2024 18:12

changes

2832216

affanv14 force-pushed the affan/revshare-stats branch from bcbf113 to 2832216 Compare October 3, 2024 18:12

vincentwschau approved these changes Oct 3, 2024

View reviewed changes

affanv14 merged commit c87960e into main Oct 3, 2024
21 of 22 checks passed

affanv14 deleted the affan/revshare-stats branch October 3, 2024 19:10

mergify bot pushed a commit that referenced this pull request Oct 3, 2024

[OTE-849] Add metrics to track revenue shares (#2449)

0a71449

(cherry picked from commit c87960e)

mergify bot mentioned this pull request Oct 3, 2024

[OTE-849] Add metrics to track revenue shares (backport #2449) #2457

Merged

6 tasks

affanv14 added a commit that referenced this pull request Oct 3, 2024

[OTE-849] Add metrics to track revenue shares (backport #2449) (#2457)

fec4549

Co-authored-by: Mohammed Affan <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[OTE-849] Add metrics to track revenue shares #2449

[OTE-849] Add metrics to track revenue shares #2449

affanv14 commented Oct 3, 2024 •

edited by coderabbitai bot

Loading

linear bot commented Oct 3, 2024

coderabbitai bot commented Oct 3, 2024 •

edited

Loading

Rate limit exceeded

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

teddyding Oct 3, 2024

affanv14 Oct 3, 2024

affanv14 commented Oct 3, 2024

mergify bot commented Oct 3, 2024 •

edited

Loading

[OTE-849] Add metrics to track revenue shares #2449

[OTE-849] Add metrics to track revenue shares #2449

Conversation

affanv14 commented Oct 3, 2024 • edited by coderabbitai bot Loading

Changelist

Test Plan

Author/Reviewer Checklist

Summary by CodeRabbit

linear bot commented Oct 3, 2024

coderabbitai bot commented Oct 3, 2024 • edited Loading

Rate limit exceeded

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

teddyding Oct 3, 2024

Choose a reason for hiding this comment

affanv14 Oct 3, 2024

Choose a reason for hiding this comment

affanv14 commented Oct 3, 2024

mergify bot commented Oct 3, 2024 • edited Loading

✅ Backports have been created

affanv14 commented Oct 3, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 3, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

mergify bot commented Oct 3, 2024 •

edited

Loading