Monitoring Server Resources Using the JMX Console monitoring-server-resources-using-the-jmx-console

The JMX Console enables you to monitor and manage services on the CRX server. The sections that follow summarize the attributes and operations that are exposed through the JMX framework.

For information about how to use the console controls, see Using the JMX Console. For background information about JMX, see the Java Management Extensions (JMX) Technology page on the Oracle website.

For information about creating MBeans to manage your services using the JMX Console, see Integrating Services with the JMX Console.

Workflow Maintenance workflow-maintenance

Operations for administering running, completed, stale, and failed workflow instances.

Operations operations

listRunningWorkflowsPerModel Lists the number of workflow instances that are running for each workflow model.

listCompletedWorkflowsPerModel Lists the number of completed workflow instances for each workflow model.

returnWorkflowQueueInfo Lists information about workflow items that have been processed and that are queued for processing.

returnWorkflowJobTopicInfo Lists processing information for workflow jobs, organized by topic.

returnFailedWorkflowCount Shows the number of workflow instances that have failed. You can specify a workflow model to query or retrieve information for all workflow models.

returnFailedWorkflowCountPerModel Shows the number of workflow instances that have failed for each workflow model.

terminateFailedInstances Terminate workflow instances that have failed. You can terminate all failed instances or only the failed instances for a specific model. Optionally you can restart the instances after they are terminated. You can also test the operation to see the results without actually performing the operation.

retryFailedWorkItems Attempts to execute work item steps that have failed. You can retry all failed work items or only the failed work items for a specific workflow model. You optionally test the operation to see the results without actually performing the operation.

PurgeActive Removes active workflow instances of a specific age. You can purge active instances for all models or only the instances for a specific model. You can optionally test the operation to see the results without actually performing the operation.

countStaleWorkflows Returns the number of workflow instances that are stale. You can retrieve the number of stale instances for all workflow models or for a specific model.

restartStaleWorkflows Restarts stale workflow instances. You can restart all stale instances or only the stale instances for a specific model. You can also test the operation to see the results without actually performing the operation.

fetchModelList Lists all workflow models.

countRunningWorkflows Returns the number of workflow instances that are running. You can retrieve the number of running instances for all workflow models or for a specific model.

countCompletedWorkflows Returns the number of workflow instances that are completed. You can retrieve the number of completed instances for all workflow models or for a specific model.

purgeCompleted Removes records of completed workflows of a specific age from the repository. Use this operation periodically to minimize the size of the repository when you make heavy use of workflows. You can purge completed instances for all models or only the instances for a specific model. You can optionally test the operation to see the results without actually performing the operation.

Repository repository

Information about the CRX repository

Attributes attributes

Name The name of the JCR repository implementation. Read-only.

Version The repository implementation version. Read-only.

HomeDir The directory where the repository is located. The default location is <QuickStart_Jar_Location>/crx-quickstart/repository. Read-only.

CustomerName The name of the customer that the software license is issued to. Read-only.

LicenseKey The unique license key for this installation of the repository. Read-only.

AvailableDiskSpace The disk space that is available to this instance of the repository, in Mbytes. Read-only.

MaximumNumberOfOpenFiles The number of files that can be opened at one time. Read-only.

SessionTracker The value of the crx.debug.sessions system variable. true indicates a debug session. false indicates a normal session. Read/write.

Descriptors A set of key-value pairs that represent repository properties. All properties are read-only.

WorkspaceNames The names of the workspaces in the repository. Read-only.

DataStoreGarbageCollectionDelay The amount of time in milliseconds that garbage collection sleeps after scanning every tenth node. Read/write.

BackupDelay The amount of time in milliseconds that the backup process sleeps between each step of the backup. Read/write.

BackupInProgress A value of true indicates that a backup process is executing. Read-only.

BackupProgress For the current backup, the percentage of all files that have been backed up. Read-only.

CurrentBackupTarget For the current backup, the ZIP file where backup files are being stored. When a backup is not in progress, no value appears. Read-only.

BackupWasSuccessful A value of true indicates that no errors have occurred during the current backup, or no backup is in progress. false indicates an error occurred during the current backup. Read-only.

BackupResult The status of the current backup. The following values are possible:

Read-only.

TarOptimizationRunningSince The time at which the current TAR file optimization process began. Read-only.

