Skip to main content

Report

Report

The report function gathers and outputs a report of metrics.

Format:

status = $$Report^PERFMON(report,sort,format,output,[list],[data])

Parameters:

  • report — type of report to output; valid values are:

    • G – for global activity

    • R – for routine activity

    • N – for network activity

    • C – for a custom report where you select the metrics to report

  • sort — grouping and sort order of report; valid values are:

    • P – to organize the report by Process

    • R – to organize the report by Routine

    • G – to organize the report by Global

    • D – to organize the report by Database

    • I – to organize the report by Incoming node

    • O – to organize the report by Outgoing node

  • format — output format; valid values are:

    • P – for a printable/viewable report (.txt file, no pagination)

    • D – for comma delimited data (.csv file) which can be read into a spreadsheet

    • X – for Microsoft Excel XML markup suitable for import into Excel (.xml file)

    • H – for an HTML page (.html file)

  • output — enter a file name, Return to accept the default file name displayed, or 0 (zero) for output to the screen

  • list — (for Custom report only) comma-separated list of metric numbers which specify what columns to include in the report; input ? after specifying a custom report for a list of all possible metrics and their numbers.

    The global, routine, and network activity reports (indicated by the report parameter) display a predefined subset of this list.

  • data — type of data to report; valid values are:

    • 1 – for standard rates/second

    • 2 – for raw totals

Status Codes:

Status code Description
1 Successful
-1 Monitor is not running
-2 Missing input parameter
-3 Invalid report category
-4 Invalid report organization
-5 Invalid report format
-6 Invalid list for custom report
-7 Invalid data format

The Report Examples section shows how to enter different values for the input parameters.

FeedbackOpens in a new tab