4.1.2 Modifying the retention conditions for performance data (in Store 2.0)
Store 2.0 allows you to modify the retention period for performance data in the retention conditions for performance data recorded in the database.
The following table describes the available retention conditions applicable to each record type.
Retention condition |
|
---|---|
PI record type |
Retention period of records |
PD record type |
|
PL record type |
- Organization of this subsection
(1) Modifying the retention conditions for performance data from the monitoring console
To modify the retention conditions for performance data from the monitoring console, use the Services window in PFM - Web Console.
-
From the monitoring console Web browser, log on to PFM - Web Console.
Log on to a user account that has administrator user permissions. You must have administrator user permissions to use the Services window.
-
In the navigation frame of the main window, select the Services tab.
-
In the navigation frame of the Services window, expand the hierarchy under the Machines folder.
The hierarchy displays folders with the same names as the hosts where Performance Management services are installed. When you expand one of these folders, the services installed on that host are displayed. The name of each service is represented by a service ID. The service ID format differs depending on whether the product name display function is enabled. For details on the product name display function, see the chapter that describes the Performance Management functions in the Job Management Partner 1/Performance Management Planning and Configuration Guide.
-
Expand the hierarchy under the folder that has the same name as the host whose retention conditions you want to change, and select an Agent Store or Remote Monitor Store service.
If the product name display function is enabled, the Agent Store or Remote Monitor Store service is indicated by host-name<service-key>(Store).
If the product name display function is not enabled, select an Agent Store or Remote Monitor Store service with an ID that does not begin with a P and has an S as the second character. (Service IDs that begin with PS refer to a Master Store service.)
For details on service IDs, see the description of the service naming rules in an appendix of the Job Management Partner 1/Performance Management Planning and Configuration Guide and the list of identifiers described in the appropriate PFM - Agent or PFM - RM manual.
The selected Agent Store or Remote Monitor Store service is marked with a checkmark.
-
In the method frame, select the Properties method.
-
In the Properties window of the Agent Store or Remote Monitor Store service, select the RetentionEx node from the tree.
At the bottom of the information frame, the properties of the RetentionEx node are displayed.
You can modify the property settings. The following table gives a description of each property and lists the available settings.
Table 4‒8: Description and settings for each property Record type
Node name
Property name
Settings
PI record type
Product Interval - record-ID-of-PI-record-type
The retention period for performance data collected on a per-minute basis for each record ID of PI-type records.
Specify the retention period (in days) as an integer in the range from 0 to 366.
The retention period for performance data collected on an hourly basis for each record ID of PI-type records.
Specify the retention period (in days) as an integer in the range from 0 to 366.
The retention period for performance data collected on a daily basis for each record ID of PI-type records.
Specify the retention period (in weeks) as an integer in the range from 0 to 522.
The retention period for performance data collected on a weekly basis for each record ID of PI-type records.
Specify the retention period (in weeks) as an integer in the range from 0 to 522.
The retention period for performance data collected on a monthly basis for each record ID of PI-type records.
Specify the retention period (in months) as an integer in the range from 0 to 120.
The retention period for performance data collected on a yearly basis for each record ID of PI-type records.
No retention period applies to data collected on a yearly basis.
PD record type
Product Detail - record-ID-of-PD-record-type
The retention period for performance data for each record ID of PD-type records.
Specify the retention period (in days) as an integer in the range from 0 to 366.
PL record type
Product Log - record-ID-of-PL-record-type
Period (Day)
The retention period for performance data for each record ID of PL-type records.
Specify the retention period (in days) as an integer in the range from 0 to 366.
-
Click Finish or Apply.
The new settings take effect.
(2) Modifying the retention conditions for performance data by using commands
To modify the retention conditions for performance data by using commands, follow these general procedures:
-
Use the jpcaspsv output command to output the current definitions of the retention conditions to an XML file.
-
Based on the resulting XML file, modify the definitions of the retention conditions.
-
Use the jpcaspsv update command to update the definitions of the retention conditions from the modified XML file.
Each procedure is described below.
(a) Using the jpcaspsv output command to output the definition of the retention conditions
On a host where PFM - Web Console is installed, execute the jpcaspsv output command. The jpcaspsv output command connects to the agent to obtain the definition information for retention conditions in the Store database and outputs this information to an XML file.
-
Log on to the host where PFM - Web Console is installed.
Log on as a user with the following permissions:
-
In Windows:
Administrator permissions
-
In UNIX:
root user permissions
-
-
Execute the jpcaspsv output command.
For example, when you want to output the definition information of the retention conditions for the Store database of PFM - Agent with the service ID of TS1host1 to the parameter file named aspsv.xml, use the following command:
jpcaspsv output -o aspsv.xml TS1host1
When the command is executed, the definition information of the retention conditions is output to the specified XML file.
An example of this output is shown below.
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "aspsv_params.dtd"> <pr-cli-parameters ver="0110"> <agent-store-db-preserve-definition> <service id="TS1host1"> <ex-product-interval> <ex-interval-record id="PI"> <minute-drawer-days period="10"/> <hour-drawer-days period="10"/> <day-drawer-weeks period="10"/> <week-drawer-weeks period="10"/> <month-drawer-months period="10"/> <!-- year-drawer-years period="10" --> </ex-interval-record> : </ex-product-interval> <ex-product-detail> <ex-detail-record id="PD" period="10"/> <ex-detail-record id="PD_THRD" period="10"/> <ex-detail-record id="PD_ADRS" period="10"/> <ex-detail-record id="PD_PDI" period="10"/> <ex-detail-record id="PD_PEND" period="10"/> </ex-product-detail> <ex-product-log> <ex-log-record id="PL" period="10"/> <ex-log-record id="RM" period="10"/> </ex-product-log> </service> </agent-store-db-preserve-definition> </pr-cli-parameters>
(b) Modify the definitions output by the jpcaspsv output command
Modify the definitions of the recording options in the XML file generated by the jpcaspsv output command. You can use any text editor or XML editor to edit the XML file.
The file format and the settings for each tag are described below. Edit the file as required.
-
Format:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "aspsv_params.dtd"> <pr-cli-parameters ver="0110"> <agent-store-db-preserve-definition> <service id="service-ID"> <ex-product-interval> <ex-interval-record id="record-ID"> <minute-drawer-days period="retention-period-for-per-minute-data"/> <hour-drawer-days period="retention-period-for-hourly-data"/> <day-drawer-weeks period="retention-period-for-daily-data"/> <week-drawer-weeks period="retention-period-for-weekly-data"/> <month-drawer-months period="retention-period-for-monthly-data"/> <!-- year-drawer-years period="10" --># </ex-interval-record> </ex-product-interval> <ex-product-detail> <ex-detail-record id="record-ID" period="record-retention-period"/> : : </ex-product-detail> <ex-product-log> <ex-log-record id="record-ID" period="record-retention-period"/> : </ex-product-log> </service> </agent-store-db-preserve-definition> </pr-cli-parameters>
# You cannot set a retention period for yearly records.
-
Definitions:
The XML declaration goes on the first line, and the document type declarations go on the second and third lines. You must write them exactly as shown below:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE pr-cli-parameters SYSTEM "aspsv_params.dtd"> <pr-cli-parameters ver="0110">
The following table describes the tags defined on the forth line and below. These tags must be defined in the order listed in the table.
- Legend:
-
Yes: Required and cannot be omitted.
No: Not required and can be omitted.
Tag name |
Required |
Description and settings |
---|---|---|
<agent-store-db-preserve-definition> ...</agent-store-db-preserve-definition> |
Yes |
The root tag of the definition information of the retention conditions for the Store database. |
<service id="service-ID"> ... </service> |
Yes |
Specifies the service ID that identifies PFM - Agent or PFM - RM. Specify a service with an ID that does not begin with a P but has an S as the second character. (Service IDs that begin with PS refer to a Master Store service.) For details on service IDs, see the description of the service naming rules in an appendix of the Job Management Partner 1/Performance Management Planning and Configuration Guide. A <service> tag contains <ex-product-interval>, <ex-product-detail>, and <ex-product-log> tags. More than one <service> tag can be specified. |
<ex-product-interval> ...</ex-product-interval> |
No |
Specifies the retention period of PI-type records. It contains <minute-drawer-days period=retention-period-for-per-minute-data>, <hour-drawer-days period=retention-period-for-hourly-data>, <day-drawer-weeks period=retention-period-for-daily-data>, <week-drawer-weeks period=retention-period-for-weekly-data>, and <month-drawer-months period=retention-period-for-monthly-data> tags. For further details, see Table 4-10 Retention periods for PI-type records (<ex-product-interval> tag). You can specify more than one <ex-product-interval> tag in a <service> tag. |
<ex-product-detail> ...</ex-product-detail> |
No |
Specifies the maximum number of stored records for the PD record type. It contains <ex-detail-record> tags. Only one <ex-product-detail> tag can be used in a <service> tag. For further details, see Table 4-11 Retention periods for PD-type records (<ex-product-detail> tag). |
<ex-product-log> ...</ex-product-log> |
No |
Specifies the maximum number of stored records for the PL record type. It contains <ex-log-record> tags. For further details, see Table 4-12 Retention periods for PL-type records (<ex-product-log> tag). Only one <ex-product-log> tag can be used in a <service> tag. |
Note that the values for any omitted items are not updated.
The following table describes the tags contained in an <ex-product-interval> tag (for the retention period of PI-type records) and their settings. Tags contained in an <ex-product-interval> tag must be defined in the order listed in the table.
Tag name |
Required |
Description and settings |
---|---|---|
<minute-drawer-days period="retention-period-for-per-minute-data"> |
No |
Sets the retention period for performance data collected on a per-minute basis. Specify the retention period (in days) as an integer in the range from 0 to 366. |
<hour-drawer-days period="retention-period-for-hourly-data"> |
No |
Sets the retention period for performance data collected on an hourly basis. Specify the retention period (in days) as an integer in the range from 0 to 366. |
<day-drawer-weeks period="retention-period-for-daily-data"> |
No |
Sets the retention period for performance data collected on a daily basis. Specify the retention period (in weeks) as an integer in the range from 0 to 522. |
<week-drawer-weeks period="retention-period-for-weekly-data"> |
No |
Sets the retention period for performance data collected on a weekly basis. Specify the retention period (in weeks) as an integer in the range from 0 to 522. |
<month-drawer-months period="retention-period-for-monthly-data"> |
No |
Sets the retention period for performance data collected on a monthly basis. Specify the retention period (in months) as an integer in the range from 0 to 120. |
Note that the values for any omitted items are not updated.
The following table describes the tags contained in an <ex-product-detail> tag (for the retention period of PD-type records) and their settings.
Tag name |
Required |
Description and settings |
---|---|---|
<ex-detail-record id="record-ID" period="retention-period-for-specified-record"/> |
No |
Specifies the retention period for a specific PD-type record. Specify the retention period (in days) as an integer in the range from 0 to 366. Only one <ex-detail-record> tag can be specified for each PD record. |
Note that the values for any omitted items are not updated.
The following table describes the tags contained in an <ex-product-log> tag (for the retention period of PL-type records) and their settings.
Tag name |
Required |
Description and settings |
---|---|---|
<ex-log-record id="record-ID" period="retention-period-for-specified-record"/> |
No |
Specifies the retention period for a specific PL-type record. Specify the retention period (in days) as an integer in the range from 0 to 366. Only one <ex-log-record> tag can be specified for each PL record. |
Note that the values for any omitted items are not updated.
(c) Using the jpcaspsv update command to update the definitions of the retention conditions
On the host where PFM - Web Console is installed, execute the jpcaspsv update command. The jpcaspsv update command updates the definition information of the retention conditions for the Store database from the modified XML file.
-
Log on to the host where PFM - Web Console is installed.
Log on as a user with the following permissions:
-
In Windows:
Administrator permissions
-
In UNIX:
root user permissions
-
-
Execute the jpcaspsv update command.
For example, if you want to update the definition information with the retention conditions specified in the file aspsv.xml, use the following command:
jpcaspsv update aspsv.xml