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

chore: update router reports payload behind a flag, emit stats to observe sizes #5067

Merged
merged 4 commits into from
Sep 16, 2024

Conversation

Sidddddarth
Copy link
Member

@Sidddddarth Sidddddarth commented Sep 9, 2024

Description

Emit stats to observe payload sizes:

  1. payload in router jobsdb
  2. payload being delivered

Puts behaviour from #4999 behind a feature flag(default behaviour is to send jobsdb payload for now)
Adds a payloadStage field to error response field in the job status.

Linear Ticket

Resolves PIPE-1504

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

@Sidddddarth Sidddddarth marked this pull request as draft September 9, 2024 06:38
Copy link
Contributor

coderabbitai bot commented Sep 9, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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 or @coderabbitai title 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.

Copy link

codecov bot commented Sep 9, 2024

Codecov Report

Attention: Patch coverage is 88.23529% with 2 lines in your changes missing coverage. Please review.

Project coverage is 74.74%. Comparing base (ec92f31) to head (25fe8cf).
Report is 4 commits behind head on master.

Files with missing lines Patch % Lines
router/worker.go 87.50% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5067      +/-   ##
==========================================
- Coverage   74.74%   74.74%   -0.01%     
==========================================
  Files         435      435              
  Lines       50384    50394      +10     
==========================================
+ Hits        37662    37668       +6     
- Misses      10244    10245       +1     
- Partials     2478     2481       +3     

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

@Sidddddarth Sidddddarth marked this pull request as ready for review September 10, 2024 09:03
router/worker.go Outdated
}
stats.Default.NewTaggedStat("router_transformation_payload_size_bytes", stats.HistogramType, tags).Observe(float64(len(destinationJobMetadata.JobT.EventPayload)))

Choose a reason for hiding this comment

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

Why do we need router_transformation_payload_size_bytes? Also it's router input payload rt. If we're planning to capture, may be capture at early stage?

Choose a reason for hiding this comment

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

Also, we don't need to capture this multiple times for each router job. We can capture this once per destinationJob.

router/worker.go Outdated
@@ -1012,6 +1016,16 @@ func (w *worker) postStatusOnResponseQ(respStatusCode int, payload json.RawMessa
}
return
}
switch errorAt {

Choose a reason for hiding this comment

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

Can we add additional check of status code and set only if it's failed. just as a safe check. even though this function gets returned if it's success before this block

@Sidddddarth Sidddddarth enabled auto-merge (squash) September 16, 2024 10:16
@Sidddddarth Sidddddarth merged commit 7d74183 into master Sep 16, 2024
53 checks passed
@Sidddddarth Sidddddarth deleted the chore.routerSampleResponseCorrections branch September 16, 2024 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants