SGM Field Definitions v1
Field definitions we will use in the SWIM Grid Monitor portal
"SWIM Grid Monitor" Fields Available
Derived from the Fusion Grid Monitor's (FGM) data field definitions. New fields relative to FGM are listed in italics. Some fields will not be used initially, but are being retained for anticipated future use.
- code (String)
- The IPS component associated with the event. Framework generated
- comment (String)
- Comment field to add additional information. Need to figure out how this related to rcomment
- contact (String)
- Possible future use for contact person for active component
- eventtype (string)
- Differentiates metadata transmissions (implementation deferred) from framework events and possibly other types of events). Framework provided Allowed values: metadata, framework, application
- fcode (String)
- Possible future use for component method associated with event
- host (String)
- Host or platform name on which simulation is running. Framework provided
- logfile (String)
- Possible future use for URL to log file
- ok(True/False)
- Controls error state. If "false", the state will be displayed red, denoting an error. Framework provided
- outputprefix (string)
- User-specific string used to modify filenames in output tree. Same as config file parameter, which allows users to overlay outputs from multiple simulation runs into the same directory tree (i.e. ensembles of simulations). Framework provided
- phystimestamp (string)
- Allows the driver to convey information about the current simulation timestep to the portal. Content is not specifically defined. The expectation is that it will be something meaningful for SGM users to track the progress of a long-running simulation.
- queueat (String)
- Possible future use Time in which the code run was submitted to a queue.
- queuename (String)
- Possible future use Queue to which the code run was submitted.
- rcomment (String)
- Additional user comments regarding the code run. Need to figure out relationship with comment field
- runid (String)
- Run ID which is used to identify the code run. Global runid provided by portal, otherwise framework generated UUID if unable to get from portal
- seqnum (Long)
- Sequence number for events sent to the portal by the job (runid). Will help identify missing messages and facilitate replay/merging of event logs where the portal is unreachable for some or all of the simulation. Framework generated
- simname (string)
- User-specified simulation name. Same as config file parameter used to set the top level directory name for simulation output
- startat (String)
- Time in which the code run began running. Framework provided
- state (String)
- Status of the code run (see below). Framework provided
- stopat (String)
- Time in which the code run stopped running. Framework provided
- tag (String)
- User-specified text string, which can be used to help group or identify runs config file parameter
- tokamak (String)
- Possible future user to identify machine config file in use
- user (String)
- User who requested the code run. Framework provided, maybe overridden by config file parameter
- walltime (Long)
- Total wall time taken by the code run. Framework provided
Unused FGM Fields
The following fields in FGM do not immediately appear to be useful for SGM.
- cputime (Long)
- Total CPU time taken by the code run. Too hard to produce a meaningful value for our simulations
- ftphost (String)
- FTP host where the logfile for the post is located. Turn logfile into a URI instead
- priority (String)
- The priority level at which the code run was run at.
- shot (Long)
- An additional long integer used to identify unique code runs.
State Field Values
The state field is used to report the status of a simulation run being tracked by SGM. Status values will be one of the following, while more specific information is reserved for the comment field.
- Queued
- Possible future use Code run has been queued, and is waiting to start.
- Fetching Inputs
- Possible future use File staging operations at the beginning of a component invocation
- Running
- Component is currently running.
- Writing Outputs
- Possible future use File staging operations at the end of a component invocation
- Completed
- Simulation run has successfully completed.
- Canceled
- Possible future use Simulation run has been cancelled by the user.
- Stopped
- Simulation run has halted, and is no longer running.
Unused FGM State Values
The following fields in FGM do not immediately appear to be useful for SGM.
- Requested
- A code run has been requested by the user.
- Certificate OK
- A valid Globus certificate exists.
- Authorization OK
- User is authorized to run the requested code.