Make description more generic and add optional description argument

dockstore · Jan 15, 2024 · 0737cd9 · 0737cd9
1 parent c24c223
commit 0737cd9
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/metricsaggregator/README.md b/metricsaggregator/README.md
@@ -90,6 +90,9 @@ Usage: <main class> [options] [command] [command options]
         * -d, --data
             The file path to the CSV file containing workflow metrics from 
             Terra. The first line of the file should contain the CSV fields: workflow_id,status,workflow_start,workflow_end,workflow_runtime_minutes,source_url
+          -de, --description
+            Optional description about the metrics to include when submitting 
+            metrics to Dockstore
           --help
             Prints help for metricsaggregator
           -r, --recordSkipped

diff --git a/...csaggregator/src/main/java/io/dockstore/metricsaggregator/client/cli/CommandLineArgs.java b/...csaggregator/src/main/java/io/dockstore/metricsaggregator/client/cli/CommandLineArgs.java
@@ -91,15 +91,21 @@ public static class SubmitTerraMetrics extends CommandLineArgs {
         @Parameter(names = {"-r", "--recordSkipped"}, description = "Record skipped executions and the reason skipped to a CSV file")
         private boolean recordSkippedExecutions;
 
+        @Parameter(names = {"-de", "--description"}, description = "Optional description about the metrics to include when submitting metrics to Dockstore")
+        private String description;
+
         public File getConfig() {
             return config;
         }
 
-
         public String getDataFilePath() {
             return dataFilePath;
         }
 
+        public String getDescription() {
+            return description;
+        }
+
         public boolean isRecordSkippedExecutions() {
             return recordSkippedExecutions;
         }

diff --git a/...egator/src/main/java/io/dockstore/metricsaggregator/client/cli/TerraMetricsSubmitter.java b/...egator/src/main/java/io/dockstore/metricsaggregator/client/cli/TerraMetricsSubmitter.java
@@ -174,8 +174,11 @@ private void submitWorkflowExecutions(String sourceUrl, List<CSVRecord> workflow
                 .toList();
         final ExecutionsRequestBody executionsRequestBody = new ExecutionsRequestBody().runExecutions(workflowExecutionsToSubmit);
         try {
-            extendedGa4GhApi.executionMetricsPost(executionsRequestBody, Partner.TERRA.toString(), sourceUrlTrsInfo.trsId(), sourceUrlTrsInfo.version(),
-                    "Terra metrics from Q4 2023");
+            String description = "Submitted using the metricsaggregator's submit-terra-metrics command";
+            if (StringUtils.isNotBlank(submitTerraMetricsCommand.getDescription())) {
+                description += ". " + submitTerraMetricsCommand.getDescription();
+            }
+            extendedGa4GhApi.executionMetricsPost(executionsRequestBody, Partner.TERRA.toString(), sourceUrlTrsInfo.trsId(), sourceUrlTrsInfo.version(), description);
             numberOfExecutionsSubmitted.addAndGet(workflowMetricRecords.size());
         } catch (ApiException e) {
             logSkippedExecutions(sourceUrlTrsInfo.sourceUrl(), workflowMetricRecords, String.format("Could not submit execution metrics to Dockstore for workflow %s: %s", sourceUrlTrsInfo, e.getMessage()), skippedExecutionsCsvPrinter, false);