diff --git a/apps/cli/utilities/wf_monitor/README.md b/apps/cli/utilities/wf_monitor/README.md index 324afa805a9694447d2b0e57e67a20cf9c498e77..bd9b976d48cb6617aca92a50f5c6b01df196db2b 100644 --- a/apps/cli/utilities/wf_monitor/README.md +++ b/apps/cli/utilities/wf_monitor/README.md @@ -1,4 +1,21 @@ -# Workflow Monitor +# Workspaces Workflow Monitor + +Reads in an HTCondor log file and parses the relevant data from it, splitting it into events and formatting those into messages that are sent to the workspaces.workflow-service.workflow-status RabbitMQ exchange. + +``` +usage: wf_monitor [-h] [-P PROFILE] log_path + +Workspaces workflow monitor, version 4.0.0a1.dev1. Monitor execution of a workflow from the command line. + +positional arguments: + log_path path to the workflow's HTCondor log + +optional arguments: + -h, --help show this help message and exit + -P PROFILE, --profile PROFILE + profile name to use; e.g. test, production; DEFAULT: nmtest +``` + ## Design - Reads in HTCondor logs - HTCondor executes a job