TarOptimizationDelay The amount of time in milliseconds that the TAR optimization process sleeps between each step of the process. Read/write.

ClusterProperties A set of key-value pairs that represent cluster properties and values. Each row in the table represents a cluster property. Read-only.

ClusterNodes The members of the repository cluster.

ClusterId The identifier of this repository cluster. Read-only.

ClusterMasterId The identifier of the master node of this repository cluster. Read-only.

ClusterNodeId The identifier of this node of the repository cluster. Read-only.

Operations operations-1

createWorkspace Creates a workspace in this repository.

runDataStoreGarbageCollection Executes garbage collection on the repository nodes.

stopDataStoreGarbageCollection Stops a running data store garbage collection.

startBackup Backs up repository data in a ZIP file.

cancelBackup Stops the current backup process and deletes the temporary archive that the process created for archiving data.

blockRepositoryWrites Blocks changes to the repository data. All repository backup listeners are notified of the block.

unblockRepositoryWrites Removes the block from the repository. All repository backup listeners are notified of the block removal.

startTarOptimization Starts the TAR file optimization process using the default value for tarOptimizationDelay.

stopTarOptimization Stops TAR file optimization.

tarIndexMerge Merges the top index files of all TAR sets. Top index files are files with different major versions. For example, the following files are merged into the file index_3_1.tar: index_1_1.tar, index_2_0.tar, index_3_0.tar. The files that have been merged are deleted (in the previous example, index_1_1.tar, index_2_0.tar, and index_3_0.tar are deleted).

becomeClusterMaster Sets this repository node as the master node of the cluster. If not already master, this command stops the current master instance’s listener and starts a master listener on the current node. This node is then set as the master node and restarts, causing all other nodes in the cluster (that is, those that are controlled by the master) to connect to this instance.

joinCluster Adds this repository to a cluster as a node that is controlled by the cluster master. Provide a user name and password for authentication purposes. The connection uses basic authentication. The security credentials are base-64 encoded before being sent to the server.

traversalCheck Traverses and optionally fixes inconsistencies in a subtree beginning at a specific node. This is covered in full detail in the documentation on Persistence Managers.

consistencyCheck Checks and optionally fixes consistency in the Datastore. This is covered in full detail in the documentation on the Datastore.

Repository Statistics (TimeSeries) repository-statistics-timeseries

The value of the TimeSeries field for each statistic type that org.apache.jackrabbit.api.stats.RepositoryStatistics defines.

Attributes attributes-1

The following attributes are provided for each statistic type that is reported:

Repository Query Stats repository-query-stats

Statistical information about repository queries.

Attributes attributes-2

SlowQueries Information about the repository queries that have taken the longest time to complete. Read-only.

SlowQueriesQueueSize The maximum number of queries to include in the SlowQueries list. Read-write.

PopularQueries Information about the repository queries that have occurred the most. Read-only.

PopularQueriesQueueSize The maximum number of queries in the PopularQueries list. Read-write.

Operations operations-2

clearSlowQueriesQueue Removes all queries from the SlowQueries list.

clearPopularQueriesQueue Removes all queries from the PopularQueries list.

Replication Agents replication-agents

Monitor the services for each replication agent. When you create a replication agent, the service automatically appears in the JMX console.

Attributes attributes-3

Id A String value that represents the identifier of the replication agent configuration. Multiple agents can use the same configuration. Read-only.

Valid A boolean value that indicates whether the agent is configured correctly:

Read-only.

Enabled A boolean value that indicates whether the agent is enabled:

QueueBlocked A boolean value that indicates whether the queue exists and is blocked:

Read-only.

QueuePaused A boolean value that indicates whether the job queue is paused:

Read-write.

QueueNumEntries An int value that represents the number of jobs in the agent queue. Read-only.

QueueStatusTime A Date value that indicates the time on the server when the displayed status values were obtained. The value corresponds with the time that the page was loaded. Read-only.

QueueNextRetryTime For blocked queues, a Date value that indicates when the next automatic retry occurs. When no time appears, the queue is not blocked. Read-only.

QueueProcessingSince A Date value that indicates when processing began for the current job. When no time appears, the queue is either blocked or idle. Read-only.

QueueLastProcessTime A Date value that indicates when the previous job was completed. Read-only.

Operations operations-3

queueForceRetry For blocked queues, issues the retry command to the queue.

queueClear Removes all jobs from the queue.

Sling Engine sling-engine

Provides statistics about HTTP requests so that you can monitor the performance of the SlingRequestProcessor service.

Attributes attributes-4

RequestsCount The number of requests that have occurred since the statistics were last reset.

MinRequestDurationMsec The shortest amount of time (in milliseconds) that was required to process a request since the statistics were last reset.

MaxRequestDuratioMsec The longest amount of time (in milliseconds) that was required to process a request since the statistics were last reset.

StandardDeviationDurationMsec The standard deviation of the amount of time that was required to process requests. The standard deviation is calculated using all requests since the statistics were last reset.

MeanRequestDurationMsec The mean amount of time that was required to process a request. The mean is calculated using all requests since the statistics were last reset

Operations operations-4

resetStatistics Sets all statistics to zero. Reset the statistics when you need to analyze request processing performance during a specific time frame.

id The String representation of the package ID.

installed A boolean value that indicates whether the package is installed:

installedBy The ID of the user who last installed the package.

installedDate The date when the package was last installed.

size A long value that holds the size of the package in bytes.

Quickstart Launcher quickstart-launcher

Information about the startup process and the Quickstart launcher.

Operations operations-5

log

Displays a message in the QuickStart window.

Arguments:

startupFinished

Calls the startupFinished method of the server launcher. The method attempts to open the Welcome page in a web browser.

startupProgress

Sets the completion value of the server startup process. The progress bar on the QuickStart window represents the completion value.

Third-Party Services third-party-services

Several third-party server resources install MBeans that expose attributes and operations to the JMX console. The following table lists the third-party resources and provides links to more information.

Using the JMX Console using-the-jmx-console

The JMX Console displays information about several services that are running on the server:

MBeans that are deployed with an OSGi service expose service attributes and operations to the console. The MBean determines the attributes and operations that are exposed, and whether the attributes are read-only or read-write.

The main page of the JMX console includes a table of services. Each row in the table represents a service that is exposed by an MBean.

Using External JMX Applications for Monitoring using-external-jmx-applications-for-monitoring

CRX allows external applications to interact with Managed Beans (MBeans) via Java Management Extensions (JMX). Using generic consoles such as JConsole or domain-specific monitoring applications, allows getting and setting CRX configurations and properties, and the monitoring of performance and resource usage.

Using JConsole to connect to CRX using-jconsole-to-connect-to-crx

To connect to CRX using JConsole, follow these steps:

JConsole will start and the JConsole window will appear.

Connecting to a local CRX process connecting-to-a-local-crx-process

JConsole will display a list of local Java Virtual Machine processes. The list will contain two quickstart processes. Select the quickstart “CHILD” process from the list of local processes (usually the one with the higher PID).

Connecting to a remote CRX process connecting-to-a-remote-crx-process

To connect to a remote CRX process, the JVM that hosts the remote CRX process must be enabled to accept remote JMX connections.

To enable remote JMX connections, the following system property must be set when starting the JVM:

com.sun.management.jmxremote.port=portNum

In the property above, portNum is the port number through which you want to enable JMX RMI connections. Be sure to specify an unused port number. In addition to publishing an RMI connector for local access, setting this property publishes an additional RMI connector in a private read-only registry at the specified port using a well known name, “jmxrmi”.

By default, when you enable the JMX agent for remote monitoring, it uses password authentication based on a password file that needs to be specified using the following system property when starting the Java VM:

com.sun.management.jmxremote.password.file=pwFilePath

See the relevant JMX documentation for detailed instructions on setting up a password file.

Example:

$ java
  -Dcom.sun.management.jmxremote.password.file=pwFilePath
  -Dcom.sun.management.jmxremote.port=8463
  -jar ./cq-quickstart.jar

Using the MBeans provided by CRX using-the-mbeans-provided-by-crx

After connecting to the quickstart process, JConsole provides a range of general monitoring tools for the JVM that CRX is running in.

To access CRX’s internal monitoring and configuration options, go to the MBeans tab, and from the hierarchical content tree on the left, select the Attributes or Operations section that you are interested in. For example, the com.adobe.granite/Repository/Operations section.

Within that section, select the desired attribute or operation in the left pane.