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

feat(listener): add listener_name as otel attribute #3050

Merged
merged 1 commit into from
Aug 23, 2024

Conversation

dwasse
Copy link
Collaborator

@dwasse dwasse commented Aug 22, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a naming feature for the chain listener, allowing users to assign and store a name for better identification.
    • Enhanced metrics tracking by including the listener's name in the recorded metrics.
  • Bug Fixes

    • Fixed potential issues with metrics identification by ensuring that the listener's name is now part of the metrics.
  • Documentation

    • Updated the functionality of the WithName option to store the listener's name in the chain listener instance.

@dwasse dwasse requested a review from trajan0x as a code owner August 22, 2024 19:17
Copy link
Contributor

coderabbitai bot commented Aug 22, 2024

Walkthrough

The changes introduce a name field to the chainListener struct and the otelRecorder struct, enabling the storage of listener names for better identification in metrics. The WithName function is modified to assign the name to the listener instance, and the newOtelRecorder function is updated to accept the name as an additional parameter. These adjustments enhance the tracking and contextual representation of listeners.

Changes

Files Change Summary
ethergo/listener/listener.go Added a name field to the chainListener struct and updated the Listen method to pass the name to newOtelRecorder.
ethergo/listener/options.go Modified WithName function to assign the provided name to the chainListener.
ethergo/listener/otel.go Introduced a listenerName field in the otelRecorder struct, updated the constructor to accept a name parameter, and modified related methods.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ChainListener
    participant OtelRecorder

    Client->>ChainListener: Initialize with WithName(name)
    ChainListener->>ChainListener: Store name
    ChainListener->>OtelRecorder: newOtelRecorder(meterHandler, chainID, name)
    OtelRecorder->>OtelRecorder: Store listenerName
    ChainListener->>Client: Ready to listen
Loading

🐰 "In the code where the listeners play,
A name was added to brighten the day.
Metrics now dance with identity's grace,
Every log and block finds its place.
Hooray for the changes, how clever and bright,
With names in our hearts, we take flight!" 🎉


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 Aug 22, 2024
Copy link

codecov bot commented Aug 22, 2024

Codecov Report

Attention: Patch coverage is 50.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 30.37006%. Comparing base (08b9e9e) to head (fa71261).
Report is 5 commits behind head on master.

Files Patch % Lines
ethergo/listener/otel.go 50.00000% 2 Missing ⚠️
ethergo/listener/options.go 0.00000% 1 Missing ⚠️
Additional details and impacted files
@@                 Coverage Diff                  @@
##              master       #3050          +/-   ##
====================================================
- Coverage   90.55118%   30.37006%   -60.18113%     
====================================================
  Files             54         438         +384     
  Lines           1016       28347       +27331     
  Branches          82          82                  
====================================================
+ Hits             920        8609        +7689     
- Misses            93       18926       +18833     
- Partials           3         812         +809     
Flag Coverage Δ
cctp-relayer 31.97848% <ø> (?)
ethergo 47.91223% <50.00000%> (?)
omnirpc 33.23904% <ø> (?)
opbot 0.48900% <ø> (?)
promexporter 6.92368% <ø> (?)
rfq 21.86660% <ø> (?)
scribe 18.18182% <ø> (?)
tools 30.55118% <ø> (?)

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.

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 ead107f and fa71261.

Files selected for processing (3)
  • ethergo/listener/listener.go (2 hunks)
  • ethergo/listener/options.go (1 hunks)
  • ethergo/listener/otel.go (3 hunks)
Additional comments not posted (6)
ethergo/listener/options.go (1)

57-57: LGTM! The change enhances the WithName function.

Storing the listener's name within the chainListener instance improves the contextual representation and tracking of listeners.

ethergo/listener/otel.go (3)

40-41: LGTM! Addition of listenerName field enhances context.

The listenerName field in the otelRecorder struct provides better identification and tracking of listeners.


44-51: LGTM! Updated newOtelRecorder function signature.

The addition of the name parameter to the newOtelRecorder function enhances the initialization of the otelRecorder with the listener's name.


84-84: LGTM! Inclusion of listenerName in metrics.

The updates to recordLastBlock and recordLastFetchedBlockAge methods to include the listenerName attribute improve the tracking of listener-specific metrics.

Also applies to: 99-99

ethergo/listener/listener.go (2)

56-56: LGTM! Addition of name field in chainListener.

The name field enhances the chainListener by allowing it to store a name associated with the listener instance.


98-98: LGTM! Updated Listen method to pass name.

Passing c.name to the newOtelRecorder function enhances the initialization of the otelRecorder with the listener's name, improving metric tracking.

Copy link

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: fa71261
Status: ✅  Deploy successful!
Preview URL: https://ffed5f78.sanguine-fe.pages.dev
Branch Preview URL: https://feat-listener-otel.sanguine-fe.pages.dev

View logs

@trajan0x trajan0x merged commit b65003c into master Aug 23, 2024
43 of 46 checks passed
@trajan0x trajan0x deleted the feat/listener-otel branch August 23, 2024 11:13
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.

2 participants