Health Monitor

Overview

Health Monitor provides critical information about the AEM forms system, such as server information, memory usage, and processor usage. Also available are Work Manager statistics, such as the number of work items or jobs in the queue and their statuses. You can perform the following tasks using Health Monitor:

  • Verify that your system is running properly

  • View information to help diagnose system problems as they occur

  • Perform operations on work items or jobs displaying problems

  • Purge obsolete records from the Job Manager database

The Health Monitor page in administration console has three tabs:

  • The System tab displays resource monitoring charts and information about the forms server (or node in a clustered environment). (See View system information .)

  • The Work Manager tab displays data that is related to Work Manager, such as the number of work items in the Work Manager queue. You can filter the information by using various criteria or manage individual work items by using the operation tools. (See View statistics related to Work Manager .)

  • The Job Purge Scheduler tab enables you to purge obsolete records from the Job Manager database. (See Purge records from the Job Manager database .)

The Health Monitor web page is populated with statistics gathered through a Gemfire API. This API automatically discovers all nodes in a cluster. It also resolves security issues that occur when gathering statistics from behind proxy servers or load balancers. Java options are available to fine-tune the Health Monitor, decreasing the impact to the performance of your AEM forms environment. (See Fine-tuning Health Monitor performance .)

Access Health Monitor

In administration console, click Health Monitor in the upper-right corner of the page.

View system information

The System tab displays resource monitoring charts and information about the server that is running AEM forms. To access this information, in administration console, click Health Monitor in the upper-right corner of the page. If you are running AEM forms in a clustered environment, the information displayed is for the node selected from the Server list.

To save the current system information as a properties file, click Save.

The right pane of the System tab displays graphical representations of the following information:

  • Job and Work Count items

  • Heap and Committed Heap usage

  • Non Heap and Committed Non Heap usage

You can drag your pointer along the timeline to get values for a particular point in time.

Note: The graph data, server information values, and clock time are updated every 10 minutes. The information is not displayed in real time.

The left pane of the System tab displays the following information about the server or node:

Virtual Machine:
Java Virtual Machine (JVM) version on the server.

Virtual Machine Vendor:
Manufacturer of the JVM.

Virtual Machine Version:
JVM version number

Machine Name:
Host name of the server where AEM forms is installed.

Up Time:
The time, in hours and minutes, that the server has been running.

Just-In-Time Compiler:
The name of the compiler being used.

Compile Time:
The amount of time spent in compile.

Number of Live Threads:
The total number of threads currently present in the AEM forms system.

Number of Threads Peak:
Largest number of live threads ever recorded on the system.

Number of Loaded Classes:
Number of classes Loaded into the JVM.

Number of Unloaded Classes:
Number of classes Unloaded from the JVM.

Minimum Heap:
The minimum amount of heap that was used.

Maximum Heap:
The maximum amount of heap that was used.

Operating System Name:
The name of the operating system running on the AEM forms server.

Operating System Version:
Version number of the operating system running on the AEM forms server.

Operating System Arch:
The operating system architecture that the JVM is running on.

Number of Processors:
The number of processors on the system.

Virtual Machine Arguments:
The argument used by the JVM.

Class Path:
The class path used by the JVM.

Library Path:
The library path used by the JVM.

Boot Class Path:
The boot class path used by the JVM.

Application Server Type:
Type of application server used to run AEM forms.

Application Server Version:
Version number of the application server used to run AEM forms.

Application Server Vendor:
Manufacturer of the application server used to run AEM forms.

Installation Date:
Date (in yyyy-mm-dd format) that AEM forms was installed.

AEM forms Version:
Version of AEM forms that is installed.

Patch Version:
AEM forms patch number.

Database Name:
Type of database used by AEM forms.

Database Version:
Version number of the database used by AEM forms.

Database Drive Name:
The name of the driver used by the JVM to connect to the database.

Database Driver Version:
The version of the driver used by the JVM to connect to the database.

The Save button lets you save this system information in a property file.

View statistics related to Work Manager

The Work Manager tab displays statistics that relate to Work Manager items. These work items are in different states depending on where they are in their process. (See Status (for Default, Workflow, or Events categories only) .) You can filter the information to view only a subset of the items by using the various options that are available (for example, Status or Category). You can sort resulting work or job items (in ascending or descending order) by clicking one of the column headers. Also, you can manage the work items by using the operation tools that are displayed above the work items list.

Filter the work items

  1. Click the Work Manager tab.

  2. Select the criteria for one or more of the filters described below and then click Go.

Category

Default:
All work items that the client did not assign a category to when they were submitted. Work Manager manages these items, therefore the statuses belong to Work Manager.

