-
Notifications
You must be signed in to change notification settings - Fork 192
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
docs(operate): add section: monitor operation status #4104
Merged
Merged
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
55c5834
docs(operate): add section: monitor operation status
pedesen ee20829
style(formatting): technical review
christinaausley 7cd5c37
docs(operate): rephrase subtitles
pedesen 7584fd0
docs(operate): fix links to monitor operation status section
pedesen 271b606
Merge branch 'main' into 3654-operate-monitor-operations-status
pedesen 6d37d4e
docs(operate): add note about empty operations panel
pedesen 844e4af
style(formatting): minor grammatical tweak
christinaausley File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+180 KB
.../components/operate/userguide/img/monitor-operation-state/expand-row-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+173 KB
...onents/operate/userguide/img/monitor-operation-state/expanded-instances-row.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+181 KB
...nts/operate/userguide/img/monitor-operation-state/expanded-operations-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+181 KB
...omponents/operate/userguide/img/monitor-operation-state/operation-state-row.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+169 KB
docs/components/operate/userguide/img/monitor-operation-state/operations-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions
27
docs/components/operate/userguide/monitor-operation-status.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
id: monitor-operation-status | ||
title: Monitor operation status | ||
description: "Monitor and investigate the status of any operation" | ||
--- | ||
|
||
Operate offers a powerful way to monitor and investigate the status of any operation you started. This includes canceling and retrying process instances, process instance migration and modification. | ||
|
||
First go to the processes view and expand the operations panel: | ||
|
||
![operate-view-process-filters](./img/monitor-operation-state/operations-panel.png) | ||
|
||
Select an operation from the list by clicking on the operation id. Notice that the operation if is set as a filter: | ||
|
||
![operate-view-process-filters](./img/monitor-operation-state/expanded-operations-panel.png) | ||
|
||
Now you can see that a new column named "Operation State" is added to the processes instances list which indicates the current state of the operation: | ||
|
||
![operate-view-process-filters](./img/monitor-operation-state/operation-state-row.png) | ||
|
||
In case an operation has failed, the related process instance row is marked red and you are able to expand the row: | ||
|
||
![operate-view-process-filters](./img/monitor-operation-state/expand-row-button.png) | ||
|
||
Each expanded row shows the error message related to the operation which you selected earlier: | ||
|
||
![operate-view-process-filters](./img/monitor-operation-state/expanded-instances-row.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add a note in the case the user doesn't have any operations and sees "No operations have been created yet."?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea, I added it.