The user Output Plugin

If a user chooses, the RUR output is written to a directory of the user.

The user plugin writes RUR output for a user's application to the user's home directory (default) or a user-defined location, only if the user has indicated that this behavior is desired (as described below).

The naming of the default output file(s), rur.suffix, is dependent on the value of the argument arg, which defines a report type and is set in the user section of the RUR configuration file. If arg is set to:

apid
An output file is created for each application executed and suffix is the apid.
jobid
An output file is created for each job submitted and suffix is the jobid
single
All output is placed in a single file and no suffix is appended to the output file name.

User Options

Users have the option to opt-in or out for the user plugin, redirect plugin output to a specific file or directory, or override the default report type.

  • By default, RUR data is written to a user's directory. A user must either create the file ~/.rur/user_output_optin to indicate that data should be written, or create a file that initiates one of the following two options.
    1. Users may redirect the output of RUR by specifying a redirect location in ~/.rur/user_output_redirect. The contents of this file must be a single line that specifies the absolute or relative (from the user's home directory) path of the directory or file to which the RUR output data is to be written. If the redirect file either does not exist, points to a path that does not exist, or points to a path to which the user does not have write permission, then the output is written to the user's home directory.
    2. A user with an existing ~/.rur/user_output_redirect file can temporarily stop RUR data from being written by setting the redirect path to /dev/null.
  • Additionally, the user may override the default report type by specifying a valid report type in ~/.rur/user_output_report_type. Valid report types are apid, jobid, or single, resulting in the user's RUR data being written to one file per application, one file per job, or a single file, respectively. If the file ~/.rur/user_output_report_type is empty or contains an invalid type, then the default report type, as defined in the configuration file, is created.