#### USAGELOG

#### Synopsis

    HELP:   Generate a usage report
    TYPE:   OBJECT
    SYNTAX: USAGELOG[(FROM=num/OLDEST,TO=num/YOUNGEST,LOCAL,SHORT,JOBNAME)...]

#### Description

Through the object USAGELOG you can specify the start and end dates as well as other parameters for FLAM usage reporting. If no parameters are specified, the log stream name (only on mainframes) and the SYSLOG identifier (which is used for usage logging) are printed. If an end date is specified, then a summary about FLAM usage is generated.

#### Examples

     info get.usage; provide only the log stream name and/or SYSLOG identifier
     info get.usage(from=oldest to=youngest); summarize all usage reporting entries
     info get.usage(from=-0t0000/03/00.00:00:00); summarize the last quarter (3 month)
     info get.usage(from=NOW-YEAR/4 jobname); summarize the last quarter (3 month) per job name

You can also specify start and end date lists (arrays) to calculate usage summaries for these time intervals. For example, it can be useful to evaluate the FLAM usage on system peak hours.

#### Examples

     info get.usage[
                    (from=0t2017/01/01.09:00:00 to=from+1HOUR)
                    (from=0t2017/01/02.10:30:00 to=from+1HOUR)
                    (from=0t2017/01/03.09:23:00 to=from+1HOUR)
                    (from=0t2017/01/04.10:01:00 to=from+1HOUR)
                   ]    ; summarize the FLAM usage of these four peak hours

These reports are useful to determine CPU usage that can be offloaded to co-processors and accelerators. Additionally, it provides the amount of bytes processed by FLAM.

#### Arguments

- `NUMBER: FROM=num/OLDEST - Indicates the starting time of the first record to be processed [OLDEST]`
  - `OLDEST - From oldest entry`
- `NUMBER: TO=num/YOUNGEST - Indicates the ending time of the last record to be processed [no report]`
  - `YOUNGEST - To youngest entry`
- `SWITCH: LOCAL - Specifies the time is local time [GMT]`
- `SWITCH: SHORT - Print short report [FALSE]`
- `SWITCH: JOBNAME - Add job names to list [FALSE] (only relevant for z/OS)`