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

add telemetry and logs for liquidation daemon #2122

Merged
merged 1 commit into from
Aug 21, 2024
Merged

Conversation

jayy04
Copy link
Contributor

@jayy04 jayy04 commented Aug 21, 2024

Changelist

[Describe or list the changes made in this PR]

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

    • Enhanced error reporting with additional context for failures in the liquidation process.
    • Introduced telemetry metrics to monitor the performance of request handling.
  • Bug Fixes

    • Improved clarity of error messages in the application state fetching process.
  • Chores

    • Added a new constant for better tracking of the number of requests processed.

@jayy04 jayy04 requested a review from a team as a code owner August 21, 2024 13:14
Copy link
Contributor

coderabbitai bot commented Aug 21, 2024

Walkthrough

The recent updates enhance error handling and telemetry reporting across several components in the codebase. Improvements include wrapping errors with contextual information to aid debugging and introducing metrics to monitor the number of requests processed. These changes contribute to a more robust and observable system, fostering better maintenance and performance tracking.

Changes

Files Change Summary
protocol/daemons/liquidation/client/grpc_helper.go, protocol/daemons/liquidation/client/sub_task_runner.go Enhanced error handling with wrapped errors for improved clarity and context in error messages. Added telemetry metrics for monitoring requests in the liquidation process.
protocol/lib/metrics/constants.go Introduced a new constant, NumRequests, for tracking the number of requests, aiding in performance monitoring.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant LiquidationService
    participant Telemetry

    Client->>LiquidationService: SendLiquidatableSubaccountIds()
    LiquidationService-->>Client: Process Request
    Note over Client: Record telemetry metric for requests
    LiquidationService-->>Client: Return result with potential error
    alt Error occurred
        Client->>Client: Wrap error with context
    end
Loading

🐇 In a world of code and bytes,
A rabbit hops where logic lights.
With wrapped errors, clear and bright,
Telemetry shines, a guiding light.
Requests now tracked, a joyful cheer,
Debugging’s easier, have no fear! 🐇


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 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 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.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 909fc3a and a153f23.

Files selected for processing (3)
  • protocol/daemons/liquidation/client/grpc_helper.go (2 hunks)
  • protocol/daemons/liquidation/client/sub_task_runner.go (2 hunks)
  • protocol/lib/metrics/constants.go (1 hunks)
Additional comments not posted (7)
protocol/daemons/liquidation/client/sub_task_runner.go (4)

123-127: Enhanced error context for subaccount fetching.

The error handling now provides more context, which is beneficial for debugging.


133-137: Enhanced error context for market price fetching.

The error handling now provides more context, which is beneficial for debugging.


146-150: Enhanced error context for perpetual fetching.

The error handling now provides more context, which is beneficial for debugging.


156-160: Enhanced error context for liquidity tier fetching.

The error handling now provides more context, which is beneficial for debugging.

protocol/daemons/liquidation/client/grpc_helper.go (2)

275-280: Telemetry metric added for request count.

The addition of a telemetry metric for the number of requests aids in monitoring system performance.


284-288: Enhanced error context for LiquidateSubaccounts call.

The error handling now provides more context, which is beneficial for debugging.

protocol/lib/metrics/constants.go (1)

317-317: New constant NumRequests added for tracking requests.

This addition enhances the codebase by allowing for more granular control over request-related metrics.

@jayy04 jayy04 merged commit 5030459 into main Aug 21, 2024
18 of 22 checks passed
@jayy04 jayy04 deleted the jy/telemetry-logs branch August 21, 2024 13:27
@jayy04
Copy link
Contributor Author

jayy04 commented Aug 21, 2024

@Mergifyio backport release/protocol/v5.2.x

Copy link
Contributor

mergify bot commented Aug 21, 2024

backport release/protocol/v5.2.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Aug 21, 2024
jayy04 added a commit that referenced this pull request Aug 21, 2024
@jayy04
Copy link
Contributor Author

jayy04 commented Aug 21, 2024

@Mergifyio backport release/protocol/v6.x

Copy link
Contributor

mergify bot commented Aug 21, 2024

backport release/protocol/v6.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Aug 21, 2024
(cherry picked from commit 5030459)

# Conflicts:
#	protocol/daemons/liquidation/client/grpc_helper.go
jayy04 added a commit that referenced this pull request Aug 21, 2024
jayy04 added a commit that referenced this pull request Aug 21, 2024
Co-authored-by: Jay Yu <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
dydxwill pushed a commit that referenced this pull request Aug 26, 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