Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OTE-821] Affiliates roundtable metrics #2311

Merged
merged 32 commits into from
Sep 20, 2024

Conversation

jerryfan01234
Copy link
Contributor

@jerryfan01234 jerryfan01234 commented Sep 20, 2024

Changelist

add metrics to update total volume and affiliate info roundtables

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

    • Added functionality to track and report lag time for updates in both affiliate info and wallet total volume tasks.
    • Introduced metrics logging to enhance monitoring capabilities for update processes.
  • Tests

    • Added new test cases to verify the correct recording of metrics for both affiliate info and wallet total volume updates.

Copy link

linear bot commented Sep 20, 2024

Copy link
Contributor

coderabbitai bot commented Sep 20, 2024

Walkthrough

This pull request introduces functionality to track the lag time since the last update in the persistent cache for both the update-affiliate-info and update-wallet-total-volume tasks. It also adds corresponding test cases to verify the correct recording of metrics when these tasks are executed. The overall structure of the test suites remains unchanged, but the additions enhance monitoring capabilities.

Changes

File Path Change Summary
indexer/services/roundtable/src/tasks/update-affiliate-info.ts, indexer/services/roundtable/src/tasks/update-wallet-total-volume.ts Introduced the import of stats from @dydxprotocol-indexer/base and added functionality to track the lag time of the last update in the persistent cache, logging it with stats.gauge.
indexer/services/roundtable/__tests__/tasks/update-affiliate-info.test.ts, indexer/services/roundtable/__tests__/tasks/update-wallet-total-volume.test.ts Added a test case titled "Successfully records metrics" to verify that metrics are recorded correctly for both affiliateInfoUpdateTask and walletTotalVolumeUpdateTask.

Possibly related PRs

Suggested reviewers

  • affanv14
  • Christopher-Li

🐇 In the meadow, metrics bloom,
A task's success dispels the gloom.
With every gauge, a tale is spun,
Tracking time, our work is fun!
So hop along, let data flow,
In our tests, the numbers grow! 🌼


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 83228b7 and cade120.

Files selected for processing (4)
  • indexer/services/roundtable/tests/tasks/update-affiliate-info.test.ts (2 hunks)
  • indexer/services/roundtable/tests/tasks/update-wallet-total-volume.test.ts (2 hunks)
  • indexer/services/roundtable/src/tasks/update-affiliate-info.ts (3 hunks)
  • indexer/services/roundtable/src/tasks/update-wallet-total-volume.ts (3 hunks)
Files skipped from review as they are similar to previous changes (4)
  • indexer/services/roundtable/tests/tasks/update-affiliate-info.test.ts
  • indexer/services/roundtable/tests/tasks/update-wallet-total-volume.test.ts
  • indexer/services/roundtable/src/tasks/update-affiliate-info.ts
  • indexer/services/roundtable/src/tasks/update-wallet-total-volume.ts

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.

Comment on lines 42 to 45
stats.gauge(
`${config.SERVICE_NAME}.persistent_cache_${PersistentCacheKeys.AFFILIATE_INFO_UPDATE_TIME}_lag_seconds`,
DateTime.utc().diff(windowStartTime).as('seconds'),
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: actually since we can track this in the same dashboard let's do this

Suggested change
stats.gauge(
`${config.SERVICE_NAME}.persistent_cache_${PersistentCacheKeys.AFFILIATE_INFO_UPDATE_TIME}_lag_seconds`,
DateTime.utc().diff(windowStartTime).as('seconds'),
);
stats.gauge(
`${config.SERVICE_NAME}.persistent_cache_lag_seconds`,
DateTime.utc().diff(windowStartTime).as('seconds'),
{ cache: PersistentCacheKeys.AFFILIATE_INFO_UPDATE_TIME.},
);

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and also for the other task

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense

@jerryfan01234 jerryfan01234 merged commit a01cb54 into main Sep 20, 2024
16 checks passed
@jerryfan01234 jerryfan01234 deleted the affiliates-roundtable-metrics branch September 20, 2024 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants