--- name: "sge_reporting" section: "5" platform: "linux" package: "gridengine-common" version: "8.1.9+dfsg-13.1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/sge_reporting" --- # sge\_reporting(5) Grid Engine reporting file format ## NAME reporting - Grid Engine reporting file format ## DESCRIPTION A Grid Engine system writes a reporting file *$SGE\_ROOT/$SGE\_CELL/common/reporting* if **reporting=true** is specified in the [*sge\_conf*(5)](/sge_conf/5.md) **reporting\_params**. This occurs intervals of the **flush\_time** specified in the same place. 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 and events are dumped to the reporting file in a configurable interval. It allows "real time" monitoring of the cluster status as well as historical analysis. ## FORMAT 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: - **time** The time when the record was created. All time values described here are the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC). - **record type** Type of the accounting record. The different types of records and their structure are described below, eliding the leading **time** and **record type** fields in each case. ### new\_job The new\_job record is written whenever a new job enters the system (usually by a submission command). It has the following fields: - **submission\_time** Time when the job was submitted. - **job\_number** The job number. - **task\_number** The array task id. Always has the value -1 for new\_job records (as array tasks haven't been created at that stage). - **pe\_taskid** The task id of parallel tasks. Always has the value "none" for new\_job records. - **job\_name** The job name (from **-N** submission option). - **owner** The job owner. - **group** The Unix group of the job owner. - **project** The project the job is running in. - **department** The department the job owner is in. - **account** The account string specified for the job (from the **-A** submission option). - **priority** The job priority (from the **-p** submission option). ### job\_log If **joblog=true** is specified in the [*sge\_conf*(5)](/sge_conf/5.md) **reporting\_params**, a job\_log record is written whenever a job, an array task or a PE task changes status. A status change can be the transition from pending to running, but can also be triggered by user actions, like suspension of a job. It has the following fields: - **event\_time** Time when the event was generated. - **event** A one word description of the event. - **job\_number** The job number. - **task\_number** The PE task id. Always has the value -1 for new\_job records (as parallel tasks haven't been created at that stage). - **pe\_taskid** The task id of parallel tasks. Always has the value "none" for new\_job records. - **state** The state of the job after the event was processed. - **user** The user who initiated the event (or special usernames "qmaster", "scheduler" and "execd" for actions of the system itself like scheduling jobs, executing jobs etc.). - **host** The host from which the action was initiated (e.g. the submit host, the qmaster host, etc.). - **state\_time** Reserved field for later use. - **submission\_time** Time when the job was submitted. - **job\_name** The job name (from the **-N** submission option). - **owner** The job owner. - **group** The Unix group of the job owner. - **project** The project the job is running in. - **department** The department the job owner is in. - **account** The account string specified for the job (from the **-A** submission option). - **priority** The job priority (from the **-p** submission option). - **message** A message describing the reported action. ### acct Records of type acct are accounting records. Normally, they are written whenever a job, a task of an array job, or a task of a parallel job terminates. However, for long running jobs an intermediate acct record is created once a day after midnight. This results in multiple accounting records for a particular job and allows for fine-grained resource usage monitoring over time. Accounting records have the structure described in *accounting*(5), with the addition of leading time and type fields (which are not used in the accounting file). ### queue Records of type queue contain state information for queues (queue instances). A queue record has the following fields: - **qname** The cluster queue name. - **hostname** The hostname of a specific queue instance. - **report\_time** The time when a state change was triggered. - **state** The new queue state. The possible states are single-letter values, as reported by [*qhost*(1)](/qhost/1.md) with the **-q** option. ### queue\_consumable A queue\_consumable record contains information about queue consumable values in addition to queue state information: - **qname** The cluster queue name. - **hostname** The hostname of a specific queue instance. - **report\_time** The time when a state change was triggered. - **state** The new queue state. - **consumables** Description of consumable values. Information about multiple consumables is separated by space. A consumable description has the format *name*=*actual\_value*=*configured\_value*. Consumables are only logged if **log\_consumables=true** is specified in the [*sge\_conf*(5)](/sge_conf/5.md) **reporting\_params**, or the consumable is specified in the local or global *host\_conf*(5) **report\_variables**. ### host A host record contains information about hosts and host load values. It contains the following information: - **hostname** The name of the host. - **report\_time** The time when the reported information was generated. - **state** 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. - **load values** Description of load values. Information about multiple load values is separated by space. A load value description has the format *name*=*actual\_value*. ### host\_consumable A host\_consumable record contains information about hosts and host consumables. Host consumables can, for example, be licenses. It contains the following information: - **hostname** The name of the host. - **report\_time** The time when the reported information was generated. - **state** 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. - **consumables** Description of consumable values. Information about multiple consumables is separated by space. A consumable description has the format *name*=*actual\_value*=*configured\_value*. Consumables are only logged if **log\_consumables=true** is specified in the [*sge\_conf*(5)](/sge_conf/5.md) **reporting\_params**, or the consumable is specified in the local or global *host\_conf*(5) **report\_variables**. ### sharelog The Grid Engine qmaster can dump information about sharetree configuration and use to the reporting file. The [*sge\_conf*(5)](/sge_conf/5.md) **reporting\_params** can specify **sharelog**, which 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 - **current time** The present time - **usage time** The time used so far - **node name** The node name - **user name** The user name - **project name** The project name - **shares** The total shares - **job count** The job count - **level** The percentage of shares used - **total** The adjusted percentage of shares used - **long target share** The long target percentage of resource shares used - **short target share** The short target percentage of resource shares used - **actual share** The actual percentage of resource shares used - **usage** The combined shares used - **cpu** The number of CPU seconds used - **mem** The time integral of memory used (in GB seconds) - **io** The IO done (in GB) - **long target cpu** The long target cpu used - **long target mem** The long target memory used - **long target io** The long target IO used ### new\_ar A new\_ar record contains information about advance reservation objects. Entries of this type will be added if an advance reservation is created. It contains the following information: - **submission\_time** The time when the advance reservation was created. - **ar\_number** The advance reservation number identifying the reservation. - **ar\_owner** The owner of the advance reservation. ### ar\_attribute 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 the following fields. - **event\_time** The time when the event was generated. - **submission\_time** The time when the advance reservation was created. - **ar\_number** The advance reservation number identifying the reservation. - **ar\_name** Name of the advance reservation. - **ar\_account** An account string which was specified during the creation of the advance reservation. - **ar\_start\_time** Start time. - **ar\_end\_time** End time. - **ar\_granted\_pe** The parallel environment which was selected for an advance reservation. - **ar\_granted\_resources** The granted resources which were selected for an advance reservation. ### ar\_log The ar\_log record is written whenever an advance reservation changes status. A status change can be from pending to active, but can also be triggered by system events like host outage. It has the following fields. - **ar\_state\_change\_time** The time when the event occurred which caused a state change. - **submission\_time** The time when the advance reservation was created. - **ar\_number** The advance reservation number identifying the reservation. - **ar\_state** The new state. - **ar\_event** An event id identifying the event which caused the state change. - **ar\_message** A message describing the event which caused the state change. ### ar\_acct The ar\_acct records are accounting records which are written for every queue instance whenever an advance reservation terminates. Advance reservation accounting records comprise following fields. - **ar\_termination\_time** The time when the advance reservation terminated. - **submission\_time** The time when the advance reservation was created. - **ar\_number** The advance reservation number identifying the reservation. - **ar\_qname** Cluster queue name which the advance reservation reserved. - **ar\_hostname** The name of the execution host. - **ar\_slots** The number of slots which were reserved. ## FILES *$SGE\_ROOT/$SGE\_CELL/common/reporting* ## SEE ALSO *accounting*(5), [*sge\_conf*(5)](/sge_conf/5.md), *host\_conf*(5). ## COPYRIGHT See [*sge\_intro*(1)](/sge_intro/1.md) for a full statement of rights and permissions.