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

fix: replace counter with gauge cron tracker alert #5084

Merged
merged 2 commits into from
Sep 16, 2024

Conversation

snarkychef
Copy link
Member

@snarkychef snarkychef commented Sep 11, 2024

Description

counter resetting on restarts was causing false alerts. As the operation being tracked (cron tracker execution) doesn't happen often, using epoch gauge metric will help.

Linear Ticket

part of PIPE-1514

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 Sep 11, 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>, please review it.
    -- 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 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.

@snarkychef snarkychef changed the title fix: Replace counter with gauge cron tracker alert fix: replace counter with gauge cron tracker alert Sep 11, 2024
counter resetting on restarts was causing false alerts
@snarkychef snarkychef force-pushed the fix/warehouse-cron-tracker-alert branch from 02cff1b to 8fb3325 Compare September 11, 2024 23:31
@snarkychef snarkychef marked this pull request as draft September 11, 2024 23:39
Once in a while, cron runtime may be delayed due to various reasons. This commit disregards the cron runtime in scheduling the next run.
@cisse21 cisse21 marked this pull request as ready for review September 16, 2024 10:12
Copy link

codecov bot commented Sep 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.74%. Comparing base (f6271a0) to head (5f7d753).
Report is 7 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5084      +/-   ##
==========================================
+ Coverage   74.65%   74.74%   +0.09%     
==========================================
  Files         435      435              
  Lines       50378    50386       +8     
==========================================
+ Hits        37608    37663      +55     
+ Misses      10286    10255      -31     
+ Partials     2484     2468      -16     

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

@cisse21 cisse21 merged commit dc7d6ef into master Sep 16, 2024
56 checks passed
@cisse21 cisse21 deleted the fix/warehouse-cron-tracker-alert branch September 16, 2024 10:37
"module": moduleName,
"destType": r.destType,
})
for {

tick.Count(1)
execTime := time.Now()
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
execTime := time.Now()
execTime := r.Now()

@@ -215,16 +215,17 @@ func TestRouter_CronTracker(t *testing.T) {

mockLogger.EXPECT().Infon("context is cancelled, stopped running tracking").Times(1)

executionTime := time.Now().Unix()
Copy link
Member

Choose a reason for hiding this comment

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

A more robust approach is to inject time.Now into the router.

now := time.Now()
r := Router{
   now: func() time.Time{ 
      return now
   }
}

In this particular case, you are calling time.Now() immediately. So observing an issue would be rare

@@ -51,11 +52,12 @@ func (r *Router) CronTracker(ctx context.Context) error {
}
}

nextExecTime := execTime.Add(r.config.uploadStatusTrackFrequency)
Copy link
Member

Choose a reason for hiding this comment

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

This is a good idea, but we might constantly query the database if the execution time is high.

Copy link
Member Author

@snarkychef snarkychef Sep 17, 2024

Choose a reason for hiding this comment

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

Tweaking cron frequency should help us reduce load if/when needed. I will also look into improving the execution time, if any possible.

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