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

trace txByNonce #2930

Merged
merged 1 commit into from
Jul 28, 2024
Merged

trace txByNonce #2930

merged 1 commit into from
Jul 28, 2024

Conversation

trajan0x
Copy link
Contributor

@trajan0x trajan0x commented Jul 28, 2024

[goreleaser]

Description
A clear and concise description of the features you're adding in this pull request.

Additional context
Add any other context about the problem you're solving.

Metadata

  • Fixes #[Link to Issue]

Summary by CodeRabbit

  • New Features

    • Enhanced observability for transaction hash retrieval with integrated tracing support.
  • Improvements

    • Improved performance monitoring by propagating tracing context throughout method calls.

[goreleaser]
Copy link
Contributor

coderabbitai bot commented Jul 28, 2024

Walkthrough

The changes enhance the GetTxHashByNonce method within the Handler struct by integrating OpenTelemetry for improved tracing and observability. A new tracing span is initiated during the method call, enabling better performance monitoring. The context used for subsequent calls is now derived from this span, allowing for the propagation of tracing data. These modifications bolster the method's traceability without altering its core functionality.

Changes

File Change Summary
services/rfq/relayer/relapi/handler.go Enhanced GetTxHashByNonce method with OpenTelemetry tracing for better observability and telemetry data collection.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Handler
    participant Service

    Client->>Handler: Call GetTxHashByNonce
    Handler->>Handler: Start tracing span "txByNonce"
    Handler->>Service: GetSubmissionStatus with tracing context
    Service-->>Handler: Return submission status
    Handler-->>Client: Return transaction hash
Loading

🐇 In the realm of code where the bunnies hop,
A trace was added, oh what a swap!
With spans and metrics, like carrots in sight,
Our handler’s now shining, all ready to bite!
So here’s to the changes, let performance soar,
With observability, we’ll code evermore! 🌟


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.

@github-actions github-actions bot added go Pull requests that update Go code size/xs labels Jul 28, 2024
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

Introduced OpenTelemetry tracing to the GetTxHashByNonce function in services/rfq/relayer/relapi/handler.go to enhance observability.

  • Added tracing span in services/rfq/relayer/relapi/handler.go for GetTxHashByNonce.
  • Set attributes for chain_id and nonce within the tracing span.
  • Ensured the span ends with any error that occurs.
  • Passed context to GetSubmissionStatus to propagate tracing information.

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

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.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 442bf9b and 66ce412.

Files selected for processing (1)
  • services/rfq/relayer/relapi/handler.go (3 hunks)
Additional comments not posted (6)
services/rfq/relayer/relapi/handler.go (6)

7-7: Import statement for OpenTelemetry is correct.

The addition of the attribute package is necessary for setting attributes on the tracing span.


266-266: Tracing span initiation is correct.

The tracing span is correctly started using h.metrics.Tracer().Start(c, "txByNonce"), and the context is derived from this span.


267-270: Error handling and span ending is correct.

The deferred function correctly ends the span and handles any errors using metrics.EndSpanWithErr(span, err).


281-282: Setting attributes on the tracing span is correct.

Attributes for chain_id and nonce are correctly set on the tracing span to provide relevant contextual information.

Also applies to: 288-288


290-290: Usage of tracing context is correct.

The tracing context is correctly used when calling GetSubmissionStatus, ensuring that the tracing data is propagated through the call.


Line range hint 292-299:
Error handling is correct.

The error handling correctly returns appropriate HTTP responses for both success and failure scenarios when retrieving the transaction hash.

Copy link

codecov bot commented Jul 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 25.68046%. Comparing base (372197f) to head (66ce412).
Report is 1 commits behind head on master.

Additional details and impacted files
@@                 Coverage Diff                 @@
##              master       #2930         +/-   ##
===================================================
- Coverage   25.68180%   25.68046%   -0.00134%     
===================================================
  Files            771         771                 
  Lines          55588       55587          -1     
  Branches          80          80                 
===================================================
- Hits           14276       14275          -1     
  Misses         39827       39827                 
  Partials        1485        1485                 
Flag Coverage Δ
opbot 0.48900% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@trajan0x trajan0x merged commit 806c12d into master Jul 28, 2024
30 of 31 checks passed
@trajan0x trajan0x deleted the fix/trace-nonce branch July 28, 2024 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go Pull requests that update Go code size/xs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant