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



NNAAMMEE
       reporting - Grid Engine reporting file format

DDEESSCCRRIIPPTTIIOONN
       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.

FFOORRMMAATT
       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:

       ttiimmee   Time (GMT unix timestamp) when the record was created.

       rreeccoorrdd ttyyppee
              Type  of  the accounting record.  The different types of records
              and their structure are described in the following text.

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

       ssuubbmmiissssiioonn__ttiimmee
              Time (GMT unix time stamp) when the job was submitted.

       jjoobb__nnuummbbeerr
              The job number.

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

       ppee__ttaasskkiidd
              The task id of parallel tasks. Always has the value  "none"  for
              new_job records.

       jjoobb__nnaammee
              The job name (from -N submission option)

       oowwnneerr  The job owner.

       ggrroouupp  The unix group of the job owner.

       pprroojjeecctt
              The project the job is running in.

       ddeeppaarrttmmeenntt
              The department the job owner is in.

       aaccccoouunntt
              The  account  string  specified  for the job (from -A submission
              option).

       pprriioorriittyy
              The job priority (from -p submission option).

   jjoobb__lloogg
       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:

       eevveenntt__ttiimmee
              Time (GMT unix time stamp) when the event was generated.

       eevveenntt  A one word description of the event.

       jjoobb__nnuummbbeerr
              The job number.

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

       ppee__ttaasskkiidd
              The task id of parallel tasks. Always has the value  "none"  for
              new_job records.

       ssttaattee  The state of the job after the event was processed.

       uusseerr   The  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.).

       hhoosstt   The  host  from  which the action was initiated (e.g. the submit
              host, the qmaster host, etc.).

       ssttaattee__ttiimmee
              Reserved field for later use.

       ssuubbmmiissssiioonn__ttiimmee
              Time (GMT unix time stamp) when the job was submitted.

       jjoobb__nnaammee
              The job name (from -N submission option)

       oowwnneerr  The job owner.

       ggrroouupp  The unix group of the job owner.

       pprroojjeecctt
              The project the job is running in.

       ddeeppaarrttmmeenntt
              The department the job owner is in.

       aaccccoouunntt
              The account string specified for the  job  (from  -A  submission
              option).

       pprriioorriittyy
              The job priority (from -p submission option).

       mmeessssaaggee
              A message describing the reported action.

   aacccctt
       Records  of type acct are accounting records. They are written whenever
       a job, a task of an array job or the task of a parallel job terminates.
       Accounting records comprise the following fields:

       qqnnaammee  Name of the cluster queue in which the job has run.

       hhoossttnnaammee
              Name of the execution host.

       ggrroouupp  The  effective group id of the job owner when executing the job.

       oowwnneerr  Owner of the Grid Engine job.

       jjoobb__nnaammee
              Job name.

       jjoobb__nnuummbbeerr
              Job identifier - job number.

       aaccccoouunntt
              An account string as specified by the _q_s_u_b(1)  or  _q_a_l_t_e_r(1)  --AA
              option.

       pprriioorriittyy
              Priority value assigned to the job corresponding to the pprriioorriittyy
              parameter in the queue configuration (see _q_u_e_u_e___c_o_n_f(5)).

       ssuubbmmiissssiioonn__ttiimmee
              Submission time (GMT unix  time  stamp).   For  slave  tasks  of
              tightly  integrated parallel jobs, the submission_time is always
              set to 0.

       ssttaarrtt__ttiimmee
              Start time (GMT unix time stamp).

       eenndd__ttiimmee
              End time (GMT unix time stamp).

       ffaaiilleedd Indicates 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.

       eexxiitt__ssttaattuuss
              Exit status of the job script (or Grid Engine specific status in
              case of certain error conditions).

       rruu__wwaallllcclloocckk
              Difference between eenndd__ttiimmee and ssttaarrtt__ttiimmee (see above).

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

              rruu__uuttiimmee
              rruu__ssttiimmee
              rruu__mmaaxxrrssss
              rruu__iixxrrssss
              rruu__iissmmrrssss
              rruu__iiddrrssss
              rruu__iissrrssss
              rruu__mmiinnfflltt
              rruu__mmaajjfflltt
              rruu__nnsswwaapp
              rruu__iinnbblloocckk
              rruu__oouubblloocckk
              rruu__mmssggssnndd
              rruu__mmssggrrccvv
              rruu__nnssiiggnnaallss
              rruu__nnvvccssww
              rruu__nniivvccssww



       pprroojjeecctt
              The project which was assigned to the job.

       ddeeppaarrttmmeenntt
              The department which was assigned to the job.

       ggrraanntteedd__ppee
              The parallel environment which was selected for that job.

       sslloottss  The  number  of  slots  which  were dispatched to the job by the
              scheduler.

       ttaasskk__nnuummbbeerr
              Array job task index number.

       ccppuu    The cpu time usage in seconds.

       mmeemm    The integral memory usage in Gbytes seconds.

       iioo     The amount of data transferred in input/output operations.

       ccaatteeggoorryy
              A string specifying the job category.

       iiooww    The io wait time in seconds.

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

       mmaaxxvvmmeemm
              The maximum vmem size in bytes.

   qquueeuuee
       Records  of  type  queue  contain  state  information for queues (queue
       instances).  A queue record has the following fields:

       qqnnaammee  The cluster queue name.

       hhoossttnnaammee
              The hostname of a specific queue instance.

       rreeppoorrtt__ttiimmee
              The time (GMT unix time stamp) when a  state  change  was  trig-
              gered.

       ssttaattee  The new queue state.

   qquueeuuee__ccoonnssuummaabbllee
       A  queue_consumable  record contains information about queue consumable
       values in addition to queue state information:

       qqnnaammee  The cluster queue name.

       hhoossttnnaammee
              The hostname of a specific queue instance.

       rreeppoorrtt__ttiimmee
              The time (GMT unix time stamp) when a  state  change  was  trig-
              gered.

       ssttaattee  The new queue state.

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

   hhoosstt
       A  host  record  contains information about hosts and host load values.
       It contains the following information:

       hhoossttnnaammee
              The name of the host.

       rreeppoorrtt__ttiimmee
              The time (GMT unix time stamp) when the reported information was
              generated.

       ssttaattee  The new host state.  Currently, Grid Engine doesn't track a host
              state, the field is reserved for future use. Always contains the
              value X.

       llooaadd vvaalluueess
              Description of load values. Information about multiple load val-
              ues is separated by space.  A load  value  description  has  the
              format <name>=<actual_value>.

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

       hhoossttnnaammee
              The name of the host.

       rreeppoorrtt__ttiimmee
              The time (GMT unix time stamp) when the reported information was
              generated.

       ssttaattee  The new host state.  Currently, Grid Engine doesn't track a host
              state, the field is reserved for future use. Always contains the
              value X.

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

   sshhaarreelloogg
       The Grid Engine qmaster can dump information about sharetree configura-
       tion  and  use  to  the reporting file.  The parameter _s_h_a_r_e_l_o_g 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

       ccuurrrreenntt ttiimmee
              The present time

       uussaaggee ttiimmee
              The  time used so far

       nnooddee nnaammee
              The node name

       uusseerr nnaammee
              The user name

       pprroojjeecctt nnaammee
              The project name

       sshhaarreess The total shares

       jjoobb ccoouunntt
              The job  count

       lleevveell  The percentage of shares used

       ttoottaall  The adjusted percentage of shares used

       lloonngg ttaarrggeett sshhaarree
              The long target percentage of resource shares used

       sshhoorrtt ttaarrggeett sshhaarree
              The short target percentage of resource shares used

       aaccttuuaall sshhaarree
              The actual percentage of resource shares used

       uussaaggee  The combined shares used

       ccppuu    The cpu used

       mmeemm    The memory used

       iioo     The IO used

       lloonngg ttaarrggeett ccppuu
              The long target cpu used

       lloonngg ttaarrggeett mmeemm
              The long target memory used

       lloonngg ttaarrggeett iioo
              The long target IO used

SSEEEE AALLSSOO
       _s_g_e___c_o_n_f(5).  _h_o_s_t___c_o_n_f(5).

CCOOPPYYRRIIGGHHTT
       See _s_g_e___i_n_t_r_o(1) for a full statement of rights and permissions.



GE 6.0                   $Date: 2007/06/05 16:53:48 $             REPORTING(5)
