DRAFT - WIP: Add api to monitor workflows. #139
Conversation
WIP: This is a draft proposal and a WIP. 2 apis completely covered in this first commit: list all workflows and list all instances for a given workflow. I started implementing the third api to list all activities for a given workflow instance, some problematics related to the veriables, activity type will be fixed in next commits.
| @@ -4,7 +4,7 @@ plugins { | |||
|
|
|||
| group = 'org.finos.symphony.wdk' | |||
|
|
|||
| ext.projectVersion = '1.2.0-SNAPSHOT' | |||
| ext.projectVersion = '1.3.0-SNAPSHOT' | |||
There was a problem hiding this comment.
This file should not be committed, it comes from #138 that still needs to be merged.
| @@ -26,7 +26,7 @@ public class ActivityExpiredNodeBuilder extends ActivityNodeBuilder { | |||
| builder = context.removeLastEventSubProcessBuilder().subProcessDone(); | |||
There was a problem hiding this comment.
changes in folder bpmn/builder are not related to this PR purpose, just removing warnings for an unused parameter..
| import java.util.stream.Collectors; | ||
|
|
||
| @RestController | ||
| @RequestMapping("v1/monitoring/workflows") |
There was a problem hiding this comment.
i feel that /monitoring is not necessary.
| this.monitoringService = monitoringService; | ||
| } | ||
|
|
||
| @GetMapping("/") |
There was a problem hiding this comment.
should we add swagger annotations to describe our api ?
| private String instanceId; | ||
| private String activityId; | ||
| private String type; //TODO: enum needed here | ||
| private InstanceStatusEnum status; |
There was a problem hiding this comment.
do we need the instance status inside an activity ?
There was a problem hiding this comment.
This is the activity instance status. An activity has instance like the process. InstanceStatusEnum is used for both the workflow process instance view and the activity view.
Since we always get this info from the historicService, it will always be "COMPLETED" so maybe we can get ride of it. Activity instances with ongoing execution should appear in the runtimeService, but they either stay there for a very short time or they are not even set there because the database is updated when no work is ongoing (maybe Camunda updates database in a batch or the process is synchronous..)
I can also change the class name to StatusEnum so it does not reflect the instance aspect.
There was a problem hiding this comment.
statusEnum sounds good, avoid the confusion between process instance and activity instance
workflow-bot-app/src/main/java/com/symphony/bdk/workflow/api/v1/mapper/WorkflowMapper.java
Outdated
Show resolved
Hide resolved
|
|
||
| @RequiredArgsConstructor | ||
| @Component | ||
| public class MonitoringService { |
There was a problem hiding this comment.
I would suggest to create first an interface, a DAO interface would be even better
yinan-symphony
force-pushed
the
monitoring-api
branch
from
7d9332c to
f36e233
Compare
Description
This is a draft proposal and a WIP. 2 apis completely covered in this first commit: list all workflows and list all instances for a given workflow.
I started implementing the third api to list all activities for a given workflow instance, some problematics related to the variables, activity type will be fixed in next commits.