Project

General

Profile

Actions

Bug #22850

open

Confusing reporting from a-c-r if you put options after positional arguments

Added by Brett Smith 11 months ago. Updated 10 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
CWL
Target version:
Story points:
-

Description

I made a mistake when editing a command line and tried to run the arv-cluster-activity report like this:

% arvados-cwl-runner --submit --no-wait --project-uuid=zzzzz-j7d0g-5a7dtzmporf5baw zzzzz-7fd4e-vcw2qviki3x4mz0 --output-name="April 2025" zzzzz-activity.yml
INFO /usr/bin/arvados-cwl-runner 3.0.0, arvados-python-client 3.0.0, cwltool 3.1.20240508115724
INFO Resolved 'zzzzz-7fd4e-vcw2qviki3x4mz0' to 'arvwf:zzzzz-7fd4e-vcw2qviki3x4mz0#main'
usage: zzzzz-7fd4e-vcw2qviki3x4mz0 [-h] [--exclude EXCLUDE] [--include_workflow_steps]
                                   [--prometheus_apikey PROMETHEUS_APIKEY] --prometheus_host PROMETHEUS_HOST
                                   [--prometheus_password PROMETHEUS_PASSWORD] [--prometheus_user PROMETHEUS_USER]
                                   [--reporting_days REPORTING_DAYS] [--reporting_end REPORTING_END]
                                   [--reporting_start REPORTING_START]
                                   [job_order]
zzzzz-7fd4e-vcw2qviki3x4mz0: error: the following arguments are required: --prometheus_host

I understand why this is an error and what it's trying to tell me. Here are things that I think would make it easier to understand:

  • a-c-r should log a specific error explaining that the parameters given for the workflow are incorrect. I think after the usage report so the user is likely to see it as the most recent thing, but I don't feel 100% about that.
  • The name of this program in the output should ideally be the filename of the original workflow, not just the record UUID. Seeing a usage report for cluster-activity.cwl would help clarify what usage I'm actually looking at.
Actions #1

Updated by Peter Amstutz 10 months ago

  • Target version set to Future
Actions

Also available in: Atom PDF