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.
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.
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.
|
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.
|
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.
|
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.
|
ENABLE_SYSTEM_MONITORING | ENBSYSMON | VARCHAR(3) | Whether Collection Services is configured to collect and produce
data for system monitors.
|
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:
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.
|
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.
|
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;