Monitoring AEM forms deployments

You can monitor AEM forms deployments from both a system level
and an internal level. You can use specialist management tools such
as HP OpenView, IBM Tivoli, and CA UniCenter and a third-party JMX
monitor called JConsole to specifically monitor Java activity.
Implementation of a monitoring strategy improves availability, reliability,
and performance of your AEM forms deployments.

Monitoring using MBeans

AEM forms provides two registered MBeans that provide navigation
and statistic information. These are the only MBeans that are supported
for integration and inspection:

ServiceStatistic: This MBean provides information
about Service name and its version.

OperationStatistic: This MBean provides the statistic
of every forms server’s service. This is where administrators can
get information about a particular service such as invocation time,
number of errors, and so on.

ServiceStatisticMbean public interfaces

These public interfaces of ServiceStatistic MBean can be
accessed for testing purposes:

public String getServiceId();
public int getMajorVersion();
public int getMinorVersion();

OperationStatisticMbean public
interfaces

These public interfaces of OperationStatistic MBean can
be accessed for testing purposes:

// InvocationCount: The number of times the method is invoked.
public long getInvocationCount();
// InvocationStartTime: The time at which the method started to execute.
public long getInvocationStartTime();
// InvocationEndTime: The time at which the method finished execution.
public long getInvocationEndTime();
// InvocationTime: The time taken for the execution of the method.
public long getInvocationTime();
// LastSamplingDateTime: Convert InvocationStartTime to a formatted string
public String getLastSamplingDateTime();
// MaxInvocationTime: The maximum time taken for the execution of the method.
public long getMaxInvocationTime();
// MinInvocationTime: The minimum time taken for the execution of the method.
public long getMinInvocationTime();
// AverageInvocationTime: the averege execution time taken for the execution of the method.
public double getAverageInvocationTime();
// ExceptionCount: The number of times the method has thrown an Exception.
public long getExceptionCount();
// ExceptionMessage: The message of the last exception occurred.
public String getExeptionMessage();
public void setExceptionMessage(String errorMessage);

MBean Tree & Operation Statistics

Using a JMX console (JConsole), statistics from OperationStatistic
MBean are available. These statistics are MBean's attributes, and
can be navigated under the following hierarchy tree:

MBean
tree

Adobe Domain Name:

Depends on Application Server. If the Application Server
does not define the domain, the default is adobe.com.

ServiceType:

AdobeService is the name used to list all services.

AdobeServiceName:

Service Name, or Service ID.

Version:

Version of the service.

Operation
Statistics

Invocation Time:

Time taken for the execution of the method. This does not include
the time the request is serialized, transferred from client to server,
and deserialized.

Invocation count:

The number of times the service is invoked.

Average invocation time:

Average time of all invocations that have executed since
the server was started.

Max invocation time:

The duration of the longest invocation that has executed since
the server was started.

Min invocation time:

The duration of the shortest invocation that has executed since
the server was started.

Exception Count:

Number of invocations that have resulted in failures.

Exception Message:

The error message of the last exception that occurred.

Last Sampling Date Time:

The date of the last invocation.

Time Unit:

Default is millisecond.

To enable JMX monitoring, the
application servers typically need some configuration. See your
application server documentation for the specifics.

Examples of how to set up open
JMX access

JBoss
4.0.3/4.2.0 - configure the JVM startup

To view MBeans
from JConsole, configure the JBoss application server’s JVM startup
parameters. Ensure JBoss is started from the run.bat/sh file.