moving execution stats to WorkflowManager

Signed-off-by: Neil South <[email protected]>

Author: neildsouth

.github/.gitversion.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-next-version: 0.1.2
+next-version: 0.1.5
 assembly-versioning-scheme: MajorMinorPatchTag
 mode: ContinuousDelivery
 branches:

docs/setup/mwm-workflow-spec.md

@@ -24,7 +24,7 @@ A workflow is a standard template that contains a list of tasks that can be ran
 
 The first task to be ran, will always be the first task in the list. The next task/tasks to be ran must be listed in the [Task Destinations](#task-destinations) of the task. A workflow requires at least one task.
 
-Workflows can be created or updated via the [Workflow API](https://github.com/Project-MONAI/monai-deploy-workflow-manager/blob/develop/docs/api/rest/workflow.md). 
+Workflows can be created or updated via the [Workflow API](https://github.com/Project-MONAI/monai-deploy-workflow-manager/blob/develop/docs/api/rest/workflow.md).
 
 # Contents
 
@@ -142,7 +142,7 @@ The following is an example of the structure of a workflow.
 The following is an example of a complete workflow:
 ![scenario1](../images/workflow_examples/scenario1.png)
 
-An example of a workflow with two tasks: 
+An example of a workflow with two tasks:
 
 1. Argo task
 2. Export Task
@@ -240,7 +240,7 @@ It also defines the "PROD_PACS" output destination, meaning that it can be used:
 Tasks are the basic building block of a workflow. They are provided as a list - the first Task in the list is executed when the workflow is triggered.
 Subsequent tasks are triggered by the `task_destinations` specified by previous tasks.
 
-# Task Object 
+# Task Object
 
 ### Task Types
 These tasks are borken down into different types:
@@ -292,8 +292,8 @@ The following are examples of the task json structure including required args fo
     ]
   },
   "task_destinations": [
-    { 
-      "name": "export-task-id" 
+    {
+      "name": "export-task-id"
     }
   ]
 }
@@ -364,7 +364,7 @@ Depending of the type of task, the task object may contain additional fields.
 Router tasks don't have additional fields. They are used to contain `task_destinations` so that workflow processing can be directed to the desired next step.
 
 #### Export
-These are task types that allow for artifacts to be exported based on the input artifacts list. This task type should not have Out artifacts listed.  
+These are task types that allow for artifacts to be exported based on the input artifacts list. This task type should not have Out artifacts listed.
 The task also requires these extra attributes:-
 
 | Property | Type | Description |
@@ -403,7 +403,7 @@ Example (output sent to another task if the patient is female, otherwise to PACS
 Export destinations define an external location to which the output of the task can be sent. This will take the form of an event published to a pub/sub service notifying of an available export to a specific destination reference. Most commonly, the export location will be a PACs system and the notification will be picked up by the Monai Informatics Gateway.
 
 #### Plugin
-These are tasks are Named the same as the installed Pluging. 
+These are tasks are Named the same as the installed Pluging.
 The task also requires these extra attributes:-
 
 | Property | Type | Description |
@@ -414,7 +414,7 @@ The task also requires these extra attributes:-
 The args requirements for argo plugin can be found [here](#argo).
 
 ### Task Arguments
-Each task plugin requires specific arguments to be provided in the args dictionary. This allows all task types to support as many additional values as necessary without the need to bloat the workflow spec. 
+Each task plugin requires specific arguments to be provided in the args dictionary. This allows all task types to support as many additional values as necessary without the need to bloat the workflow spec.
 
 #### Argo
 The Argo plugin triggers workflows pre-deployed onto an [Argo workflow server](https://argoproj.github.io/argo-events/).
@@ -425,25 +425,11 @@ The Task's "args" object should contain the following fields:
 
 | Property | Type | Required | Description |
 |------|------|------|------|
-|workflow_template_name|str|Yes|The ID of this workflow as registered on the Argo server.|
-|namespace|str|Yes|The namespace of the argo workflow.|
-|server_url|url|Yes|The URL of the Argo server.|
-|allow_insecure|bool|No|Allow insecure connections to argo from the plug-in.|
-|parameters|dictionary|No|Key value pairs, Argo parameters that will be passed on to the Argo workflow.|
-|priority_class|string|No|The name of a valid Kubernetes priority class to be assigned to the Argo workflow pods|
-|resources|dictionary|No|A resource requests & limits object (see below). These will be applied to the Argo workflow pods|
-
-##### Resource Request Object
-
-Resource request parameters should be included in the task args object dictionary, as a string dictionary. The resources dictionary and all included values below are optional. 
-
-| Property | Type | Description |
-|------|------|------|
-|memory_reservation|str|A valid [Kubernetes memory request value](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory).|
-|cpu_reservation|url|A valid [Kubernetes CPU request value](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu).|
-|gpu_limit|dictionary|The number of GPUs to be used by this task.|
-|memory_limit|string|The maximum amount of memory this task may use|
-|cpu_limit|object|The maximum amount of CPU this task may use. See |
+|workflow_template_name|string|Yes|The ID of this workflow as registered on the Argo server.|
+|priority_class|string|No|The name of a valid Kubernetes priority class to be assigned to the Argo workflow pods.|
+|gpu_required|string|No|Whether a GPU is to be used by this task.|
+|memory_gb|string|No|The maximum amount of memory in gigabytes this task may use.|
+|cpu|string|No|The maximum amount of CPU this task may use.|
 
 For more information about Kubernetes requests & limits, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/.
 
@@ -501,7 +487,7 @@ As you can see in the example below, input artifacts require a _value_. This is
 
 #### DICOM Input
 
-If payload DICOM inputs are to be used in a given task, the value of the input must be `context.input.dicom`. This will to resolve to the `{payloadId}/dcm` folder within Minio / S3. 
+If payload DICOM inputs are to be used in a given task, the value of the input must be `context.input.dicom`. This will to resolve to the `{payloadId}/dcm` folder within Minio / S3.
 
 Example:
 ```json
@@ -700,11 +686,11 @@ The following examples both function the same and act as an AND condition.
 ## Evaluators
 Conditional evaluators are logical statement strings that may be used to determine which tasks are executed. They can make use of the execution context _metadata_ and dicom tags. All conditions must evaluate to true in order for the task to be triggered.
 
- [A detailed breakdown of conditional logic can be found here.](https://github.com/Project-MONAI/monai-deploy-workflow-manager/blob/develop/guidelines/mwm-conditionals.md) 
+ [A detailed breakdown of conditional logic can be found here.](https://github.com/Project-MONAI/monai-deploy-workflow-manager/blob/develop/guidelines/mwm-conditionals.md)
 
 ### Supported Evaulators
 
- 
+
  Conditional evaluators should support evaluating workflow variables against predefined values with the following operators:
 
     < (Valid for integers)
@@ -765,9 +751,9 @@ Example (status):
 
 #### Result Metadata & Execution Stats - Using Dictionary Values
 
-The Result Metadata and Execution Stats are populated by the plugin and are added to the workflow instance once a task is completed to provide some output of a task. Each plugin will have its own implementation to populate the result metadata. 
+The Result Metadata and Execution Stats are populated by the plugin and are added to the workflow instance once a task is completed to provide some output of a task. Each plugin will have its own implementation to populate the result metadata.
 
-Because `result` and `execution_stats` are a dictionary, the section after `context.executions.task_id.result` or  `context.executions.task_id.execution_stats` is the key to be checked in the result/execution_stats dictionary. 
+Because `result` and `execution_stats` are a dictionary, the section after `context.executions.task_id.result` or  `context.executions.task_id.execution_stats` is the key to be checked in the result/execution_stats dictionary.
 
 For conditional statements, the key specified is case sensitive and must match exactly to the key which has been output by the model and saved in the result/execution_stats dictionary.
 
@@ -807,9 +793,9 @@ The result metadata for an Argo task is populated by a `metadata.json` that is i
 }
 ```
 
-If metadata is to be used in a conditional the `metadata.json` must be present somewhere in the output directory and a valid JSON dictionary. It will automatically be imported if it is in the directory. 
+If metadata is to be used in a conditional the `metadata.json` must be present somewhere in the output directory and a valid JSON dictionary. It will automatically be imported if it is in the directory.
 
-An example format of the metadata.json can be found below: 
+An example format of the metadata.json can be found below:
 
 execution stats are populated from the argo execution values returned automatically.
 
@@ -916,4 +902,4 @@ Name:
 Description:
 ```python
 {{context.workflow.description}} == 'This workflow is a valid workflow'
-```
+```

src/AssemblyInfo.cs

@@ -18,4 +18,4 @@
 
 [assembly: AssemblyFileVersion("0.0.0.0")]
 [assembly: AssemblyVersion("0.0.0.0")]
-[assembly: AssemblyInformationalVersion("0.0.0-development")]
+[assembly: AssemblyInformationalVersion("0.0.0-development")]

src/Monai.Deploy.WorkflowManager.sln

@@ -82,6 +82,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Monai.Deploy.WorkflowManage
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Monai.Deploy.WorkflowManager.Common.Tests", "..\tests\UnitTests\Common.Tests\Monai.Deploy.WorkflowManager.Common.Tests.csproj", "{75A4AEDA-0386-4B2D-9DBA-BC9AE733660E}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Monai.Deploy.WorkflowManager.Services", "WorkflowManager\Monai.Deploy.WorkflowManager.Services\Monai.Deploy.WorkflowManager.Services.csproj", "{526FF10C-1C7F-4C26-8E8A-D7ACD65F5467}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Monai.Deploy.WorkflowManager.Services.Tests", "..\tests\UnitTests\WorkflowManager.Services.Tests\Monai.Deploy.WorkflowManager.Services.Tests.csproj", "{0D40F7D6-3747-4280-8EB3-9F3A18AC1125}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -228,6 +232,14 @@ Global
 		{75A4AEDA-0386-4B2D-9DBA-BC9AE733660E}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{75A4AEDA-0386-4B2D-9DBA-BC9AE733660E}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{75A4AEDA-0386-4B2D-9DBA-BC9AE733660E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{526FF10C-1C7F-4C26-8E8A-D7ACD65F5467}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{526FF10C-1C7F-4C26-8E8A-D7ACD65F5467}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{526FF10C-1C7F-4C26-8E8A-D7ACD65F5467}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{526FF10C-1C7F-4C26-8E8A-D7ACD65F5467}.Release|Any CPU.Build.0 = Release|Any CPU
+		{0D40F7D6-3747-4280-8EB3-9F3A18AC1125}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0D40F7D6-3747-4280-8EB3-9F3A18AC1125}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0D40F7D6-3747-4280-8EB3-9F3A18AC1125}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0D40F7D6-3747-4280-8EB3-9F3A18AC1125}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -269,6 +281,8 @@ Global
 		{81E3F943-B992-4C81-AA09-A17C05081236} = {37A19144-CEA5-47A2-9FFD-22C522E8B895}
 		{C853A9E3-C53D-4B1A-BFDA-228689A8C94C} = {71DDEE7B-E213-4E39-A7F4-4646783A27F7}
 		{75A4AEDA-0386-4B2D-9DBA-BC9AE733660E} = {71DDEE7B-E213-4E39-A7F4-4646783A27F7}
+		{526FF10C-1C7F-4C26-8E8A-D7ACD65F5467} = {AC5B198A-C3F2-4AD2-B532-E71B4630BDD5}
+		{0D40F7D6-3747-4280-8EB3-9F3A18AC1125} = {71DDEE7B-E213-4E39-A7F4-4646783A27F7}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {DC0D56C8-D8CB-45CE-B528-F3DCF86D63ED}

src/Shared/Configuration/InformaticsGatewayConfiguration.cs

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2022 MONAI Consortium
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+using Microsoft.Extensions.Configuration;
+
+namespace Monai.Deploy.WorkflowManager.Configuration
+{
+    public class InformaticsGatewayConfiguration
+    {
+        [ConfigurationKeyName("apiHost")]
+        public string ApiHost { get; set; }
+    }
+}

src/Shared/Shared/ApiControllerBase.cs

@@ -22,7 +22,6 @@
 using Monai.Deploy.WorkflowManager.Shared.Filter;
 using Monai.Deploy.WorkflowManager.Shared.Wrappers;
 using Monai.Deploy.WorkflowManager.Shared.Services;
-using Microsoft.AspNetCore.Routing;
 
 namespace Monai.Deploy.WorkflowManager.ControllersShared
 {
@@ -85,7 +84,7 @@ public PagedResponse<IEnumerable<T>> CreatePagedReponse<T>(IEnumerable<T> pagedD
 
         public StatsPagedResponse<IEnumerable<T>> CreateStatsPagedReponse<T>(IEnumerable<T> pagedData, PaginationFilter validFilter, long totalRecords, IUriService uriService, string route)
         {
-            var response = new StatsPagedResponse<IEnumerable<T>>(pagedData, validFilter.PageNumber, validFilter.PageSize.Value);
+            var response = new StatsPagedResponse<IEnumerable<T>>(pagedData, validFilter.PageNumber, validFilter.PageSize ?? 10);
             response.SetUp(validFilter, totalRecords, uriService, route);
             return response;
         }

src/Shared/Shared/Filter/TimeFilter.cs

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2023 MONAI Consortium
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Monai.Deploy.WorkflowManager.Shared.Filter
+{
+    public class TimeFilter : PaginationFilter
+    {
+        public DateTime StartTime { get; set; }
+
+        public DateTime EndTime { get; set; }
+    }
+}

src/Shared/Shared/MonaiServiceLocator.cs

@@ -41,7 +41,7 @@ public Dictionary<string, ServiceStatus> GetServiceStatus()
             return _runningServices.ToDictionary(k => k.ServiceName, v => v.Status);
         }
 
-        private IMonaiService GetService(Type type)
+        private IMonaiService? GetService(Type type)
         {
             Guard.Against.Null(type, nameof(type));
 
@@ -58,7 +58,7 @@ private static List<Type> LocateTypes()
                                             serviceType.IsAssignableFrom(p) &&
                                             p != serviceType &&
                                             !p.IsAbstract &&
-                                            p.FullName.StartsWith("Monai", StringComparison.InvariantCulture));
+                                            p.FullName is not null && p.FullName.StartsWith("Monai", StringComparison.InvariantCulture));
             return services.Distinct().ToList();
         }
 

src/TaskManager/TaskManager/Filter/TimeFilter.cs renamed to src/Shared/Shared/TimeFilter.cs

@@ -53,6 +53,21 @@ public static class ValidationConstants
         /// </summary>
         public static readonly string Notifications = "notifications";
 
+        /// <summary>
+        /// Key for the CPU.
+        /// </summary>
+        public static readonly string Cpu = "cpu";
+
+        /// <summary>
+        /// Key for the memory.
+        /// </summary>
+        public static readonly string Memory = "memory_gb";
+
+        /// <summary>
+        /// Key for the GPU.
+        /// </summary>
+        public static readonly string GpuRequired = "gpu_required";
+
         public enum ModeValues
         {
             QA,