REPORTING(5)               Grid Engine File Formats               REPORTING(5)



[1mNAME[0m
       reporting - Grid Engine reporting file format

[1mDESCRIPTION[0m
       A  Grid Engine system writes a reporting file to $SGE_ROOT/default/com-
       mon/reporting.  The reporting file contains data that can be  used  for
       accounting,  monitoring and analysis purposes.  It contains information
       about the cluster (hosts,  queues,  load  values,  consumables,  etc.),
       about the jobs running in the cluster and about sharetree configuration
       and usage.  All information is time related, events are dumped  to  the
       reporting  file  in  a  configurable  interval.  It allows to monitor a
       "real time" status of the cluster as well as historical analysis.

[1mFORMAT[0m
       The reporting file is an ASCII file.  Each line  contains  one  record,
       and  the  fields  of  a  record  are separated by a delimiter (:).  The
       reporting file contains records of different type. Each record type has
       a specific record structure.

       The first two fields are common to all reporting records:

       [1mtime   [22mTime (GMT unix timestamp) when the record was created.

       [1mrecord type[0m
              Type  of  the accounting record.  The different types of records
              and their structure are described in the following text.

   [1mnew_job[0m
       The new_job record is written whenever a  new  job  enters  the  system
       (usually by a submitting command). It has the following fields:

       [1msubmission_time[0m
              Time (GMT unix time stamp) when the job was submitted.

       [1mjob_number[0m
              The job number.

       [1mtask_number[0m
              The  array  task id. Always has the value -1 for new_job records
              (as we don't have array tasks yet).

       [1mpe_taskid[0m
              The task id of parallel tasks. Always has the value  "none"  for
              new_job records.

       [1mjob_name[0m
              The job name (from -N submission option)

       [1mowner  [22mThe job owner.

       [1mgroup  [22mThe unix group of the job owner.

       [1mproject[0m
              The project the job is running in.

       [1mdepartment[0m
              The department the job owner is in.

       [1maccount[0m
              The  account  string  specified  for the job (from -A submission
              option).

       [1mpriority[0m
              The job priority (from -p submission option).

   [1mjob_log[0m
       The job_log record is written whenever a job, an array  task  or  a  pe
       tasks  is  changing  status. A status change can be the transition from
       pending to running, but can also be triggered by user actions like sus-
       pension of a job.  It has the following fields:

       [1mevent_time[0m
              Time (GMT unix time stamp) when the event was generated.

       [1mevent  [22mA one word description of the event.

       [1mjob_number[0m
              The job number.

       [1mtask_number[0m
              The  array  task id. Always has the value -1 for new_job records
              (as we don't have array tasks yet).

       [1mpe_taskid[0m
              The task id of parallel tasks. Always has the value  "none"  for
              new_job records.

       [1mstate  [22mThe state of the job after the event was processed.

       [1muser   [22mThe  user  who  initiated the event (or special usernames "qmas-
              ter", "scheduler" and "execd" for actions of the  system  itself
              like scheduling jobs, executing jobs etc.).

       [1mhost   [22mThe  host  from  which the action was initiated (e.g. the submit
              host, the qmaster host, etc.).

       [1mstate_time[0m
              Reserved field for later use.

       [1msubmission_time[0m
              Time (GMT unix time stamp) when the job was submitted.

       [1mjob_name[0m
              The job name (from -N submission option)

       [1mowner  [22mThe job owner.

       [1mgroup  [22mThe unix group of the job owner.

       [1mproject[0m
              The project the job is running in.

       [1mdepartment[0m
              The department the job owner is in.

       [1maccount[0m
              The account string specified for the  job  (from  -A  submission
              option).

       [1mpriority[0m
              The job priority (from -p submission option).

       [1mmessage[0m
              A message describing the reported action.

   [1macct[0m
       Records of type acct are accounting records. Normally, they are written
       whenever a job, a task of an array job, or the task of a  parallel  job
       terminates.  However, for long running jobs an intermediate acct record
       is created once a day  after  a  midnight.  This  results  in  multiple
       accounting  records  for a particular job and allows for a fine-grained
       resource usage monitoring over time.  Accounting records  comprise  the
       following fields:

       [1mqname  [22mName of the cluster queue in which the job has run.

       [1mhostname[0m
              Name of the execution host.

       [1mgroup  [22mThe  effective group id of the job owner when executing the job.

       [1mowner  [22mOwner of the Grid Engine job.

       [1mjob_name[0m
              Job name.

       [1mjob_number[0m
              Job identifier - job number.

       [1maccount[0m
              An account string as specified by the [4mqsub[24m(1)  or  [4mqalter[24m(1)  [1m-A[0m
              option.

       [1mpriority[0m
              Priority value assigned to the job corresponding to the [1mpriority[0m
              parameter in the queue configuration (see [4mqueue_conf[24m(5)).

       [1msubmission_time[0m
              Submission time (GMT unix time stamp).

       [1mstart_time[0m
              Start time (GMT unix time stamp).

       [1mend_time[0m
              End time (GMT unix time stamp).

       [1mfailed [22mIndicates the problem which occurred in case a job could not  be
              started on the execution host (e.g. because the owner of the job
              did not have a valid account on that machine).  If  Grid  Engine
              tries  to  start a job multiple times, this may lead to multiple
              entries in the accounting file corresponding to the same job ID.

       [1mexit_status[0m
              Exit status of the job script (or Grid Engine specific status in
              case of certain error conditions).

       [1mru_wallclock[0m
              Difference between [1mend_time [22mand [1mstart_time [22m(see above).

       The remainder of the accounting entries follows  the  contents  of  the
       standard UNIX rusage structure as described in [4mgetrusage[24m(2).  Depending
       on the operating system where the job was executed some of  the  fields
       may be 0.  The following entries are provided:

              [1mru_utime[0m
              [1mru_stime[0m
              [1mru_maxrss[0m
              [1mru_ixrss[0m
              [1mru_ismrss[0m
              [1mru_idrss[0m
              [1mru_isrss[0m
              [1mru_minflt[0m
              [1mru_majflt[0m
              [1mru_nswap[0m
              [1mru_inblock[0m
              [1mru_oublock[0m
              [1mru_msgsnd[0m
              [1mru_msgrcv[0m
              [1mru_nsignals[0m
              [1mru_nvcsw[0m
              [1mru_nivcsw[0m



       [1mproject[0m
              The project which was assigned to the job.

       [1mdepartment[0m
              The department which was assigned to the job.

       [1mgranted_pe[0m
              The parallel environment which was selected for that job.

       [1mslots  [22mThe  number  of  slots  which  were dispatched to the job by the
              scheduler.

       [1mtask_number[0m
              Array job task index number.

       [1mcpu    [22mThe cpu time usage in seconds.

       [1mmem    [22mThe integral memory usage in Gbytes seconds.

       [1mio     [22mThe amount of data transferred in input/output operations.

       [1mcategory[0m
              A string specifying the job category.

       [1miow    [22mThe io wait time in seconds.

       [1mpe_taskid[0m
              If this identifier is set the task was part of  a  parallel  job
              and was passed to Grid Engine via the qrsh -inherit interface.

       [1mmaxvmem[0m
              The maximum vmem size in bytes.

       [1marid   [22mAdvance  reservation identifier. If the job used resources of an
              advance reservation then this field contains a positive  integer
              identifier otherwise the value is "[1m0[22m" .

   [1mqueue[0m
       Records  of  type  queue  contain  state  information for queues (queue
       instances).  A queue record has the following fields:

       [1mqname  [22mThe cluster queue name.

       [1mhostname[0m
              The hostname of a specific queue instance.

       [1mreport_time[0m
              The time (GMT unix time stamp) when a  state  change  was  trig-
              gered.

       [1mstate  [22mThe new queue state.

   [1mqueue_consumable[0m
       A  queue_consumable  record contains information about queue consumable
       values in addition to queue state information:

       [1mqname  [22mThe cluster queue name.

       [1mhostname[0m
              The hostname of a specific queue instance.

       [1mreport_time[0m
              The time (GMT unix time stamp) when a  state  change  was  trig-
              gered.

       [1mstate  [22mThe new queue state.

       [1mconsumables[0m
              Description  of  consumable  values.  Information about multiple
              consumables is separated by space.  A consumable description has
              the format <name>=<actual_value>=<configured value>.

   [1mhost[0m
       A  host  record  contains information about hosts and host load values.
       It contains the following information:

       [1mhostname[0m
              The name of the host.

       [1mreport_time[0m
              The time (GMT unix time stamp) when the reported information was
              generated.

       [1mstate  [22mThe new host state.  Currently, Grid Engine doesn't track a host
              state, the field is reserved for future use. Always contains the
              value X.

       [1mload values[0m
              Description of load values. Information about multiple load val-
              ues is separated by space.  A load  value  description  has  the
              format <name>=<actual_value>.

   [1mhost_consumable[0m
       A host_consumable record contains information about hosts and host con-
       sumables.  Host consumables can for example be licenses.   It  contains
       the following information:

       [1mhostname[0m
              The name of the host.

       [1mreport_time[0m
              The time (GMT unix time stamp) when the reported information was
              generated.

       [1mstate  [22mThe new host state.  Currently, Grid Engine doesn't track a host
              state, the field is reserved for future use. Always contains the
              value X.

       [1mconsumables[0m
              Description of consumable  values.  Information  about  multiple
              consumables is separated by space.  A consumable description has
              the format <name>=<actual_value>=<configured value>.

   [1msharelog[0m
       The Grid Engine qmaster can dump information about sharetree configura-
       tion  and  use  to  the reporting file.  The parameter [4msharelog[24m sets an
       interval in which sharetree information will be dumped.  It is  set  in
       the format HH:MM:SS. A value of 00:00:00 configures qmaster not to dump
       sharetree information. Intervals of several minutes  up  to  hours  are
       sensible  values for this parameter.  The record contains the following
       fields

       [1mcurrent time[0m
              The present time

       [1musage time[0m
              The  time used so far

       [1mnode name[0m
              The node name

       [1muser name[0m
              The user name

       [1mproject name[0m
              The project name

       [1mshares [22mThe total shares

       [1mjob count[0m
              The job  count

       [1mlevel  [22mThe percentage of shares used

       [1mtotal  [22mThe adjusted percentage of shares used

       [1mlong target share[0m
              The long target percentage of resource shares used

       [1mshort target share[0m
              The short target percentage of resource shares used

       [1mactual share[0m
              The actual percentage of resource shares used

       [1musage  [22mThe combined shares used

       [1mcpu    [22mThe cpu used

       [1mmem    [22mThe memory used

       [1mio     [22mThe IO used

       [1mlong target cpu[0m
              The long target cpu used

       [1mlong target mem[0m
              The long target memory used

       [1mlong target io[0m
              The long target IO used

   [1mnew_ar[0m
       A new_ar record contains information about advance reservation objects.
       Entries  of  this  type will be added if an advance reservation is cre-
       ated.  It contains the following information:

       [1msubmission_time[0m
              The time (GMT unix time stamp) when the advance reservation  was
              created.

       [1mar_number[0m
              The advance reservation number identifying the reservation.

       [1mar_owner[0m
              The owner of the advance reservation.

   [1mar_attribute[0m
       The  ar_attribute  record is written whenever a new advance reservation
       was added or the attribute  of  an  existing  advance  reservation  has
       changed. It has following fields.

       [1mevent_time[0m
              The time (GMT unix time stamp) when the event was generated.

       [1msubmission_time[0m
              The  time (GMT unix time stamp) when the advance reservation was
              created.

       [1mar_number[0m
              The advance reservation number identifying the reservation.

       [1mar_name[0m
              Name of the advance reservation.

       [1mar_account[0m
              An account string which was specified during the creation of the
              advance reservation.

       [1mar_start_time[0m
              Start time.

       [1mar_end_time[0m
              End time.

       [1mar_granted_pe[0m
              The  parallel  environment  which  was  selected  for an advance
              reservation.

       [1mar_granted_resources[0m
              The granted resources which were selected for an advance  reser-
              vation.

   [1mar_log[0m
       The ar_log record is written whenever a advance reservation is changing
       status. A status change can be from pending to active, but can also  be
       triggered by system events like host outage. It has following fields.

       [1mar_state_change_time[0m
              The  time  (GMT  unix  time stamp) when the event occurred which
              caused a state change.

       [1msubmission_time[0m
              The time (GMT unix time stamp) when the advance reservation  was
              created.

       [1mar_number[0m
              The advance reservation number identifying the reservation.

       [1mar_state[0m
              The new state.

       [1mar_event[0m
              An event id identifying the event which caused the state change.

       [1mar_message[0m
              A message describing the event which caused the state change.

   [1mar_acct[0m
       The ar_acct records are accounting records which are written for  every
       queue  instance  whenever  a  advance  reservation  terminates. Advance
       reservation accounting records comprise following fields.

       [1mar_termination_time[0m
              The time (GMT unix time stamp) when the advance reservation ter-
              minated.

       [1msubmission_time[0m
              The  time (GMT unix time stamp) when the advance reservation was
              created.

       [1mar_number[0m
              The advance reservation number identifying the reservation.

       [1mar_qname[0m
              Cluster queue name which the advance reservation reserved.

       [1mar_hostname[0m
              The name of the execution host.

       [1mar_slots[0m
              The number of slots which were reserved.

[1mSEE ALSO[0m
       [4msge_conf[24m(5).  [4mhost_conf[24m(5).

[1mCOPYRIGHT[0m
       See [4mge_intro[24m(1) for a full statement of rights and permissions.



GE 6.2u2                 $Date: 2008/04/22 15:49:02 $             REPORTING(5)
