Monitor activity

Viewing previously run actions in BOULDER OPAL

The activity monitor allows you to view the progress and status of previously run actions. There are multiple ways provided for accessing the activity monitor as shown below.

CLI

The CLI method allows you to use the qctrl activity command through your terminal to view previously run actions. If you have not used the interactive authentication method mentioned here before, you will be redirected to the interactive authentication method first. Information on the qctrl activity command can be found as follows:

$ qctrl activity --help

Pagination and filtering by status and action type is supported. All filtering commands are optional. If called without any additional commands the script will return the most recent actions you have run.

$ qctrl activity --limit 10 --offset 0 --status SUCCESS --type ROBUST_OPTIMIZE

The various --status and --type options are viewable through the --options command. For example to view the different type options to filter by, you can run the following command:

$ qctrl activity --options type

Qctrl()

The activity monitor can also be accessed through the Qctrl() object.

$ python
>>> from qctrl import Qctrl
>>> qctrl = Qctrl()
>>> qctrl.activity_monitor()

Similarly to the command line option, this option also supports paginations and filtering by status and action type and returns the most recent actions you have run (if no filtering options are provided).

$ python
>>> from qctrl import Qctrl
>>> qctrl = Qctrl()
>>> qctrl.activity_monitor(limit=2, offset=0, status="FAILURE", action_type="FILTER_FUNCTION")

Web Access

The activity monitor can also be accessed through the BOULDER OPAL web app present here: https://app.q-ctrl.com/boulder-opal/activityMonitor