[Wf-diagnostics] Introduce a new api to diagnose a workflow execution #6268
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Detailed Description
[In-depth description of the changes made to the IDL, specifying new fields, removed fields, or modified data structures]
Introduction of new api to trigger workflow to perform diagnostics from cadence frontend. The result of the diagnostics contains the details of the diagnostics workflow that was triggered. The result of the diagnostics can be fetched by querying the diagnostics workflow . This api will be triggered from cli and web to provide diagnostics for a workflow execution to the users.
Impact Analysis
Testing Plan
No compatibility issues as it is a new unused API
Rollout Plan
What changed?
This api will trigger the start of Diagnostics workflow that runs in the cadence worker service.
Why?
Having this as a api in frontend, allows the use of workflow diagnostics from cli or web
How did you test it?
unit tests
Potential risks
Release notes
Documentation Changes