feat: adding sourceId and destinationId in pipeline info metrics #4332

gane5hvarma · 2024-01-18T07:54:43Z

Description

Rudder server emits a metric called pipeline_processed_events which has labels state and code. This metric is useful to understand the different status codes when rudder server is processing events to destination. Rudder sources team want to use this info to show it to end users. So that they can know how is the sync performing. For this to achieve we want to add sourceId and destinationId as extra labels to pipeline_processed_events metric.

Linear Ticket

https://linear.app/rudderstack/issue/OBS-299/rudder-server-add-sourceid-and-destinationid-in-pipeline-processed

Security

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

coderabbitai · 2024-01-18T07:54:49Z

Important

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

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-tests for this file.
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 tests 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 from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @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.

codecov · 2024-01-18T08:25:25Z

Codecov Report

Attention: 39 lines in your changes are missing coverage. Please review.

Comparison is base (0452e5b) 74.02% compared to head (97d372f) 74.01%.
Report is 5 commits behind head on master.

❗ Current head 97d372f differs from pull request most recent head 6d8849c. Consider uploading reports for the commit 6d8849c to get more accurate results

Files	Patch %	Lines
router/batchrouter/handle_async.go	0.00%	36 Missing ⚠️
router/batchrouter/handle_observability.go	90.00%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4332      +/-   ##
==========================================
- Coverage   74.02%   74.01%   -0.02%     
==========================================
  Files         381      381              
  Lines       54404    54479      +75     
==========================================
+ Hits        40272    40320      +48     
- Misses      11849    11875      +26     
- Partials     2283     2284       +1

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

lvrach · 2024-01-30T13:32:29Z

router/batchrouter/handle.go

