Job Management Partner 1/Performance Management User's Guide

[Contents][Glossary][Index][Back][Next]

4.1.3 Modifying the retention conditions for performance data (in Store 1.0)

In the retention conditions for performance data recorded in the database, you can modify the retention period of data or the maximum number of records. The kind of retention condition allowed for performance data depends on the type of record.

The following table describes the available retention conditions applicable to each record type.

Table 4-13 Available retention conditions for each record type

Record type Available retention condition
PI record type Retention period of data
PD record type Maximum number of records
PL record type

You can modify the retention conditions for performance data in one of two ways:

Each of these is described below.

Organization of this subsection
(1) Modifying the retention conditions for performance data by using the monitoring console
(2) Modifying the retention condition for performance data by using commands

(1) Modifying the retention conditions for performance data by using the monitoring console

To modify the retention conditions for performance data by using the monitoring console, use the Services window in PFM - Web Console.

To modify the retention condition for performance data by using the monitoring console:

  1. Log on to PFM - Web Console from the browser of the monitoring console.
    You need to log on as a user with Administrator user permissions. You must have administrator user permissions to use the Services window.
    The main window of PFM - Web Console appears.

  2. In the navigation frame of the main window, select the Services tab.
    The Services window appears.

  3. 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.

  4. Expand the hierarchy under the folder with the name of the host for which you want to modify the retention conditions, and select an Agent Store service.
    If the product name display function is enabled, the Agent Store service is indicated by host-name<service-key>(Store).
    If the product name display function is not enabled, select an Agent 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 manual.
    The selected Agent Store service is marked with a checkmark.

  5. In the method frame, select Properties.
    The Properties window of the Agent Store service is displayed with the properties shown hierarchically.

  6. Select the Retention node.
    At the bottom of the information frame, the properties of the Retention node are displayed.

    Figure 4-4 Example settings for retention conditions

    [Figure]

    You can modify the property settings. The following table lists descriptions and settings for each property.

    Table 4-14 Description and settings for each property

    Record type Property name Settings
    PI record type Product Interval - Minute Drawer Specifies a retention period (in minutes) for the stored performance data.
    You can select one of the following items in the pull-down menu:
    • Minute
    • Hour
    • Day
    • 2 Days
    • 3 Days
    • 4 Days
    • 5 Days
    • 6 Days
    • Week
    • Month
    • Year
    Product Interval - Hour Drawer Specifies a retention period (in hours) for the stored performance data.
    You can select one of the following items in the pull-down menu:
    • Hour
    • Day
    • 2 Days
    • 3 Days
    • 4 Days
    • 5 Days
    • 6 Days
    • Week
    • Month
    • Year
    Product Interval - Day Drawer Specifies a retention period (in days) for the stored performance data.
    You can select one of the following items in the pull-down menu:
    • Day
    • 2 Days
    • 3 Days
    • 4 Days
    • 5 Days
    • 6 Days
    • Week
    • Month
    • Year
    Product Interval - Week Drawer Specifies a retention period (in weeks) for the stored performance data.
    You can select one of the following items in the pull-down menu:
    • Week
    • Month
    • Year
    Product Interval - Month Drawer Specifies a retention period (in months) for the stored performance data.
    You can select one of the following items in the pull-down menu:
    • Month
    • Year
    Product Interval - Year Drawer The retention period, in years, for the stored performance data. The setting defaults to Year and cannot be modified.
    PD record type Product Detail - record-ID-of-PD-record-type Specifies the maximum number of stored records for each record ID of PD record type.

    For a single instance:
    You can specify a numerical value from 0 to 2,147,483,647 for the maximum number of stored records.

    For multiple instances:
    You can specify a numerical value from 0 to 2,147,483,647 for the maximum number of total stored record lines.
    PL record type Product Log - record-ID-of-PL-record-type Specifies the maximum number of stored records for each record ID of PL record type.

    For a single instance:
    You can specify a numerical value from 0 to 2,147,483,647 for the maximum number of stored records.

    For multiple instances:
    You can specify a numerical value from 0 to 2,147,483,647 for the maximum number of total stored record lines.

  7. Click the OK button.
    Your settings are enabled.

