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

[Wf-Diagnostics] Rootcause issues causing timeouts #6236

Merged
merged 4 commits into from
Aug 20, 2024

Conversation

sankari165
Copy link
Member

What changed?
Timeout invariant now has a method that provides a list of potential root causes for the identified issues. Pollers and heart beating checks are added to begin with. More rootcause checks will be added in future PRs

Why?
Timeouts are usually caused by missing pollers and activity timeouts specifically could be due to missing heartbeating config. These are checked as potential root causes.

How did you test it?
unit tests

Potential risks

Release notes

Documentation Changes

Copy link

codecov bot commented Aug 19, 2024

Codecov Report

Attention: Patch coverage is 77.77778% with 20 lines in your changes missing coverage. Please review.

Project coverage is 72.93%. Comparing base (e23c5a6) to head (e9d003c).
Report is 4 commits behind head on master.

Files Patch % Lines
service/worker/diagnostics/invariants/timeout.go 74.64% 11 Missing and 7 partials ⚠️
...ice/worker/diagnostics/invariants/timeout_utils.go 81.81% 2 Missing ⚠️
Additional details and impacted files
Files Coverage Δ
service/worker/diagnostics/activities.go 100.00% <100.00%> (ø)
service/worker/diagnostics/workflow.go 91.30% <100.00%> (+0.82%) ⬆️
...ice/worker/diagnostics/invariants/timeout_utils.go 81.70% <81.81%> (+0.62%) ⬆️
service/worker/diagnostics/invariants/timeout.go 82.60% <74.64%> (-13.05%) ⬇️

... and 5 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e23c5a6...e9d003c. Read the comment docs.

Comment on lines 184 to 187
return InvariantRootCauseResult{
RootCause: RootCauseTypeHeartBeatingNotEnabled.String(),
Metadata: []byte(metadata.TimeElapsed.String()),
}, nil
Copy link
Member

Choose a reason for hiding this comment

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

This suppose to hit a lot - lots of activity calls don't use heartbeats.
Are you taking into account it is not as crucial as not the next if-statement?

Copy link
Member Author

Choose a reason for hiding this comment

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

there is no prioritisation done here. we simply list potential root causes cos we cant quite predict what suits the usecase. but calling out heart beating not enabled is one of the many observations we return when an activity times out.

@sankari165 sankari165 merged commit 2d7b7d4 into cadence-workflow:master Aug 20, 2024
19 checks passed
@sankari165 sankari165 deleted the CDNC-10128-pollers branch August 21, 2024 06:37
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.

3 participants