@@ -576,6 +576,7 @@ func (brt *Handle) updateJobStatus(batchJobs *BatchedJobs, isWarehouse bool, err
 	transformedAtMap := make(map[string]string)
 	statusDetailsMap := make(map[string]*types.StatusDetail)
 	jobStateCounts := make(map[string]int)
+	jobIdConnectionDetailsMap := make(map[int64]*jobsdb.ConnectionDetailsT)


What is the reason for using a pointer to a struct? Fro small struct is more efficient to pass them as is.

also (nitpik) jobID instead of jobId https://google.github.io/styleguide/go/decisions.html#initialisms

I understand the reason we use the maps, but is a hack that we need to address some day

I will change it for sourceId and destinationId as well

lvrach · 2024-01-30T13:32:31Z

jobsdb/jobsdb.go

@@ -365,6 +365,11 @@ type JobStatusT struct {
 	WorkspaceId   string          `json:"WorkspaceId"`
 }

+type ConnectionDetailsT struct {


We no longer use T suffix for structs

Suggested change

type ConnectionDetailsT struct {

type ConnectionDetails struct {

gane5hvarma · 2024-01-30T13:44:44Z

@lvrach updateProcessedEventsMetrics code for both rt and brt is almost same except module and destType differs. Should i change this function to a common function where rt and brt call them with extra parameters instead of a method function?

…der-server into feat.addIdsInPipelineInfo

Sidddddarth · 2024-02-02T11:48:04Z

@lvrach updateProcessedEventsMetrics code for both rt and brt is almost same except module and destType differs. Should i change this function to a common function where rt and brt call them with extra parameters instead of a method function?

Sounds good. Maybe something like this..?


type JobStatusStats struct {
	Module        string
	DestType      string
	SourceID      string
	DestinationID string
	JobState      string
	StatusCode    string
}

func UpdateProcessedEventsMetrics(statHandle stats.Stats, statsMap map[*JobStatusStats]int) {
	if statHandle == nil {
		statHandle = stats.Default
	}
	for stat, count := range statsMap {
		statHandle.NewTaggedStat(`pipeline_processed_events`, stats.CountType, stats.Tags{
			"module":        stat.Module,
			"destType":      stat.DestType,
			"state":         stat.JobState,
			"code":          stat.StatusCode,
			"sourceId":      stat.SourceID,
			"destinationId": stat.DestinationID,
		}).Count(count)
	}
}

You can use router/utils/utils.go. It contains other utilities used in both router, batch router.

router/handle.go

router/batchrouter/handle.go

…der-server into feat.addIdsInPipelineInfo

router/handle.go

* feat: add sourceid and destination id to pipeline_processed_events metric

draft pr for adding sourceId and destinationId in pipeline info metrics

d1168ba

gane5hvarma added the Draft label Jan 18, 2024

add sourceid and destination id to pipeline_processed_events metric

e955946

gane5hvarma changed the title ~~draft pr for adding sourceId and destinationId in pipeline info metrics~~ feat: adding sourceId and destinationId in pipeline info metrics Jan 30, 2024

Merge branch 'master' into feat.addIdsInPipelineInfo

2688058

lvrach reviewed Jan 30, 2024

View reviewed changes

gane5hvarma added 2 commits January 30, 2024 19:33

some lint and nitpicks

2b8d779

Merge branch 'feat.addIdsInPipelineInfo' of github.com:rudderlabs/rud…

23e8c8e

…der-server into feat.addIdsInPipelineInfo

gane5hvarma requested review from lvrach, Sidddddarth and atzoum February 2, 2024 09:52

Merge branch 'master' into feat.addIdsInPipelineInfo

97d372f

gane5hvarma removed the Draft label Feb 5, 2024

gane5hvarma added 2 commits February 5, 2024 14:26

move routerutils to a common function

c981b16

resolve merge conflicts

83c1f60

gane5hvarma commented Feb 5, 2024

View reviewed changes

router/handle.go Outdated Show resolved Hide resolved

gane5hvarma commented Feb 5, 2024

View reviewed changes

router/batchrouter/handle.go Outdated Show resolved Hide resolved

gane5hvarma added 5 commits February 5, 2024 15:16

define module constant

7a9c3e1

Merge branch 'master' into feat.addIdsInPipelineInfo

ab6b7dc

lint fixes

f0254f8

Merge branch 'feat.addIdsInPipelineInfo' of github.com:rudderlabs/rud…

c4c9f26

…der-server into feat.addIdsInPipelineInfo

remove dead code

c28626e

cisse21 reviewed Feb 5, 2024

View reviewed changes

router/handle.go Outdated Show resolved Hide resolved

handle nil map

bd410dd

gane5hvarma requested a review from cisse21 February 5, 2024 11:36

cisse21 approved these changes Feb 5, 2024

View reviewed changes

gane5hvarma added 2 commits February 5, 2024 19:12

add tests :)

6d8849c

fix lint :-:

4499ced

lvrach approved these changes Feb 5, 2024

View reviewed changes

gane5hvarma merged commit 6c1f1c4 into master Feb 5, 2024
39 of 40 checks passed

This was referenced Feb 9, 2024

chore: release 1.19.0 #4382

Closed

chore: prerelease 1.20.0-rc.1 #4383

Merged

atzoum pushed a commit that referenced this pull request Feb 12, 2024

feat: adding sourceId and destinationId in pipeline info metrics (#4332)

c2d7a42

* feat: add sourceid and destination id to pipeline_processed_events metric

devops-github-rudderstack mentioned this pull request Feb 12, 2024

chore: release 1.20.0 #4388

Merged

github-actions bot deleted the feat.addIdsInPipelineInfo branch April 6, 2024 01:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adding sourceId and destinationId in pipeline info metrics #4332

feat: adding sourceId and destinationId in pipeline info metrics #4332

gane5hvarma commented Jan 18, 2024 •

edited

coderabbitai bot commented Jan 18, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

codecov bot commented Jan 18, 2024 •

edited

lvrach Jan 30, 2024

lvrach Jan 30, 2024

gane5hvarma Jan 30, 2024

lvrach Jan 30, 2024

gane5hvarma commented Jan 30, 2024

Sidddddarth commented Feb 2, 2024

	type ConnectionDetailsT struct {
	type ConnectionDetails struct {

feat: adding sourceId and destinationId in pipeline info metrics #4332

feat: adding sourceId and destinationId in pipeline info metrics #4332

Conversation

gane5hvarma commented Jan 18, 2024 • edited

Description

Linear Ticket

Security

coderabbitai bot commented Jan 18, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

codecov bot commented Jan 18, 2024 • edited

Codecov Report

lvrach Jan 30, 2024

Choose a reason for hiding this comment

lvrach Jan 30, 2024

Choose a reason for hiding this comment

gane5hvarma Jan 30, 2024

Choose a reason for hiding this comment

lvrach Jan 30, 2024

Choose a reason for hiding this comment

gane5hvarma commented Jan 30, 2024

Sidddddarth commented Feb 2, 2024

gane5hvarma commented Jan 18, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

codecov bot commented Jan 18, 2024 •

edited