info

bgqmap info is a tool aimed to explore the metadata of your jobs or to get the commands of certain jobs.

Exploring the metadata

bgqmap info can explore the metadata of your jobs and retrieve the fields of interest.

The first column corresponds to the job id and each of the other columns correspond to the requested fields. Missing fields return and empty string.

To check what fields you can return, you can simply take a look at one of the .info files. To access nested elements use . to divide the levels (e.g. usage.time.elapsed).

The return data is tab separated or | separated if the collapse flag is provided.

Usage

bgqmap info -s <status> -l <bgqmap logs folder> <field 1> <field 2> ... <field n>

Filtering commands

bgqmap info can also return a subset of your commands file that corresponds to the ones whose job have a certain status.

This option is enabled when no fields are passed in the command line. Moreover, in this case, the collapse flag removes empty lines from the output.

Usage

bgqmap info -s <status> -l <bgqmap logs folder>

Usage

Usage: bgqmap info [OPTIONS] FIELDS

Search for FIELDS in the metadata files in FOLDER

FIELDS can be any key in the metadata dictionary. (nested keys can be accessed using ‘.’: e.g. usage.time.elapsed). Missing fields will return an empty string. The return information is tab separated or ‘|’ separated if the collapse flag if passed.

If no FIELDS are passed, then the output corresponds to the input command lines that match that resulted in jobs with that status criteria. In this case, the collapse flag forces removes blank lines from the output.

Options:
-f, --file PATH
 File to write the output to
-s, –status [completed|failed|other|pending|running|unsubmitted|all|c|f|o|p|r|u|a]
Job status of interest
--collapse Collapse the output
-l, --logs PATH
 Output folder of the bgqmap log files. Default is current directory.
-h, --help Show this message and exit.

Examples

Get the fields of interest from your jobs:

$ bgqmap info -s completed -l examples/output/hello usage.time.elapsed retries
id      usage.time.elapsed      retries
1       00:00:12        0
0       00:00:07        0