Start of change

COLLECTION_SERVICES_INFO view

The COLLECTION_SERVICES_INFO view returns the configuration properties for Collection Services.

The values returned for the columns in the view are closely related to the values returned by the Configure Perf Collection (CFGPFRCOL) CL command and the Retrieve Collection Services Attributes (QypsRtvColSrvAttributes) API.

Authorization: The caller must have *USE authority on the QSYS/QYPSCOLL service program or be authorized through the QPMCCFCN authorization list.

The following table describes the columns in the view. The system name is CS_INFO. The schema is QSYS2.

Table 1. COLLECTION_SERVICES_INFO view
Column Name System Column Name Data Type Description
ACTIVE_COLLECTION_LIBRARY CURCOL_LIB VARCHAR(10)
Nullable
The name of the library where the currently active management collection object is stored.

Contains the null value if there is no active collection.

ACTIVE_COLLECTION_NAME CURCOL VARCHAR(10)
Nullable
The name of the current management collection object.

Contains the null value if there is no active collection.

ACTIVE_COLLECTION_PROFILE CURCOL_PRF VARCHAR(10)
Nullable
The name of the collection profile being used by the active collection. The collection profile defines which categories of data to collect.
*CUSTOM
A profile where both the categories to collect and category interval times may be customized.
*ENHCPCPLN
Enhanced Capacity Planning. Same as *STANDARDP plus the PEX Data - Processor Efficiency category.
*MINIMUM
The minimum set of categories required to support basic performance reporting functions.
*STANDARD
All categories that are typically used for performance reporting except for communications protocol related data.
*STANDARDP
Same as *STANDARD but communications protocol categories are included.

Contains the null value if there is no active collection.

ACTIVE_COLLECTION_START_TIME START_TIME TIMESTAMP
Nullable
The UTC timestamp when the current (active) collection was started.

Contains the null value if there is no active collection.

COLLECTION_LIBRARY LIB VARCHAR(10) The name of the library where performance data is stored.
COLLECTION_PROFILE DFTCOLPRF VARCHAR(10) The name of the configured collection profile. The collection profile defines which categories of data to collect.
*CUSTOM
A profile where both the categories to collect and category interval times may be customized.
*ENHCPCPLN
Enhanced Capacity Planning. Same as *STANDARDP plus the PEX Data - Processor Efficiency category.
*MINIMUM
The minimum set of categories required to support basic performance reporting functions.
*STANDARD
All categories that are typically used for performance reporting except for communications protocol related data.
*STANDARDP
Same as *STANDARD but communications protocol categories are included.
DEFAULT_COLLECTION_INTERVAL INTERVAL INTEGER
Nullable
The default interval, in seconds, used when collecting data for a category.

Values are: 15, 30, 60, 300, 900, 1800, or 3600 seconds.

Contains the null value if not collecting on an interval.

MGTCOL_RETENTION_PERIOD RETPERIOD INTEGER
Nullable
The management collection (*MGTCOL) object retention period., in hours. *MGTCOL objects in the configured collection library that are older than the retention period are automatically deleted when Collection Services is started or cycled.

Contains the null value for permanent retention.

CYCLE_TIME CYCTIME INTEGER The number of minutes past midnight when the first cycle is to occur. The maximum value is 1439 minutes (which is one minute less than 24 hours).
CYCLE_INTERVAL CYCITV INTEGER The number of hours between cycles. The cycle time can range from a minimum value of one hour to a maximum value of 24 hours.
CREATE_STANDARD_DB_FILES CRTDBF VARCHAR(3) Whether the standard database file collection is created by Collection Services while performance data is being collected.
NO
Collection Services will not create the standard database file collection.
YES
Collection Services will create the standard database file collection. A batch job named CRTPFRDTA is submitted to process the data in the current management collection object as it is collected. The collection name (begins with a "Q") is the same as the name of the *MGTCOL the data was exported from.
RETENTION_DAYS STDDTARET INTEGER
Nullable
This retention period, in days, used to determine how long standard database file collections should be retained on the system. When Collection Services is started or cycled, the Collection Services server job (QYPSPFRCOL) will automatically delete standard database file collections in the configured collection library that are older than the current retention period.

Contains the null value for permanent retention.

