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

docs(operate): add section: monitor operation status #4104

Merged
merged 7 commits into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 docs/components/operate/userguide/monitor-operation-status.md
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:
Copy link
Contributor

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."?

Copy link
Contributor Author

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.


![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)
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,7 @@ Some elements do not support specific modifications:
- Events attached to event-based gateways
- **Move** modification is not possible for a subprocess itself.
- **Move** modifications are currently not possible for elements with multiple running scopes.

## Monitor the modification status

Please check the section [monitor operation status](/components/operate/userguide/monitor-operation-status.png) to learn how to monitor the status of an operation.
12 changes: 2 additions & 10 deletions docs/components/operate/userguide/process-instance-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,6 @@ Now, you can see a preview of how flow nodes are mapped and how many process ins

![operate-view-process-filters](./img/process-instance-migration/summary.png)

## Monitor the migration progress
## Monitor the migration status
christinaausley marked this conversation as resolved.
Show resolved Hide resolved

After the migration operation is started, you are redirected to the instances list view where the migration progress can be monitored in the operations panel:

1. Click the **Instances** link in the operations panel entry to check how many process instances have been migrated to the target process version.

In this example, all three process instances have been successfully migrated to version 2 of `orderProcess`.

If a process instance has not been migrated (due to [limitations on the Zeebe side](/components/concepts/process-instance-migration.md#limitations)) it will still show the source process version in the instances list.

![operate-view-process-filters](./img/process-instance-migration/operations-panel.png)
Please check the section [monitor operation status](/components/operate/userguide/monitor-operation-status.png) to learn how to monitor the status of a migration operation.
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,7 @@ Some elements do not support specific modifications:
- **Add token**/**Move tokens to** modifications are currently not possible for elements with multiple running scopes.

![not-supported-flow-nodes](../../../images/operate/modifications/not-supported-flow-nodes.png)

## Monitor the modification status
christinaausley marked this conversation as resolved.
Show resolved Hide resolved

Please check the section [monitor operation status](/components/operate/userguide/monitor-operation-status.png) to learn how to monitor the status of an operation.
4 changes: 4 additions & 0 deletions docs/components/operate/userguide/selections-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,7 @@ To create a selection and apply an operation, take the following steps:
After confirmation, you can see the **Operations** panel with the current status of all operations.

![operate-batch-retry](./img/selections-and-operations/operate-operations-panel.png)

## Monitor the operation status

Please check the section [monitor operation status](/components/operate/userguide/monitor-operation-status.png) to learn how to monitor the status of an operation.
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,7 @@ module.exports = {
],
},
"components/operate/userguide/process-instance-migration",
"components/operate/userguide/monitor-operation-status",
],
},
],
Expand Down
Loading