5.8.1 Overview of the functionality for collecting user-specific performance data

The following explains functionality for collecting user-specific performance data and functionality for periodically executing user commands.

Organization of this subsection
(1) Functionality for collecting user-specific performance data
(2) Functionality for periodically executing user commands
(3) Notes on functionality for periodically executing user commands

(1) Functionality for collecting user-specific performance data

This functionality uses the jpcuser command to convert custom performance data output by users to a text file, into a format that can be stored in records provided by PFM - Agent for Platform (PD_UPD, PD_UPDB, PI_UPI, and PI_UPIB). To use this functionality for collecting user-specific performance data, a command must be created to output performance data to text files ahead of time.

The following figure shows how user-specific performance data is collected.

Figure 5-2 Mechanism for collecting user-specific performance data

[Figure]

The following describes the processing corresponding to the numbers in the figure.

  1. User commands are executed to create user-defined data.
    The user commands collect performance data, such as process name, process ID, and number of processes, and output the collected data to a text file. The data in the text file is called user-created data.
    The user commands must be created as scripts beforehand.
  2. The jpcuser command is executed to convert the user-created data.
    The jpcuser command converts the user-created data into a file in a format that can be managed by PFM - Agent for Platform. The file resulting from the conversion is called a user data file.
  3. The contents of the user data file are saved in user-defined records every time PFM - Agent for Platform performs record collection.
    PFM - Web Console must be set beforehand so that PFM - Agent for Platform collects the records from the user data file.

To collect performance data periodically, use the functionality for periodically executing user commands to set a user command, and the jpcuser command, to execute automatically.

Note
When outputting a file specified for the jpcuser command argument, or file in a batch file or script that executes the jpcuser command, specify a folder other than the installation folder.
When the jpcuser command is executed directly from a user command in a Windows Server 2008 or Windows Server 2012 environment, the user command must be executed by a user with Administrators permissions.

(2) Functionality for periodically executing user commands

This functionality executes a user command from PFM - Agent for Platform at a fixed interval without using a task scheduler or other schedule functionality. The method for creating user data files from user commands is the same as described in (1) Functionality for collecting user-specific performance data.

Functionality for periodically executing user commands is executed using the same timing as record collection in PFM - Agent for Platform. After record collection processing is completed, a user data file is created by a user command, so that user data file collection processing and creation processing do not cause a race condition. Note that because functionality for periodically executing user commands is executed according to Collection Interval as set for the user record, it is executed for historical collection and alarm collection, but not for real-time collection. The following figure shows the flow of processing for functionality for periodically executing user commands.

Figure 5-3 Flow of processing for functionality for periodically executing user commands

[Figure]

Functionality for periodically executing user commands determines whether the previously started user command has terminated, and skips user command processing if it is executing.

Reference note
For versions of PFM - Web Console earlier than 09-00, functionality for periodically executing user commands cannot batch distribute properties to multiple PFM - Agent instances.

(3) Notes on functionality for periodically executing user commands

Executable files
The file formats that can be executed by functionality for periodically executing user commands are as follows:
  • EXE format: executable file
  • COM format: executable (command) file
  • BAT format: batch file
To execute internal commands such as DEL and DIR as jobs, create a batch file, and then execute the command within the batch file.
Accounts
Use the system account to execute functionality for periodically executing user commands. Make sure that the system account can access the following files and resources:
  • Files specified for functionality for periodically executing user commands (user commands)
  • Resources referenced or updated from those files (user commands)
Environment variables
The environment variables valid for executing functionality for periodically executing user commands are the system environment variables defined when the Performance Management program service starts up. Profile information is not loaded when functionality for periodically executing user commands is executed.
Current folder
The PFM - Agent for Platform service folder (installation-folder\jp1pc\agtt\agent) is used as the current folder for executing functionality for periodically executing user commands.
Other notes
  • Windows 16-bit applications cannot be executed.
  • When specifying a command in the Windows SysWOW64 system folder for functionality for periodically executing user commands, specify an absolute path.
  • Programs that display a window or dialog box cannot be executed. However, the net send command can be executed to display a dialog box, because it displays the Windows Messenger service instead of a dialog box.
  • Programs that use Windows messaging functionality (DDE) cannot be executed.
  • Programs that require interactivity cannot be executed.
  • Resident programs (programs that do not terminate) cannot be executed.
  • Programs with extensions linked to an application cannot be executed.
  • Programs in network folders cannot be executed.
  • Do not set up programs on removable disks or other disks that cannot be set up.
  • Do not set Windows service startup settings to allow interaction with the desktop.
  • The contents of the standard output and standard error output cannot be obtained for executed programs.
  • When performing file output from an executed program, use an absolute path to specify the output destination file. If an absolute path is not specified, the folder for the PFM - Agent for Platform service (installation-folder\jp1pc\agtt\agent) is used as the current folder.
  • If the path of the command to be executed contains a space, enclose the path in double quotation marks (").