CREATE_SUMMARY_DB_FILES CRTPFRSUM VARCHAR(3) Whether additional logical files are created as supported by the CRTPFRSUM command.
NO
Summary file data is not generated.
YES
Summary file data is generated.
CREATE_SYSTEM_MONITOR_
DB_FILES
CRTSYSMON VARCHAR(3) Whether additional system monitor database files should be created by Collection Services while performance data is being collected.
NO
Collection Services will not create the system monitor database files for the standard database file collection.
YES
Collection Services will create the system monitor database files for the standard database file collection. The batch job named CRTPFRDTA will populate the system monitor database files using the data in the current management collection object as it is collected.
ENABLE_SYSTEM_MONITORING ENBSYSMON VARCHAR(3) Whether Collection Services is configured to collect and produce data for system monitors.
NO
System monitor support is not enabled.
YES
System monitor support is enabled. Collection Services will collect certain data categories more frequently than the configured default collection interval. A batch job named CRTPFRDTA2 is submitted to produce a system monitor database file collection with the same name as the management collection object except it begins with an 'R'.
SYSTEM_MONITOR_ DB_FILE_RETENTION
SYSMONRET INTEGER
Nullable
This retention period, in days, used to determine how long system monitor database file collections should be retained on the system. When Collection Services is started or cycled, the Collection Services server job (QYPSPFRCOL) will automatically delete system monitor database file collections in the configured collection library that are older than the retention period.

Contains the null value for permanent retention.

CATEGORY_LIST_COUNT CGY_COUNT INTEGER The number of entries in CATEGORY_LIST.
CATEGORY_LIST SYSMONCGY VARCHAR(2000)
CCSID 1208
Nullable
A list of collection categories that are included in the system monitor collection. Each category can have an independent collection interval. This list is returned as an array within a JSON object.
Each entry in the JSON array contains two JSON objects:
  • An object with a name of "category" and a value of the category name
  • An object with a name of "interval" and a value of the category's collection interval, in seconds

Contains the null value if CATEGORY_LIST_COUNT is 0.

EXCLUDED_LINE_COUNT EXC_COUNT INTEGER The number of entries in EXCLUDED_LINE_LIST.
EXCLUDED_LINE_LIST EXC_LIST VARCHAR(598)
Nullable
A list of communication line names that are excluded from the calculation of communication line protocol metrics. Each entry is ten characters long with a comma and space separating entries.

Contains the null value if EXCLUDED_LINE_COUNT is 0.

CREATE_HISTORICAL_DATA CRTPFRHST VARCHAR(3) Whether historical data will be created when Collection Services is cycled.
NO
Collection Services will not create historical data.
YES
Collection Services will create historical data by processing management collection objects that exist in the configured collection library. A batch job named QYPSPFRHST is submitted by Collection Services at cycle time.
HISTORICAL_DATA_INTERVAL HSTITV INTEGER The time interval, in seconds, used to create historical data.
HISTORICAL_SUMMARY_DATA_
RETENTION
HSTSUMRET INTEGER The historical summary data retention period, in months, that determines how long Collection Services historical summary data is to exist. Historical summary data is stored in files beginning with QAPMHMxxxx. Historical summary data older than the retention period is deleted.
CREATE_HISTORICAL_DETAILED_
DATA
CRTHSTDTL VARCHAR(3) Whether historical detailed data will be created when Collection Services is cycled. Creating historical detailed data will allow detailed data for the top contributors of various metrics to be stored in the historical collection to be used as drill-down data. The number of top contributors is determined by the value of the historical detailed data filter.
NO
Collection Services will not create historical detailed data.
YES
Collection Services will create historical detailed data when processing management collection objects that exist in the configured collection library. A batch job named QYPSPFRHST is submitted by Collection Services at cycle time.
HISTORICAL_DETAILED_DATA_
RETENTION
HSTDTLRET INTEGER The historical detailed data retention period, in days, that determines how long Collection Services historical detailed data is to exist. Historical detailed data is stored in files beginning with QAPMHDxxxx. Historical detailed data older than the retention period is deleted.
HISTORICAL_DETAILED_DATA_
FILTER
HSTFILTER INTEGER
Nullable
The number of top contributors for each metric to be stored in the historical data collection to be used as detailed drill-down data.

Contains the null value if all detailed data is kept.

Example

  • Return the Collection Services configuration properties.
    SELECT * FROM QSYS2.COLLECTION_SERVICES_INFO;
End of change