Job Manager:
All jobs that belong to Job Manager. Job Manager manages its own jobs and has its own job statuses. See the specific job statuses described below.

Workflow:
All work items that belong to the Workflow execution. Workflow does not manage its own work items but relies on Work Manager; therefore, the statuses belong to Work Manager.

Events:
All work items that belong to Event Management. Event Management does not manage its own work items but relies on Work Manager; therefore, the statuses belong to Work Manager.

Status (for Default, Workflow, or Events categories only)

Show All:
Displays all current work items.

Scheduled:
Displays all work items ready for execution by the application server but not yet started.

Paused:
Displays all scheduled work items that the client application has paused. These items can be executed or deleted. (See Manage the work items or jobs .)

In Progress:
Displays all work items that the application server’s Work Manager picked up and will either complete or fail. You cannot use operations on these work items.

Complete:
Displays all work items that executed successfully. Persistent work items stay in this state and non-persistent items are deleted upon completion of callbacks to the callback handlers. You can delete these items by using the Delete Items operation. (See Manage the work items or jobs .)

Failed:
Displays all work items that did not complete successfully due to an error condition. These work items can be retried a few times by using the Retry Items operation. (See Manage the work items or jobs .) A Failure link in the Status column allows you to access details about the failure.

Unknown:
Displays all work items whose status is unknown.

Status (for Job Manager category only)

Completed:
Displays all jobs that have executed successfully. Persistent work items stay in this state and non-persistent items are deleted upon completion of callbacks to the callback handlers.

Complete Requested:
Displays jobs for which a complete request was made.

Fail Requested:
Displays jobs for which a fail request was made.

Failed:
Displays jobs that did not complete successfully due to an error condition. A Failure link in the Status column allows you to access details about the failure.

Terminate Requested:
Displays jobs for which a terminate request was made.

Terminated:
Displays jobs that terminated without completing.

Suspend Requested:
Displays jobs for which a suspend request was made.

Suspended:
Displays jobs that are suspended.

Resume Requested:
Displays jobs for which a resume request was made.

Queued:
Displays jobs that are in the queue.

Running:
Displays jobs that are running.

Server Name

For clustered servers only, select the name of the node to display the work items or job items that were created on that server only. If Show All is selected, all work items for all nodes in a cluster are displayed.

Create Time

Select an option in this filter to show only those work items that were created within the timeframe you select. For example, selecting 1 Day displays all work items that were created within 24 hours before the time that was set in the Prior To filter.

Prior to

Sets the date and time that the Create Time filter uses as an end date. Keep the Use Current Date & Time option selected to filter back from the current date and time, or deselect the option and enter the appropriate values. Click either the calendar icons or the clock icons to select values by using those tools.

For example, selecting Create Time = 1 day and Prior to = Use Current Date & Time returns all work items that were created within the last 24 hours.

Important: On Oracle database deployments, date range filters (that is, Create Time and Prior to settings) do not work accurately. Use another filter to retrieve work items.

About the Work Manager tab interface

When you run a Work Manager query or perform an operation on a work item or job, a message appears above the list. This message provides feedback about the action you have initiated and in some cases, a More Info link to provide details. For example, if the operation you initiated failed, the message states as much and provides a link to get details about the error.

When you click More Info, the Operation Details dialog box displays a list of the work items or jobs that were selected during the operation. You can click each list item to view the Error Details at the bottom of the dialog box.

Manage the work items or jobs

Use the operation tools described below to manage the work items or jobs in the list.
Note: Operations are available depending on the item’s status.

Delete Items: Deletes the selected work item or job.

Pause Items: Pauses the selected work item or job.

Resume Items: Resumes the selected work item or job from its paused state.

Retry Items: Attempts to rerun the selected work item or job from its current state.

You can verify whether an operation was successful by clicking More Info above the list. A dialog box that contains the selected work items or jobs and their statuses is displayed.

Additional information about work item statuses

A typical state transition for a work item is New > Scheduled >In Progress > Complete or Failure.

The Paused state interrupts this normal flow. Either the client application or the system administrator can initiate this interruption (for example, for maintenance or upgrade). You can reverse this action by using the Resume operation to move the work item back into a Scheduled state.

A work item in a Scheduled state is queued for execution that has not yet begun. These items can be paused or deleted, or will move to the In Progress state when Work Manager takes them from the queue. Work items that are in progress cannot be modified. They will either complete or fail.

The Failed state occurs as a result of an error condition that occurs during execution of the work item. If you suspect errors to be circumstantial (due to the context at the time of execution), you can retry the execution, putting the work item back into the queue. Only a limited number of retries are permitted.

Purge records from the Job Manager database

