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

Fix vulcan post processing metrics not emitted for short term orders #2244

Merged
merged 1 commit into from
Sep 12, 2024

Conversation

roy-dydx
Copy link
Contributor

@roy-dydx roy-dydx commented Sep 12, 2024

Changelist

Stale variable was used causing these metrics not to appear.

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

  • Bug Fixes

    • Improved accuracy of message processing timing by updating the timestamp check to utilize a more reliable header.
  • Chores

    • Refined internal logging mechanisms for better performance metrics tracking.

@roy-dydx roy-dydx requested a review from a team as a code owner September 12, 2024 17:39
Copy link
Contributor

coderabbitai bot commented Sep 12, 2024

Walkthrough

The changes in this pull request modify the condition for checking the existence of a timestamp in the onMessage function. The previous implementation relied on the originalMessageTimestamp variable, while the updated version checks the headers.message_received_timestamp. This adjustment aims to enhance the reliability of tracking message reception times, which may improve the accuracy of performance metrics related to message processing.

Changes

Files Change Summary
indexer/services/vulcan/src/lib/on-message.ts Modified the condition for checking the timestamp from originalMessageTimestamp to headers.message_received_timestamp.

Poem

In the code where messages flow,
A timestamp change, a new way to know.
From variables vague to headers so bright,
Our timing's now clearer, oh what a delight!
Hop, skip, and jump, let performance soar,
With each little change, we’ll code evermore! 🐇✨


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 04224e7 and bdc4ea7.

Files selected for processing (1)
  • indexer/services/vulcan/src/lib/on-message.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • indexer/services/vulcan/src/lib/on-message.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>.
    • 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 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.

@@ -122,7 +122,7 @@ export async function onMessage(message: KafkaMessage): Promise<void> {
await handler.handleUpdate(update, headers);

const postProcessingTime: number = Date.now();
if (originalMessageTimestamp !== undefined) {
if (headers.message_received_timestamp !== undefined) {
stats.timing(
`${config.SERVICE_NAME}.message_time_since_received_post_processing`,
postProcessingTime - Number(originalMessageTimestamp),
Copy link
Contributor

Choose a reason for hiding this comment

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

message_received_timestamp

@roy-dydx roy-dydx merged commit 10189d6 into main Sep 12, 2024
16 checks passed
@roy-dydx roy-dydx deleted the roy/vulcanmetric branch September 12, 2024 18:19
@roy-dydx
Copy link
Contributor Author

@Mergifyio backport release/indexer/v6.x

@roy-dydx
Copy link
Contributor Author

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

Copy link
Contributor

mergify bot commented Sep 12, 2024

backport release/indexer/v6.x

✅ Backports have been created

Copy link
Contributor

mergify bot commented Sep 12, 2024

backport release/indexer/v5.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Sep 12, 2024
mergify bot pushed a commit that referenced this pull request Sep 12, 2024
roy-dydx added a commit that referenced this pull request Sep 13, 2024
…(backport #2244) (#2245)

Co-authored-by: roy-dydx <133032749+roy-dydx@users.noreply.github.com>
roy-dydx added a commit that referenced this pull request Sep 13, 2024
…(backport #2244) (#2246)

Co-authored-by: roy-dydx <133032749+roy-dydx@users.noreply.github.com>
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