fix: changing eventNames longer than configured max length to ":max-length-exceeded:" before sending to reporting #4244

vamsikrishnakandi · 2023-12-18T10:30:53Z

Description

To reduce events with junk eventNames, adding a restriction on length of eventName. Added a configuration, if a valid max length is given, it replaces eventName (if it is longer than max length) to :max-length-exceeded:. How to show this in UI will be handled in web-app.

Default for the config is set to zero, which will not change anything.

More details in linear ticket and attached notion doc in it.

Completes OBS-126

Linear Ticket

https://linear.app/rudderstack/issue/OBS-126/validate-eventname-in-reports

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 · 2023-12-18T10:30:59Z

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 with CodeRabbit Bot (`@coderabbitai`)

You can directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging @coderabbitai in a comment. Examples:
- @coderabbitai generate unit tests for this file
- @coderabbitai modularize this function
You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase. Examples:
- @coderabbitai gather interesting statistics about this repository and render them in a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai generate unit tests for the src/utils.ts file.

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.

enterprise/reporting/reporting.go

codecov · 2023-12-18T10:45:51Z

Codecov Report

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

Comparison is base (1ff6f90) 73.81% compared to head (4bab9bf) 73.90%.
Report is 2 commits behind head on master.

Files	Patch %	Lines
enterprise/reporting/reporting.go	25.00%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4244      +/-   ##
==========================================
+ Coverage   73.81%   73.90%   +0.08%     
==========================================
  Files         388      388              
  Lines       54835    54839       +4     
==========================================
+ Hits        40478    40527      +49     
+ Misses      12036    11991      -45     
  Partials     2321     2321

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

enterprise/reporting/reporting.go

atzoum · 2023-12-18T15:23:03Z

enterprise/reporting/reporting.go

@@ -589,6 +589,10 @@ func (r *DefaultReporter) Report(ctx context.Context, metrics []*types.PUReporte
 			metric = transformMetricForPII(metric, getPIIColumnsToExclude())
 		}

+		if len(metric.StatusDetail.EventName) > config.GetInt("Reporting.eventNameMaxLength", 100) {


why don't we trim down event names instead to the first 100 characters?

#4244 (comment)

Cardinality can be a serious issue even with event names having less than 100 characters though, e.g. a uuid is 36 characters and ksuid is 28 characters.
Why are we coupling it with the length of characters?

Initial thought is to trim them but when we looked at the data, 99.55% of eventNames longer than 100 characters are stringified JSONs or URLs. And rest of them can also be avoided with good instrumentation. So, we decided to go with this as this will also help with cardinality.

fix: changing eventName longer than 100 characters to INVALID_EVENT_NAME

4f3675a

Merge branch 'master' into fix.largeEventName

6558222

vamsikrishnakandi requested review from lvrach, achettyiitr, atzoum, cisse21 and satishrudderstack December 18, 2023 10:32

achettyiitr reviewed Dec 18, 2023

View reviewed changes

enterprise/reporting/reporting.go Outdated Show resolved Hide resolved

fix: introduce constant for invalid event name

dca8f0d

achettyiitr reviewed Dec 18, 2023

View reviewed changes

enterprise/reporting/reporting.go Outdated Show resolved Hide resolved

fix: made eventNameMaxLength configurable

245052b

atzoum reviewed Dec 18, 2023

View reviewed changes

vamsikrishnakandi added 2 commits December 27, 2023 11:36

fix: updated checking logic and default value

162a411

Merge branch 'master' into fix.largeEventName

4bab9bf

vamsikrishnakandi changed the title ~~fix: changing eventName longer than 100 characters to INVALID_EVENT_NAME~~ fix: changing eventName longer than 100 characters to ":max-length-exceeded:" Dec 27, 2023

vamsikrishnakandi changed the title ~~fix: changing eventName longer than 100 characters to ":max-length-exceeded:"~~ fix: changing eventNames longer than configured max length to ":max-length-exceeded:" before sending to reporting Dec 27, 2023

achettyiitr approved these changes Dec 28, 2023

View reviewed changes

cisse21 approved these changes Jan 3, 2024

View reviewed changes

cisse21 merged commit 719396f into master Jan 3, 2024
47 checks passed

cisse21 deleted the fix.largeEventName branch January 3, 2024 14:32

This was referenced Jan 8, 2024

chore: prerelease 1.19.0-rc.1 #4289

Closed

chore: prerelease 1.19.0-rc.1 #4293

Merged

chore: prerelease 1.19.0-rc-2 #4298

Merged

This was referenced Jan 15, 2024

chore: prerelease 1.19.0-rc.3 #4314

Merged

chore: release 1.19.0 #4316

Merged

This was referenced Feb 9, 2024

chore: release 1.19.0 #4382

Closed

chore: prerelease 1.20.0-rc.1 #4383

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: changing eventNames longer than configured max length to ":max-length-exceeded:" before sending to reporting #4244

fix: changing eventNames longer than configured max length to ":max-length-exceeded:" before sending to reporting #4244

vamsikrishnakandi commented Dec 18, 2023 •

edited

Loading

coderabbitai bot commented Dec 18, 2023 •

edited

Loading

Auto Review Skipped

Chat with CodeRabbit Bot (`@coderabbitai`)

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

codecov bot commented Dec 18, 2023 •

edited

Loading

atzoum Dec 18, 2023

vamsikrishnakandi Dec 18, 2023

atzoum Dec 18, 2023

vamsikrishnakandi Dec 19, 2023

fix: changing eventNames longer than configured max length to ":max-length-exceeded:" before sending to reporting #4244

fix: changing eventNames longer than configured max length to ":max-length-exceeded:" before sending to reporting #4244

Conversation

vamsikrishnakandi commented Dec 18, 2023 • edited Loading

Description

Linear Ticket

Security

coderabbitai bot commented Dec 18, 2023 • edited Loading

Auto Review Skipped

Chat with CodeRabbit Bot (@coderabbitai)

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

codecov bot commented Dec 18, 2023 • edited Loading

Codecov Report

atzoum Dec 18, 2023

Choose a reason for hiding this comment

vamsikrishnakandi Dec 18, 2023

Choose a reason for hiding this comment

atzoum Dec 18, 2023

Choose a reason for hiding this comment

vamsikrishnakandi Dec 19, 2023

Choose a reason for hiding this comment

vamsikrishnakandi commented Dec 18, 2023 •

edited

Loading

coderabbitai bot commented Dec 18, 2023 •

edited

Loading

Chat with CodeRabbit Bot (`@coderabbitai`)

CodeRabbit Configration File (`.coderabbit.yaml`)

codecov bot commented Dec 18, 2023 •

edited

Loading