Sample more stats in socks

[dydxwill]

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.

[coderabbitai]

Walkthrough

The update to the WebSocket service involves enhancing the onMessage method within the Index class to improve metrics accuracy. This is achieved by incorporating an additional parameter, config.MESSAGE_FORWARDER_STATSD_SAMPLE_RATE, into the stats.increment function calls for both message sending and receiving processes. This adjustment allows for more precise monitoring and analysis of the WebSocket service's performance by adjusting the sampling rate for statistics collection.

Changes

File Path	Change Summary
.../websocket/index.ts	Added config.MESSAGE_FORWARDER_STATSD_SAMPLE_RATE as an additional parameter in stats.increment calls for both sending and receiving messages in the onMessage method.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e953077 and f3833d3.

Files selected for processing (1)

• indexer/services/socks/src/websocket/index.ts (2 hunks)

Additional Context Used

Path-based Instructions (1)

indexer/services/socks/src/websocket/index.ts (1)

**/**:
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

Additional comments not posted (2)

indexer/services/socks/src/websocket/index.ts (2)

217-220: The addition of config.MESSAGE_FORWARDER_STATSD_SAMPLE_RATE as a parameter in the stats.increment call is a good practice for controlling the sampling rate of statistics dynamically. This allows for more granular control over the volume of data being sampled and sent to the monitoring tools, which can be particularly useful in high-throughput environments where sending every single event might be impractical or expensive.

However, it's important to ensure that the config.MESSAGE_FORWARDER_STATSD_SAMPLE_RATE is validated somewhere in the application to be within a sensible range (e.g., 0 to 1 for a percentage-based rate). If this configuration is coming from an external source like an environment variable or a configuration file, improper values could lead to unexpected behavior.

---

325-328: The same considerations apply to the second stats.increment call where config.MESSAGE_FORWARDER_STATSD_SAMPLE_RATE is used. It's crucial to ensure that the sampling rate is validated to prevent potential issues with data accuracy or volume.

Given that this is a repeated observation, it might be beneficial to consider implementing a wrapper function around stats.increment that automatically includes the sampling rate parameter. This would reduce duplication and centralize the logic for handling statistics incrementation, making the codebase more maintainable.

Consider creating a wrapper function for stats.increment that includes the MESSAGE_FORWARDER_STATSD_SAMPLE_RATE by default to reduce code duplication and centralize sampling rate logic.