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-876] update roundtable loop timings for instrumentation and uncrossing #2494

Merged
merged 2 commits into from
Oct 16, 2024

Conversation

affanv14
Copy link
Contributor

@affanv14 affanv14 commented Oct 16, 2024

Changelist

Updating values of loop timing so that uncrossing happens more frequently than instrumentation

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
    • Updated default values for operational loop intervals to enhance performance.
    • Improved timing configurations for order book management.
  • Bug Fixes
    • Adjusted whitespace for better readability in configuration declarations.

@affanv14 affanv14 requested a review from a team as a code owner October 16, 2024 15:16
Copy link

linear bot commented Oct 16, 2024

Copy link
Contributor

coderabbitai bot commented Oct 16, 2024

Walkthrough

The changes in this pull request involve modifications to the configSchema object within the indexer/services/roundtable/src/config.ts file. Specifically, the default values for two loop interval configurations have been updated, and a whitespace adjustment has been made for a variable declaration.

Changes

File Path Change Summary
indexer/services/roundtable/src/config.ts - Updated LOOPS_INTERVAL_MS_UNCROSS_ORDERBOOK default value from THIRTY_SECONDS_IN_MILLISECONDS to 15 * ONE_SECOND_IN_MILLISECONDS.
- Updated LOOPS_INTERVAL_MS_ORDERBOOK_INSTRUMENTATION default value from 5 * ONE_SECOND_IN_MILLISECONDS to 1 * ONE_MINUTE_IN_MILLISECONDS.
- Adjusted whitespace around STALE_ORDERBOOK_LEVEL_THRESHOLD_SECONDS.

Possibly related PRs

Suggested reviewers

  • dydxwill

Poem

🐰 In the meadow where the bunnies play,
Configs change to brighten the day.
Loops now dance with a faster beat,
Whitespace trimmed, oh what a treat!
With every hop, our code takes flight,
Making things better, oh what a sight! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 543e078 and fbf2da5.

📒 Files selected for processing (1)
  • indexer/services/roundtable/src/config.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • indexer/services/roundtable/src/config.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.

@@ -208,7 +208,7 @@ export const configSchema = {
AGGREGATE_TRADING_REWARDS_CHUNK_SIZE: parseInteger({ default: 50 }),

// Uncross orderbook
STALE_ORDERBOOK_LEVEL_THRESHOLD_SECONDS: parseInteger({ default: 10 }),
STALE_ORDERBOOK_LEVEL_THRESHOLD_SECONDS: parseInteger({ default: 10 }),
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: remove extra space

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
indexer/services/roundtable/src/config.ts (1)

211-211: Revert formatting change for consistency

The extra space added before the colon in STALE_ORDERBOOK_LEVEL_THRESHOLD_SECONDS: parseInteger({ default: 10 }) introduces inconsistency in the file's formatting. Other similar lines in the file do not have this extra space.

For consistency, please remove the extra space:

-  STALE_ORDERBOOK_LEVEL_THRESHOLD_SECONDS:  parseInteger({ default: 10 }),
+  STALE_ORDERBOOK_LEVEL_THRESHOLD_SECONDS: parseInteger({ default: 10 }),
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ca15c4d and 543e078.

📒 Files selected for processing (1)
  • indexer/services/roundtable/src/config.ts (3 hunks)
🧰 Additional context used
🔇 Additional comments (3)
indexer/services/roundtable/src/config.ts (3)

73-74: LGTM: Reduced interval for uncrossing orderbook

The change from 30 seconds to 15 seconds for the LOOPS_INTERVAL_MS_UNCROSS_ORDERBOOK aligns with the PR objective to make the uncrossing process more frequent. This could potentially improve market efficiency by updating the orderbook more often.

To ensure this change doesn't negatively impact system performance, please monitor the following after deployment:

  1. CPU and memory usage of the Roundtable service
  2. Latency of orderbook updates
  3. Overall system responsiveness

If you notice any significant performance degradation, consider adjusting the interval or optimizing the uncrossing process.


82-83: LGTM: Increased interval for orderbook instrumentation

The change from 5 seconds to 1 minute for the LOOPS_INTERVAL_MS_ORDERBOOK_INSTRUMENTATION aligns with the PR objective to make the instrumentation process less frequent than the uncrossing process. This should reduce the system load for instrumentation tasks.

To ensure this change doesn't negatively impact monitoring capabilities, please verify the following after deployment:

  1. The quality and usefulness of orderbook metrics at the new 1-minute interval
  2. Any dashboards or alerts that depend on orderbook instrumentation data
  3. The ability to detect and respond to rapid market changes

If you notice any significant loss of important information or reduced ability to monitor the system effectively, consider adjusting the interval or implementing additional metrics to compensate for the reduced frequency.


Line range hint 1-215: Summary: Changes align with PR objectives, post-deployment monitoring crucial

The changes in this file successfully implement the PR objective of updating loop timings to ensure that the uncrossing process occurs more frequently than the instrumentation process. The key modifications are:

  1. Reduced LOOPS_INTERVAL_MS_UNCROSS_ORDERBOOK from 30 to 15 seconds
  2. Increased LOOPS_INTERVAL_MS_ORDERBOOK_INSTRUMENTATION from 5 seconds to 1 minute

These changes are approved, but it's crucial to monitor system performance and data quality post-deployment. Pay special attention to:

  • System load and responsiveness
  • Quality and usefulness of orderbook metrics
  • Impact on monitoring capabilities and ability to detect rapid market changes

If any issues arise, consider fine-tuning these intervals or implementing additional optimizations.

Please ensure that thorough testing is conducted before deployment and that a rollback plan is in place in case of unexpected issues.

@affanv14 affanv14 merged commit 150513c into main Oct 16, 2024
16 checks passed
@affanv14 affanv14 deleted the affan/orderbook-cross branch October 16, 2024 15:43
@affanv14
Copy link
Contributor Author

@Mergifyio backport release/indexer/v6.x

Copy link
Contributor

mergify bot commented Oct 16, 2024

backport release/indexer/v6.x

✅ Backports have been created

@affanv14
Copy link
Contributor Author

https://github.com/Mergifyio backport release/indexer/v7.x

Copy link
Contributor

mergify bot commented Oct 16, 2024

backport release/indexer/v7.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Oct 16, 2024
affanv14 added a commit that referenced this pull request Oct 16, 2024
affanv14 added a commit that referenced this pull request Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants