# Trackable RESources (TRES)

A TRES is a resource that can be tracked for usage or used to enforce limits against. A TRES is a combination of a Type and a Name. Types are predefined. Current TRES Types are:

- BB (burst buffers)
- CPU
- Energy
- GRES
- License
- Mem (Memory)
- Node

## slurm.conf settings

- AccountingStorageTRES

  Used to define which TRES are to be tracked on the system. By default CPU, Energy, Memory and Node are tracked. This will be the case whether specified or not. The following example:

      AccountingStorageTRES=gres/craynetwork,license/iop1,bb/cray

  will track cpu, energy, memory and nodes along with a GRES called craynetwork as well as a license called iop1. It will also track usage on a Cray burst buffer. Whenever these resources are used on the cluster they are recorded. TRES are automatically set up in the database on the start of the slurmctld.

  The TRES that require associated names are BB, GRES, and License. As seen in the above example, GRES and License are typically different on each system. The BB TRES is named the same as the burst buffer plugin being used. In the above example we are using the Cray burst buffer plugin.

- PriorityWeightTRES

  A comma separated list of TRES Types and weights that sets the degree that each TRES Type contributes to the job's priority.

      PriorityWeightTRES=CPU=1000,Mem=2000,GRES/gpu=3000

  Applicable only if PriorityType=priority/multifactor and if AccountingStorageTRES is configured with each TRES Type. The default values are 0.

- TRESBillingWeights

  For each partition this option is used to define the billing weights of each TRES type that will be used in calcuating the usage of a job.

  Billing weights are specified as a comma-separated list of TRES=Weight pairs.

  Any TRES Type is available for billing. Note that the memory is weighted per gigabyte.

  By default the billing of TRES is calculated as the sum of all TRES types multiplied by their corresponding billing weight. For example, when a job is allocated 1 CPU and 8 GB of memory on a partition configured with

      TRESBillingWeights="CPU=1.0,Mem=0.25,GRES/gpu=2.0"

  , the billable TRES will be:

      (1*1.0) + (8*0.25) + (0*2.0) = 3.0

  If PriorityFlags=MAX_TRES is configured, the billable TRES is calculated as the MAX of individual TRES' on a node (e.g. cpus, mem, gres) plus the sum of all global TRES' (e.g. licenses). Using the same example above, the billable TRES will be:

      MAX(1*1.0, 8*0.25) + (0*2.0) = 2.0

  If TRESBillingWeights is not defined then the job is billed against the total number of allocated CPUs.

  NOTE: TRESBillingWeights is only used when calcuating fairshare and doesn't affect job priority directly as it is currently not used for the size of the job. If you want TRES' to play a role in the job's priority then refer to the PriorityWeightTRES option.

  NOTE: As with PriorityWeightTRES only TRES definied in AccountingStorageTRES are available for TRESBillingWeights.

## sacct

sacct can be used to view the TRES of each job by adding "tres" to the --format option.

## sacctmgr

sacctmgr is used to view the various TRES available globally in the system. sacctmgr show tres will do this.

## sreport

Before 15.08, sreport would only report on CPU usage. It will now work on different TRES. Simply using the comma separated input option --tres= will have sreport generate reports available for the requested TRES types. More information about these reports can be found on the sreport manpage.

Last modified 8 September 2015