Process data that is generated when a long-lived process is invoked can become too large, resulting in lower AEM forms performance and the use of unnecessary disk space. It is good practice to purge process data when records are no longer necessary.

You can use administration console to perform a one-time purge of obsolete records, or to schedule regular automatic purges. Other methods for purging obsolete records are discussed in Purging process data .

Access the Job Purge Scheduler page

  1. In Administration Console, click Health Monitor in the upper-right corner of the page.

  2. Click the Job Purge Scheduler tab.

Information about any currently scheduled purges is displayed in the Job Purge Scheduler Information box.

Note: Clicking Stop Scheduler stops any purges scheduled in the future, but does not stop a purge job that is already underway.

Schedule a one-time purge

  1. Select One Time Only.

  2. In the Purge Completed Records Filter area, specify the number of days or weeks after which a record is deemed obsolete and ready for purging.

    Note: Records related to processes that have not been completed are not purged, even if they are older than the specified age.

  3. Specify when the purge will occur. Select the Use Current Date & Time checkbox, or clear the checkbox and click the calendar and clock icons to specify the date and time when the purge will be performed.

    Note: If you specify a start date and time that is in the past, the purge occurs immediately when you click Start Scheduler.

  4. Click Start Scheduler. Any previously scheduled scheduler settings are replaced with the new settings.

Configure an automatic purge schedule

  1. Select Recur Every and specify the number of days or weeks between purges.

  2. In the Purge Completed Records Filter area, specify the number of days or weeks after which a record is deemed obsolete and ready for purging. You cannot set the value to 0 .

    Note: Records related to processes that have not been completed are not purged, even if they are older than the specified age.

  3. Specify when the purges will begin. Select the Use Current Date & Time checkbox, or clear the checkbox and click the calendar and clock icons to specify the date and time when the purge will be performed.

    Note: If you specify a start date and time that is in the past, AEM forms calculates the logical next start date based on the date you specified. For example, if you schedule the job purges to occur weekly beginning April 7, and it is now April 9, the first purge occurs April 14.

  4. Click Start Scheduler. Any previously scheduled scheduler settings are replaced with the new settings.

Fine-tuning Health Monitor performance

Collecting the system statistics that populate Health Monitor has some impact on the performance of your AEM forms environment. This impact can be controlled by setting the Java options listed below in your application server.

Property

Purpose

Default value

adobe.healthmonitor.enabled

Turn on or off Health Monitor thread

true

adobe.cache.statistics-enabled

Turn on or off Gemfire caching

true

adobe.healthmonitor.refresh-interval

The interval in milliseconds after which the Health Monitor thread collects the statistics

10 minutes (600,000 milliseconds)

adobe.cache.multicast-port

The multicast port used to communicate with other members of the distributed system. If set to zero, multicast is disabled for both member discovery and distribution.

Note: Select different multicast addresses and ports for different distributed systems. Do not use different addresses only.

No default value. Valid values range from 0 to 65535.

statistic-sample-rate

The rate in milliseconds at which statistics are sampled. Operating system statistics are only updated when a sample is taken.

600000

adobe.workmanager.healthmonitor.enabled

This property enables or disables Work Manager statistic collection, such as job or work item count.

true

Add Java options to JBoss

  1. Stop the JBoss application server.

  2. Open the [appserver root] /bin/run.bat (Windows) or run.sh (Linux or UNIX) in an editor and add any of the Java options as required.

  3. Restart the server.

Add Java options to WebLogic

  1. Start the WebLogic administration console by typing http://[host name]:[port]/console in the URL line of a web browser.

  2. Type the user name and password that you created for the WebLogic Server domain and click Log Under Change Center, click Lock & Edit.

  3. Under Domain Structure, click Environment > Servers and, in the right pane, click the managed server name.

  4. On the next screen, click the Configuration tab > Server Start tab.

  5. In the Arguments box, append the arguments you require to the end of the current content. For example, adding ‑ Dadobe.healthmonitor.enabled=false disables Health Monitor.

  6. Click Save and then click Activate Changes.

  7. Restart WebLogic managed server.

Add Java options to WebSphere

  1. In the WebSphere Administrative Console navigation tree, do the following for your application server:

    (WebSphere 6.x) Click Servers > Application servers

    (WebSphere 7.x) Click Servers > Server Types > WebSphere application servers

  2. In the right pane, click the server name.

  3. Under Server Infrastructure, click Java and forms workflow > Process Definition.

  4. Under Additional Properties, click Java Virtual Machine.

  5. In the Generic JVM arguments box, type the arguments you require.

  6. Click OK or Apply, and then click Save directly to the master configuration.

// Ethnio survey code removed