4.1.1 Modifying the recording options for performance data

(a) Using the jpcasrec output command to output the definitions of the recording options

On the host where PFM - Web Console is installed, execute the jpcasrec output command. The jpcasrec output command connects to the agent to obtain the definition information of the recording options for the Store database, and outputs this information to an XML file.

To output the definition of the recording options by using the jpcasrec 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 jpcmkkey command.

   Execute the command to create an authentication key file.

   jpcmkkey -user administrator

3. Execute the jpcasrec output command.

   For example, if you want to output to the parameter file named asrec.xml the definition information of the recording options for the Store database of PFM - Agent with the service ID of TA1host1, use the following command:

   jpcasrec output -o asrec.xml TA1host1

   When the command is executed, the definition information of the recording options 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 "asrec_params.dtd">
   <pr-cli-parameters ver="0110">
   <agent-store-db-record-definition>
   <service id="TA1host1">
   <record id="PD_DEV">
   <!-- Description : Devices Detail -->
   <log>Yes</log>
   <collection-interval>60</collection-interval>
   <collection-offset>0</collection-offset>
   <logif> </logif>
   </record>
   <record id="PD_GEND">
   <!-- Description : Generic Data Detail -->
   <log>No</log>
   <collection-interval>60</collection-interval>
   <collection-offset>0</collection-offset>
   <logif> </logif>
   </record>
       ...
       ...
       ...
   </service>
   </agent-store-db-record-definition>
   </pr-cli-parameters>

(b) Modify the definitions output by the jpcasrec output command

Modify the definitions of the recording options in the XML file generated by the jpcasrec 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.

• Format

  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE pr-cli-parameters SYSTEM "asrec_params.dtd">
  <pr-cli-parameters ver="0110">
  <agent-store-db-record-definition>
      <service id="service-ID">
          <record id="record-ID">
              <!-- Description : Content Index Detail -->
              <log>whether-to-record-in-the-database</log>
              <collection-interval>collection-interval</collection-interval>
              <collection-offset>offset-at-which-to-start-collection</collection-offset>
              <logif>
                <and>
                  <or>
                    <expression>field-condition-"value"</expression>
                    <expression>field-condition-"value"</expression>
                  </or>
                  <expression>field-condition-"value"</expression>
                    ...
                </and>
              </logif>
          </record>
            ...
      </service>
  </agent-store-db-record-definition>
  </pr-cli-parameters>

• 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 "asrec_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.

Table 4‒4: XML definitions

Tag name	Required	Description and settings
<agent-store-db-record-definition> ... </agent-store-db-record-definition>	Yes	The root tag of the definition information of the recording options for the Store database.
<service id="service-ID"> ... </service>	Yes	Specifies the service ID that identifies PFM - Agent or PFM - RM. The service ID of an Agent Collector or Remote Monitor Collector service has an A as the second character. For details on service IDs, see the description of the service naming rules in an appendix of the JP1/Performance Management Planning and Configuration Guide. A <service> tag contains <record> tags. More than one <service> tag can be specified.
<record id="record-ID"> ... </record>	Yes	Specifies the record ID for which you want to modify the recording options. A <record> tag contains <log>, <collection-interval>, <collection-offset>, and <logif> tags. For further details, see Table 4-5. More than one <record> tag can be specified.

The following table describes tags contained in a <record> tag (for recording options for a record) and their settings. More than one <record> tag can be specified. Tags contained in a <record> tag must be defined in the order listed in the table.

Table 4‒5: Recording options for a record (<record> tag)

Tag name	Required	Settings
<log> ... </log>	No	Specifies whether to record collected performance data in the Store database. One of the following values can be specified: Yes: Records No: Does not record Only one <log> tag can be used in a <record> tag.
<collection-interval> ... </collection-interval>	No	Specifies a numerical value from 0 to 2,147,483,647 for the collection interval of performance data. The time is in seconds. 0 means that performance data will not be collected. Only one <collection-interval> tag can be used in a <record> tag.
<collection-offset> ... </collection-offset>	No	Specifies a numerical value from 0 to 32,767 for the offset at which to start collecting performance data. The time is in seconds. 0 means that all performance data will be collected simultaneously. Only one <collection-offset> tag can be used in a <record> tag.
<logif> ... </logif>	No	Allows you to specify a conditional expression to use for recording performance data in the database. For further details, see Table 4-6. Only one <logif> tag can be used in a <record> tag.

Notes:

• Increasing the number of records for which performance data is collected might affect your disk space or system performance. When you set up records to be collected, make sure you only set those items that are necessary for monitoring, always considering your requirements for performance data collection, such as the required free disk space and the record collection interval. For details on the required disk space, see the description of system estimates in an appendix of each PFM - Agent or PFM - RM manual.

• For the Collection Interval for record collection, either use the default value or specify a value that is both 60 seconds or more and a factor of 3,600. When you have to specify a value that is greater than 3,600 seconds (one hour) for the Collection Interval, choose a number that is both a multiple of 3,600 and a factor of 86,400 (24 hours). Specifying a value less than the default value or 60 seconds might increase both the number of open files and the amount of memory use. That would prevent the Store database from functioning normally, causing the collected performance data to be lost without being saved.

  Valid values or default values vary with each record. For details on valid values, ranges of values, or default values, see the chapter explaining records in each PFM - Agent or PFM - RM manual.

• When you modify the value for the Collection Offset, which is the offset value at which to start collecting records, choose a number while keeping in mind the overall load of the data collection.

The following table describes tags contained in a <logif> tag (for conditional expressions for recording in the database), and their settings.

Table 4‒6: Conditional expression for recording in the database (<logif> tag)

Tag name	Required	Settings
<and> ... </and>	No	Used to combine two <expression> tags with AND operation when more than one <expression> tag (logical expressions) is used. The two <expression> tags to be combined with AND operation are enclosed in an <and> tag pair. Conditional expressions consist of binary operations that can be nested. More than one <and> tag can be used when more than one <expression> tag is used.
<or> ... </or>	No	Used to combine two <expression> tags with OR operation when more than one <expression> tag (logical expressions) is used. The two <expression> tags to be combined with OR operation are enclosed in an <and> tag pair. Conditional expressions consist of binary operations that can be nested. More than one <or> tag can be used when more than one <expression> tag is used.
<expression> ... </expression>	No	Specifies the condition for determining whether to record to the database. Use the following format: Specifies field condition "value" (without any intervening spaces) field: Specifies the field to be compared. For details on available fields, see the chapter explaining the records in each PFM - Agent or PFM - RM manual. condition: Use one of the operators shown below. Note that you must use &lt; for < and &gt; for > according to XML file conventions. = The value of the field is equal to the value. < The value of the field is less than the value. <= The value of the field is equal to or less than the value. > The value of the field is more than the value. >= The value of the field is equal to or more than the value. <> The value of the field is not equal to the value. value Specifies the criteria value to determine whether to record performance data. You can specify an integer, a decimal, or a character string of no more than 2,048 bytes. A valid value varies with the specified field.

(c) Using the jpcasrec update command to update the definitions of the recording options

On the host where PFM - Web Console is installed, execute the jpcasrec update command. The jpcasrec update command updates the definition information of the recording options for the Store database with the modified XML file.

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 jpcasrec update command.

   For example, when you want to update the definition of the recording options based on the contents of the file asrec.xml, use the following command:

   jpcasrec update asrec.xml