Enabling Usage Monitor

Access the Usage Monitoring Options page to enable either the MO usage data collection or ADS usage data collection. After selecting the required option, ensure to restart the application server to activate your selection.

Navigation:

PeopleTools > Lifecycle Tools > Usage Monitoring > Usage Monitoring Options.

Field or Control	Description
Data Collection Method	Set the data collection method with: Anonymous- All usage by all users is collected and stored with the User ID value of ANONYMOUS. By UserId- All usage by all users is collected and stored with the UserID value of the user who accessed the object. Selecting By UserId option significantly increases the amount of data collected. For example, if you have ten users who use the same ten objects, then: The Anonymous option collects 1 anonymous user * 10 objects = 10 rows of data. The By UserId option collects 10 users * 10 objects = 100 rows of data. You can select an option based on your environment: Production environment: The Anonymous option should be used in all cases when collecting usage data in this environment. Test and Development environments: The Anonymous option should be used when collecting usage data in these environments for the following use cases: Collecting usage data for use with the LCM Insights feature. General usage data collection for custom applications. Using Usage Monitor for the first time or initial rollout to estimate the potential data volumes to be collected. The By UserId option should be used only when collecting usage data in the Test and Development environments for use cases that require this level of detail including the following: Collecting usage data in conjunction with the PeopleSoft Test Framework (PTF) tool. Usage data collection for custom applications that requires user level data.
Enable Managed Object Usage Monitoring
Enable Managed Object Usage Monitoring	Select to enable the Usage Monitor for managed objects accessed through application server, Process Scheduler server, and Application Engine server. The use cases for Managed Object usage collection include collecting usage data for use with the LCM Insights feature, collecting usage data in conjunction with the PeopleSoft Test Framework (PTF) tool, and general usage data collection for custom applications.
Managed Object Buffer Size	This is used to manage the frequency of database writes such that, increasing the buffer size will reduce the database writes performed by Usage Monitor. The Buffer Size value determines the performance of the system. The default Managed Object buffer size is 50000 and the minimum value is 2500. Each buffer row requires 700 bytes of memory, such that a Buffer size value of 200,000 will require 140 MB of available memory. Each server maintains it's own buffer so this requirement is for each server. Note: In addition to the buffer, Usage Monitor also maintains a Hash Map in memory. Each row in the Hash Map requires 200 bytes of memory. The size of the Hash Map is not configurable (like the buffer size) and is determined by the number of unique objects used in the system. The Hash Map is cleared only on server restart. Each server maintains it's own Hash Map and the Hash Map ensures that a single server will only write unique rows to the database for as long as the server remains up. This reduces, but does not eliminate, the need for data aggregation actions of collected data for subsequent use and processing. In order to optimize the number of database writes and data aggregation actions, the Buffer value should be set to a relatively large value that is ideally in line with the number of expected number of unique rows. Determining the optimal value for the buffer size will likely take some adjustment once usage collection is up and running and the volume of data being collected is better known. Factors that impacts the expected number of unique rows include: Data collection method (Anonymous or By UserID options). Number of users when collecting data with the By UserID option. Number of objects used in the system. For example, HCM92 has nearly 700,000 unique Managed Objects. However, it is likely that not all of these are in use. The buffer writes to the database when: the buffer is full. the Application server or Process Scheduler is shutdown. If the Buffer Size value is set too high, the buffer may never fill, causing the process to write collected data to the database only during the server shutdown event.
Managed Object Commit Size	Set this value to control the frequency of commits during database writes. Determining the optimal value of commit size will likely take some adjustment once usage collection is up and running and the volume of data being collected is better known The default value and minimum value is 2500.
Enable ADS Usage Monitoring
Enable ADS Usage Monitoring	Select to enable the Usage Monitor for ADS instances accessed through application server, Process Scheduler server, and Application Engine server. The use cases for ADS usage collection include General usage data collection for custom applications only. The list of ADS instances that are monitored and recorded will be those identified in the PSADSTRACKITEM PeopleTools table.
ADS Buffer Size	Select this value to adjust the performance of the system. Each buffer row requires 1000 bytes of memory, such that a Buffer Size value of 200,000 will require 200 MB of available memory. While the buffer maintains a unique set of objects, the writes to the buffer flush events to the database can result in duplicate data that must subsequently be aggregated. In order to minimize the number of database writes and data aggregation actions the Buffer value should be set to a relatively large value that is ideally in line with the number of expected number of unique rows. The default ADS buffer size is 2500 and the minimum value is 250. Set the buffer limit which determines how much data should be collected in the buffer before storing the data in the database. Depending on the ADS instances that are accessed, you can arrive at an optimum buffer size for usage pattern. Determining the optimal value for the buffer size will likely take some adjustment once usage collection is up and running and the volume of data being collected is better known. Factors that impacts the expected number of unique rows include: Collection mode. Number of users when collecting in By UserID option. Number of objects used in the system. The buffer writes to the database when: the buffer is full. the Application server or Process Scheduler is shutdown. If the Buffer Size value is set too high, the buffer may never fill, causing the process to write collected data to the database only during the server shutdown event.
Process Scheduler Usage Monitoring Options
Set Process Names and Process ID for Test Name and Test Case Name	When you select this option, the process name and process ID details get recorded for the usage data monitored by Application Engine server and Process Scheduler server. Note: This is not applicable for application server.
Purge Usage Monitor Data
After <N> days	N specifies the retention period or the number of days during which the Usage Monitor data remains in the PSPTUMPMTAGR table.
Purge Managed Object Data	Usage Monitor managed object data older than the retention period gets deleted when you click the Purge Managed Object Data button.
Purge ADS Data	ADS instance data older than the retention period gets deleted when you click the Purge ADS Data button.

To verify the Usage Monitor configuration:

On the Usage Monitoring Options page, set the Managed Object (MO) buffer size and the MO commit size to 2500, if you have selected to monitor MO usage.
Set the ADS buffer size to 250, if you have selected to monitor ADS usage.
Note: Until the buffer size value is reached, no Usage Monitor data will be written to the database.
Important! The values selected in step 1 are only to verify the Usage Monitor configuration, ensuring that data will be quickly written to the Usage Monitor tables. When you are using the Usage Monitor, you need to increase the Buffer Size value to a more appropriate "production" value. Refer to the documentation of Managed Object Buffer Size and Managed Object Commit Size given in the preceding table.
Shutdown and restart the application server domain and the PeopleSoft Internet Architecture.
Login to that application with your browser and navigate through a few pages and menus in the application.
With your SQL query tool, submit the following query on the monitoring database for managed objects:
```
SELECT * FROM PSPTUMPMTAGR
```
Note: The Usage Monitor managed object data is collected and stored in the PSPTUMPMTAGR table.
With your SQL query tool, submit the following query on the monitoring database for ADS instances:
```
SELECT * FROM PS_PTUMADSAGR
```
Note: The Usage Monitor ADS instance data is collected and stored in the PS_PTUMADSAGR table.
Verify that data is present in the table and that the timestamps correspond to the time you verified the Usage Monitor configuration.
Repeat the previous steps when setting the Buffer Size value to your production value.