(2) Modifying the retention condition for performance data by using commands

To modify the retention conditions for performance data recorded in the database, follow these general procedures:

  1. Use the jpcaspsv output command to output the current definitions of the retention conditions to an XML file.
  2. Based on the resulting XML file, modify the definitions of the retention conditions.
  3. Use the jpcaspsv update command to update the definitions of the retention conditions with the modified XML file.

Each procedure is described below.

(a) Using the jpcaspsv output command to output the definition of the retention condition

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.

To output the definition of the retention condition by using the jpcaspsv output command:

  1. Log on to the host where PFM - Web Console is installed.
    You need to log on as a special user with special permissions, as shown below:
    • In Windows:
      Administrator permissions
    • In UNIX:
      root user permissions

  2. Execute the jpcaspsv output command.
    For example, when you want to output to the parameter file named aspsv.xml the definition information of the retention conditions for the Store database of PFM - Agent with the service ID of TS1host1, 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">
<product-interval>
<minute-drawer>Day</minute-drawer>
<hour-drawer>Week</hour-drawer>
<day-drawer>Year</day-drawer>
<week-drawer>Year</week-drawer>
<month-drawer>Year</month-drawer>
<!-- year-drawer : Year -->
</product-interval>
<product-detail>
<detail-record id="PD" max-rec="10000"/>
<detail-record id="PD_PDI" max-rec="100000"/>
<detail-record id="PD_PEND" max-rec="10000"/>
<detail-record id="PD_PAGF" max-rec="10000"/>
<detail-record id="PD_GEND" max-rec="10000"/>
<detail-record id="PD_SVC" max-rec="10000"/>
<detail-record id="PD_DEV" max-rec="10000"/>
<detail-record id="PD_ELOG" max-rec="10000"/>
</product-detail>
</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 if necessary.

 
<?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">
        <product-interval>
            <minute-drawer>retention-period-in-minutes</minute-drawer>
            <hour-drawer>retention-period-in-hours</hour-drawer>
            <day-drawer>retention-period-in-days</day-drawer>
            <week-drawer>retention-period-in-weeks</week-drawer>
            <month-drawer>retention-period-in- months</month-drawer>
            <!-- year-drawer : Year -->#
        </product-interval>
        <product-detail>
            <detail-record id="record-ID" max-rec="maximum-number-of-records"/>
            ...
            ...
        </product-detail>
        <product-log>
            <log-record id="record-ID" max-rec="maximum-number-of-records"/>
            ...
        </product-log>
    </service>
</agent-store-db-preserve-definition>
</pr-cli-parameters>
 
# The retention period in years defaults to Year and cannot be modified.

The XML declaration goes on the first line, and the document type declaration goes 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.

Table 4-15 XML definitions

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.
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 <product-interval>, <product-detail>, and <product-log> tags.
More than one <service> tag can be specified.
<product-interval> ... </product-interval> No The tag that specifies the retention period of records for the PI record type.
It contains <minute-drawer>, <hour-drawer>, <day-drawer>, <week-drawer>, and <month-drawer> tags. For further details, see Table 4-16 Retention period of the records for the PI record type (<product-interval> tag).
Only one <product-interval> tag can be used in a <service> tag.
<product-detail> ... </product-detail> No The tag that specifies the maximum number of stored records for the PD record type.
It contains <detail-record> tags.
Only one <product-detail> tag can be used in a <service> tag.
For further details, see Table 4-17 The Maximum number of stored records for the PD record type (<product-detail> tag).
<product-log> ... </product-log> No The tag that specifies the maximum number of stored records for the PL record type.
It contains <log-record> tags. For further details, see Table 4-18 The Maximum number of stored records for the PL record type (<product-log> tag).
Only one <product-log> tag can be used in a <service> tag.

