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: initial effort on reducing cardinality for warehouseID #4667

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

achettyiitr
Copy link
Member

@achettyiitr achettyiitr commented May 9, 2024

Description

  • Initial Cardinality Reduction Effort: The primary focus is on reducing the cardinality associated with warehouseID. This is necessary because warehouseID's cardinality is influenced by variables like sourceName and destinationName, which are subject to change. Additionally, the inclusion of sourceName and destinationName does not add significant value since sourceID and destID suffice for identification purposes.

  • Current Plan Overview:

    • Ensuring Availability of Stable Identifiers: In all statistics where warehouseID is utilized, sourceID and destID are ensured to be available. For any instances where these identifiers are absent, they are added.
    • Transitioning from warehouseID: Once the new tags (sourceID and destID) are consistently populated, the next step involves removing warehouseID from the metrics dashboard and alerts. Instead, sourceID and destID will be used for contextual information if necessary. (PIPE-1089)
    • Application Code Update: Following the successful correction of metrics dashboards and alerts, the final step entails removing references to warehouseID from the application code. (PIPE-1090)

This improved version provides clearer explanations and organizes the plan's steps for better readability and understanding.

Linear Ticket

  • Resolves PIPE-1088

Security

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

Copy link
Contributor

coderabbitai bot commented May 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.

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

@achettyiitr achettyiitr changed the title chore: added sourceID and destID tags for router tracker chore: Initial effort on reducing cardinality for warehouseID May 9, 2024
@achettyiitr achettyiitr changed the title chore: Initial effort on reducing cardinality for warehouseID chore: Initial effort on reducing cardinality for warehouseid May 9, 2024
@achettyiitr achettyiitr changed the title chore: Initial effort on reducing cardinality for warehouseid chore: initial effort on reducing cardinality for warehouseID May 9, 2024
Copy link

codecov bot commented May 9, 2024

Codecov Report

Attention: Patch coverage is 80.00000% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 74.57%. Comparing base (73f7275) to head (7229fe6).
Report is 2 commits behind head on master.

Files Patch % Lines
warehouse/bcm/backend_config.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4667      +/-   ##
==========================================
+ Coverage   74.47%   74.57%   +0.09%     
==========================================
  Files         413      413              
  Lines       48752    48752              
==========================================
+ Hits        36310    36358      +48     
+ Misses      10056    10013      -43     
+ Partials     2386     2381       -5     

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

@@ -348,6 +350,7 @@ func (bcm *BackendConfigManager) persistSSLFileErrorStat(
"module": "warehouse",
"destType": destType,
"warehouseID": misc.GetTagName(destID, sourceName, destName, misc.TailTruncateStr(sourceID, 6)),
"sourceID": sourceID,
"destinationID": destID,
Copy link
Member

Choose a reason for hiding this comment

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

Looks like destID is in use in other places.

Suggested change
"destinationID": destID,
"destID": destID,

Copy link
Member Author

Choose a reason for hiding this comment

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

Yean, I noticed that as well. There are dis-similarities around destID vs destinationID.

Copy link
Member Author

Choose a reason for hiding this comment

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

I was discussing the same with @lvrach around the mismatch of tags. We thought of following these steps:

  1. Add additional tags where there are mismatches, like in say in this particular case we will add let's say destID.
  2. Check operator, if we have alerts or dashboards requires those tags, we can replace them, like in say in this particular case we will replace destinationID with destID.
  3. Once we have no dependency we will remove it from the code, like in say removing destinationID from stat.

Copy link
Member

@Sidddddarth Sidddddarth left a comment

Choose a reason for hiding this comment

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

LGTM apart from one use of destinationID instead of destID for a stat tag.

@lvrach
Copy link
Member

lvrach commented May 23, 2024

@achettyiitr
Copy link
Member Author

As @Sidddddarth mentions, why not use destinationId? https://github.com/rudderlabs/rudder-observability-kit/blob/main/go/labels/common.go#L11

This might break any existing alerting or monitoring dashboard right which uses these labels. To be more specific this alert.

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.

None yet

3 participants