Legend:
Yes: Must be defined
No: Can be omitted
Note that the values for the omitted items are not updated.

The following table describes tags contained in a <product-interval> tag (for the retention period of records for the PI record type) and their settings. Tags contained in a <product-interval> tag must be defined in the order listed in the table.

Table 4-16 Retention period of the records for the PI record type (<product-interval> tag)

Tag name Required Settings
<minute-drawer> ... </minute-drawer> No Specifies a retention period (in minutes) for the stored performance data.
One of the following values can be specified:
  • Minute: one minute
  • Hour: one hour
  • Day: one day
  • n Days: n days (n = 2-6)
  • Week: one week
  • Month: one month
  • Year: one year
Only one <minute-drawer> tag can be used in a <product-interval> tag.
<hour-drawer> ... </hour-drawer> No Specifies a retention period (in hours) for the stored performance data.
One of the following values can be specified:
  • Hour: one hour
  • Day: one day
  • n Days: n days (n = 2-6)
  • Week: one week
  • Month: one month
  • Year: one year
Only one <hour-drawer> tag can be used in a <product-interval> tag.
<day-drawer> ... </day-drawer> No Specifies a retention period (in days) for the stored performance data.
One of the following values can be specified:
  • Day: one day
  • n Days: n days (n = 2-6)
  • Week: one week
  • Month: one month
  • Year: one year
Only one <day-drawer> tag can be used in a <product-interval> tag.
<week-drawer> ... </week-drawer> No Specifies a retention period (in weeks) for the stored performance data.
One of the following values can be specified:
  • Week: one week
  • Month: one month
  • Year: one year
Only one <week-drawer> tag can be used in a <product-interval> tag.
<month-drawer> ... </month-drawer> No Specifies a retention period (in months) for the stored performance data.
One of the following values can be specified:
  • Month: one month
  • Year: one year
Only one <month-drawer> tag can be used in a <product-interval> tag.

Legend:
No: Can be omitted.
Note that the values for the omitted items are not updated.

The following table describes tags contained in a <product-detail> tag (for the maximum number of stored records for the PD record type) and their settings.

Table 4-17 The Maximum number of stored records for the PD record type (<product-detail> tag)

Tag name Required Settings
<detail-record id="record-ID" max-rec="maximum-number-of-records"/> No Specifies the maximum number of stored records for each record ID of PD record type.

For a single instance:
You can specify a numerical value from 0 to 2,147,483,647 for the maximum number of stored records.

For multiple instances:
You can specify a numerical value from 0 to 2,147,483,647 for the maximum number of total stored record lines.
Only one <detail-record> tag can be used for a PD record.

Legend:
No: Can be omitted
Note that the values for the omitted items are not updated.

The following table describes tags contained in a <product-log> tag (for the maximum number of stored records for the PL record type) and their settings.

Table 4-18 The Maximum number of stored records for the PL record type (<product-log> tag)

Tag name Required Settings
<log-record id="record-ID" max-rec="maximum- number-of-records"/> No Specifies the maximum number of stored records for each record ID of PL record type.

For a single instance:
You can specify a numerical value from 0 to 2,147,483,647 for the maximum number of stored records.

For multiple instances:
You can specify a numerical value from 0 to 2,147,483,647 for the maximum number of total stored record lines.
Only one <log-record> tag can be used for a PL record.

Legend:
No: Can be omitted
Note that the values for the 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 with the modified XML file.

To update the definitions of the retention conditions by using the jpcaspsv update command:

  1. Log on to the host where PFM - Web Console is installed.
    You need to log on as a special user with special permissions, as shown below:
    • In Windows:
      Administrator permissions
    • In UNIX:
      root user permissions

  2. Execute the jpcaspsv update command.
    For example, if you want to update the definition information with the retention conditions specified in the file named aspsv.xml, use the following command:
     
jpcaspsv update aspsv.xml

[Contents][Back][Next]

[Trademarks]

All Rights Reserved. Copyright (C) 2009, Hitachi, Ltd.