Operations Dashboard operations-dashboard
Introduction introduction
The Operations Dashboard in AEM 6 helps system operators to monitor AEM system health at a glance. It also provides auto-generated diagnosis information on relevant aspects of AEM and lets you configure and run self-contained maintenance automation to reduce project operations and support cases significantly. The Operations Dashboard can be extended with custom health checks and maintenance tasks. Further, Operations Dashboard data can be accessed from external monitoring tools via JMX.
The Operations Dashboard:
- Is a one-click system status to help operations departments gain efficiency
- Provides system health overview in a single, centralized place
- Reduces time to find, analyze, and fix issues
- Provides self-contained maintenance automation that helps reduce project operations costs significantly
It can be accessed by going to Tools - Operations from the AEM Welcome screen.
Health Reports health-reports
The Health Report system provides information on the health of an AEM instance through Sling Health Checks. You accomplish this operation by way of either OSGI, JMX, HTTP requests (by way of JSON) or through the Touch UI. It offers measurements and threshold of certain configurable counters and sometimes, offers information on how to resolve the issue.
It has several features, described below.
Health Checks health-checks
The Health Reports are a system of cards indicating good or bad health about a specific product area. These cards are visualizations of the Sling Health Checks, which aggregate data from JMX and other sources and expose processed information again as MBeans. These MBeans can also be inspected in the JMX web console, under the org.apache.sling.healthcheck domain.
The Health Reports interface can be accessed through the Tools - Operations - Health Reports menu on the AEM Welcome screen, or directly through the following URL:
https://<serveraddress>:port/libs/granite/operations/content/healthreports/healthreportlist.html
The card system exposes three possible states: OK, WARN and CRITICAL. The states are a result of rules and thresholds, which can be configured by hovering the mouse over the card and then clicking the gear icon in the action bar:
Health Check Types health-check-types
There are two types of health checks in AEM 6:
- Individual Health Checks
- Composite Health Checks
An Individual Health Check is a single health check that corresponds to a status card. Individual Health Checks can be configured with rules or thresholds and they can provide one or more hints and links to solve identified health issues. Let’s take the “Log Errors” check as an example: if there are ERROR entries in the instance logs, find them on the details page of the health check. At the top of the page, you can see a link to the “Log Message” analyzer in the Diagnosis Tools section, which lets you analyze these errors in more detail and reconfigure the loggers.
A Composite Health Check is a check that aggregates information from several individual checks.
Composite health checks are configured with the aid of filter tags. In essence, all single checks that have the same filter tag are grouped as a composite health check. A Composite Health Check has an OK status only if all the single checks that it aggregates have OK statuses as well.
How to create Health Checks how-to-create-health-checks
In the Operations Dashboard, you can visualize the result of both individual and composite Health Checks.
Creating an individual Health Check creating-an-individual-health-check
Creating an individual Health Check involves two steps: implementing a Sling Health Check and adding an entry for the Health Check in the Dashboard’s configuration nodes.
-
To create a Sling Health Check, create an OSGI component implementing the Sling HealthCheck interface. Add this component inside a bundle. The properties of the component fully identify the Health Check. After the component is installed, a JMX MBean is automatically created for the Health Check. See the Sling Health Check Documentation for more information.
Example of a Sling Health Check component, written with OSGI service component annotations:
code language-java @Component(service = HealthCheck.class, property = { HealthCheck.NAME + "=Example Check", HealthCheck.TAGS + "=example", HealthCheck.TAGS + "=test", HealthCheck.MBEAN_NAME + "=exampleHealthCheckMBean" }) public class ExampleHealthCheck implements HealthCheck { @Override public Result execute() { // health check code } }note note NOTE The MBEAN_NAMEproperty defines the name of the mbean that is generated for this health check. -
After creating a Health Check, a new configuration node must be created to make it accessible in the Operations Dashboard interface. For this step, it is necessary to know the JMX Mbean name of the Health Check (the
MBEAN_NAMEproperty). To create a configuration for the Health Check, open CRXDE and add a node (of type nt:unstructured) under the following path:/apps/settings/granite/operations/hcThe following properties should be set on the new node:
-
Name:
sling:resourceType- Type:
String - Value:
granite/operations/components/mbean
- Type:
-
Name:
resource- Type:
String - Value:
/system/sling/monitoring/mbeans/org/apache/sling/healthcheck/HealthCheck/exampleHealthCheck
- Type:
note note NOTE The resource path above is created as follows: if the mbean name of your Health Check is “test”, add “test” to the end of the path /system/sling/monitoring/mbeans/org/apache/sling/healthcheck/HealthCheckSo the final path is the following: /system/sling/monitoring/mbeans/org/apache/sling/healthcheck/HealthCheck/testnote note NOTE Make sure that the /apps/settings/granite/operations/hcpath has the following properties set to true:sling:configCollectionInheritsling:configPropertyInheritThis process tells the configuration manager to merge the new configurations with the existing ones from /libs. -
Creating a Composite Health Check creating-a-composite-health-check
A Composite Health Check’s role is to aggregate several individual Health Checks sharing a set of common features. For example, the Security Composite Health Check groups all the individual health checks performing security-related verifications. The first step to create a composite check is to add an OSGI configuration. For it to be displayed in the Operations Dashboard, a new configuration node must be added in the same way as a simple check.
-
Go to the Web Configuration Manager in the OSGI Console. Access
https://serveraddress:port/system/console/configMgr -
Search for the entry called Apache Sling Composite Health Check. After you find it, notice that there are two configurations already available: one for the System Checks and another one for the Security Checks.
-
Create a configuration by pressing the “+” button on the right-hand side of the configuration. A new window appears, as shown below:
-
Create a configuration and save it. A Mbean is created with the new configuration.
The purpose of each configuration property is as follows:
- Name (hc.name): The name of the Composite Health Check. A meaningful name is recommended.
- Tags (hc.tags): The tags for this Health Check. If this composite health check is intended to be a part of another composite health check (such as in a hierarchy of health checks), add the tags this composite is related to.
- MBean Name (hc.mbean.name): The name of the Mbean that is given to the JMX MBean of this composite health check.
- Filter Tags (filter.tags): The property that is specific to composite health checks. These tags are aggregated by the composite. The composite health check aggregates under its group all the health checks that have any tag matching any of the filter tags of this composite. For example, a composite health check having the filter tags test and check, aggregates all the individual and composite health checks that have any of the test and check tags in their tags property (
hc.tags).
note note NOTE A new JMX Mbean is created for each new configuration of the Apache Sling Composite Health Check.** -
Finally, the entry of the composite health check that has been created must be added in the Operations Dashboard configuration nodes. The procedure is the same as with individual health checks: a node of type nt:unstructured must be created under
/apps/settings/granite/operations/hc. The resource property of the node is defined by the value of hc.mean.name in the OSGI configuration.For example, if you created a configuration and set the hc.mbean.name value to diskusage, the configuration nodes look like the following:
-
Name:
Composite Health Check- Type:
nt:unstructured
- Type:
With the following properties:
-
Name:
sling:resourceType- Type:
String - Value:
granite/operations/components/mbean
- Type:
-
Name:
resource- Type:
String - Value:
/system/sling/monitoring/mbeans/org/apache/sling/healthcheck/HealthCheck/diskusage
- Type:
note note NOTE If you create individual health checks that logically belong under a composite check that is already present in the Dashboard by default, they are automatically captured and grouped under the respective composite check. As such, there is no need to create a configuration node for these checks. For example, if you create an individual security health check, assign it the “security” tag, and it is installed. It automatically appears under the Security Checks composite check in the Operations Dashboard. -
Health Checks Provided with AEM health-checks-provided-with-aem
Health Check Configuration health-check-configuration
By default, for an out-of-the-box AEM instance, the health checks run every 60 seconds.
You can configure the Period with the OSGi configuration Query Health Check Configuration (com.adobe.granite.queries.impl.hc.QueryHealthCheckMetrics).
Monitoring with External Services monitoring-with-external-services
Integration is possible with external technologies or vendors. Consult their documentation for related details.
Diagnosis tools diagnosis-tools
The Operation Dashboard also provides access to Diagnosis Tools that can help finding and troubleshooting root causes of the warnings coming from the Health Check Dashboard, and providing important debug information for system operators.
Among its most important features are:
- A log message analyzer
- The ability to access heap and thread dumps
- Requests and query performance analyzers
You can reach the Diagnosis Tools screen by going to Tools - Operations - Diagnosis from the AEM Welcome screen. You can also access the screen by directly accessing the following URL: https://serveraddress:port/libs/granite/operations/content/diagnosis.html
Log Messages log-messages
The log messages User Interface displays all ERROR messages by default. If you want to have more log messages displayed, configure a logger with the appropriate log level.
The log messages use an in memory log appender and therefore, are not related to the log files. Another consequence is that changing the log levels in this UI does not change the information that gets logged in the traditional log files. Adding and removing loggers in this UI only affects the memory logger. Also, changing the logger configurations is reflected in the future of the in memory logger. The entries that are already logged and are not relevant anymore are not deleted, but similar entries are not logged in the future.
You can configure what gets logged by providing logger configurations from the upper left gear button in the UI. There, you can add, remove, or update logger configurations. A logger configuration is composed of a log level (WARN / INFO / DEBUG) and a filter name. The filter name has the role of filtering the source of the log messages that get logged. Alternatively, if a logger should capture all the log messages for the specified level, the filter name should be “root”. Setting the level of a logger triggers the capture of all messages with a level equal or higher than the one specified.
Examples:
-
If you plan on capturing all the ERROR messages - no configuration is required. All the ERROR messages are captured by default.
-
If you plan on capturing all the ERROR, WARN and INFO messages - the logger name should be set to: “root”, and the logger level to: INFO.
-
If you plan on capturing all the messages coming from a certain package (for example, com.adobe.granite) - the logger name should be set to: “com.adobe.granite”. And, the logger level set to: DEBUG (doing so captures all the ERROR, WARN, INFO, and DEBUG messages), as shown in the image below.
Log level: INFO
DATE+TIME [MaintanceLogger] Name=<MT_NAME>, Status=<MT_STATUS>, Time=<MT_TIME>, Error=<MT_ERROR>, Details=<MT_DETAILS>
Request performance request-performance
The Request Performance page allows the analysis of the slowest page requests processed. Only content requests are registered on this page. More specifically, the following requests are captured:
- Requests accessing resources under
/content - Requests accessing resources under
/etc/design - Requests having the
".html"extension
The page displays:
- The time when the request was made
- The URL and the method of request
- The duration in milliseconds
By default, the slowest 20 page requests are captured, but the limit can be modified in the Configuration Manager.
Query Performance query-performance
The Query Performance page allows the analysis of the slowest queries performed by the system. This information is provided by the repository in a JMX Mbean. In Jackrabbit, the com.adobe.granite.QueryStat JMX Mbean provides this information, while in the Oak repository, it is offered by org.apache.jackrabbit.oak.QueryStats.
The page displays:
- The time when the query was made
- The language of the query
- The number of times the query was issued
- The statement of the query
- The duration in milliseconds
Explain Query explain-query
For any given query, Oak attempts to figure out the best way to execute based on the Oak indexes defined in the repository under the oak:index node. Depending on the query, different indexes may be chosen by Oak. Understanding how Oak is executing a query is the first step to optimizing the query.
The Explain Query is a tool that explains how Oak is executing a query. It can be accessed by going to Tools - Operations - Diagnosis from the AEM Welcome Screen. Then, click Query Performance and switch over to the Explain Query tab.
Features
- Supports the Xpath, JCR-SQL, and JCR-SQL2 query languages
- Reports the actual execution time of the provided query
- Detects slow queries and warns about queries that could be potentially slow
- Reports the Oak index used to execute the query
- Displays the actual Oak Query engine explanation
- Provides click-to-load list of Slow and Popular queries
After you are in the Explain Query UI, enter the query, and press the Explain button:
The first entry in the Query Explanation section is the actual explanation. The explanation shows the type of index that was used to execute the query.
The second entry is the execution plan.
Ticking the Include execution time box before running the query also shows the amount of time the query was run in. The Include Node Count option reports the node count. The report allows for more information that can be used for optimizing the indexes for your application or deployment.
The Index Manager the-index-manager
The purpose of the Index Manager is to facilitate index management such as maintaining indexes, or viewing their status.
It can be accessed by going to **Tools - Operations - Diagnosis **from the Welcome Screen, and then clicking the Index Manager button.
It can also be accessed directly at this URL: https://serveraddress:port/libs/granite/operations/content/diagnosistools/indexManager.html
The UI can be used to filter indexes in the table by typing in the filter criteria in the search box in the upper left corner of the screen.
Download Status ZIP download-status-zip
This action triggers the download of a zip containing useful information about the system status and configuration. The archive contains instance configurations, a list of bundles, OSGI, Sling metrics and statistics, which can result in a large file. You can reduce the impact of large status files by using the Download Status ZIP window. The window can be accessed from: AEM > Tools > Operations > Diagnosis > Download Status ZIP.
From this window, you can select what to export (log files and or thread dumps) and the number of days of logs included in the download relative to the current date.
Download Thread Dump download-thread-dump
This action triggers the download of a zip containing information about the threads present in the system. Information about each thread is provided, such as its status, the classloader, and the stacktrace.
Download Heap Dump download-heap-dump
You can download a snapshot of the heap to analyze it later. This action triggers the download of a large (hundreds of megabytes) file.
Automated Maintenance Tasks automated-maintenance-tasks
The Automated Maintenance Tasks page is a place where you can view and track recommended maintenance tasks scheduled for periodic execution. The tasks are integrated with the Health Check system. The tasks can also be manually executed from the interface.
To get to the Maintenance page in the Operations Dashboard, from the AEM Welcome screen, go to Tools - Operations - Dashboard - Maintenance, or directly follow this link:
https://serveraddress:port/libs/granite/operations/content/maintenance.html
The following tasks are available in the Operations Dashboard:
- The Revision Clean Up task, located under the Daily Maintenance Window menu.
- The Lucene Binaries Cleanup task, located under the Daily Maintenance Window menu.
- The Workflow purge task, located under the Weekly Maintenance Window menu.
- The Data Store Garbage Collection task, located under the Weekly Maintenance Window menu.
- The Audit Log Maintenance task, located under the Weekly Maintenance Window menu.
- The Version Purge Maintenance task, located under the Weekly Maintenance Window menu.
- The Project Purge maintenance task, located under the Weekly Maintenance Window menu; using the Add option.
- The Purge of ad-hoc tasks maintenance task, located under the Weekly Maintenance Window menu; using the Add option.
The default timing for the daily maintenance window is 2:00 A.M. through 5:00 A.M. The tasks configured to run in the weekly maintenance window run between 1:00 A.M and 2:00 A.M. on Saturdays.
You can also configure the timings by pressing the gear icon on any of the two maintenance cards:
Revision Clean Up revision-clean-up
For more information, see Revision Cleanup.
Lucene Binaries Cleanup lucene-binaries-cleanup
By using the Lucene Binaries Cleanup task, you can purge lucene binaries and reduce the running data store size requirement. Lucene’s binary churn is reclaimed daily instead of the earlier dependency on a successful data store garbage collection run.
Though the maintenance task was developed to reduce Lucene related revision garbage, there are general efficiency gains when running the task:
- The weekly running of the data store garbage collection task can complete more quickly.
- It may also slightly improve the overall AEM performance.
You can access the Lucene Binaries Cleanup task from: AEM > Tools > Operations > Maintenance > Daily Maintenance Window > Lucene Binaries Cleanup.
Data Store Garbage Collection data-store-garbage-collection
For details on Data Store Garbage Collection, see the dedicated Data Store Garbage Collection documentation page.
Workflow purge workflow-purge
Workflows can also be purged from the Maintenance Dashboard. To run the Workflow Purge task, do the following:
- Click the Weekly Maintenance Window page.
- In the following page, click Play in the Workflow purge card.
Audit Log Maintenance audit-log-maintenance
For Audit Log Maintenance, see the separate documentation page.
Version Purge version-purge
You can schedule the Version Purge maintenance task to delete old versions automatically. This action minimizes the need to manually use the Version Purge tools. You can schedule and configure the Version Purge task by accessing Tools > Operations > Maintenance > Weekly Maintenance Window and following these steps:
-
Click Add.
-
Choose Version Purge from the drop-down menu.
-
To configure the Version Purge task, click the gears icon on the newly created Version Purge maintenance card.
With AEM 6.4, you can stop the Version Purge maintenance task as follows:
- Automatically - If the scheduled maintenance window closes before the task can complete, the task stops automatically. It will resume when the next maintenance window opens.
- Manually - To manually stop the task, on the Version Purge maintenance card, click the Stop icon. On the next execution, the task will safely resume.
Project Purge project-purge
Configure the OSGI properties under Adobe Projects Purge Configuration (com.adobe.cq.projects.purge.Scheduler).
Purge of ad-hoc tasks purge-of-ad-hoc-tasks
Configure the OSGI properties under Ad-hoc Task Purge (com.adobe.granite.taskmanagement.impl.purge.TaskPurgeMaintenanceTask).
Custom Maintenance Tasks custom-maintenance-tasks
Custom maintenance tasks can be implemented as OSGi services. As the maintenance task infrastructure is based on Apache Sling’s job handling, a maintenance task must implement the Java™ interface [org.apache.sling.event.jobs.consumer.JobExecutor](https://sling.apache.org/apidocs/sling7/org/apache/sling/event/jobs/consumer/JobExecutor.html). In addition, it must declare several service registration properties to be detected as a maintenance task, as listed below:
Apart from the above service properties, the process() method of the JobConsumer interface must be implemented by adding the code that should be executed for the maintenance task. The provided JobExecutionContext can be used to output status information, check if the job is stopped by the user and create a result (success or failed).
For situations where a maintenance task should not be run on all installations (for example, run only on the publish instance), you can make the service require a configuration to be active by adding @Component(policy=ConfigurationPolicy.REQUIRE). You can then mark the according configuration as being run mode dependent in the repository. For more information, see Configuring OSGi.
Below is an example of a custom maintenance task that deletes files from a configurable temporary directory which have been modified in the last 24 hours:
src/main/java/com/adobe/granite/samples/maintenance/impl/DeleteTempFilesTask.java
experiencemanager-java-maintenancetask-sample- src/main/java/com/adobe/granite/samples/maintenance/impl/DeleteTempFilesTask.java
After the service is deployed, it is exposed to the Operations Dashboard UI. You can add it to one of the available maintenance schedules:
This action adds a corresponding resource at /apps/granite/operations/config/maintenance/schedule/taskname. If the task is run mode dependent, the property granite.operations.conditions.runmode must be set on that node with the values of the run modes that must be active for this maintenance task.
System Overview system-overview
The System Overview Dashboard displays a high-level overview of the configuration, hardware, and health of the AEM instance. System health status is transparent, and all the information is aggregated in a single dashboard.
How To Access how-to-access
To access the System Overview Dashboard, navigate to Tools > Operations > System Overview.
System Overview Dashboard Explained system-overview-dashboard-explained
The table below, describes all the information displayed in the System Overview Dashboard. When there is no relevant information to show (for example, backup is not in progress, there are no health checks that are critical) the respective section displays the “No Entries” message.
You can also download a JSON file summarizing the dashboard information by clicking the Download button in the upper right-hand corner of the dashboard. The JSON endpoint is /libs/granite/operations/content/systemoverview/export.json and it can be used in a curl script for external monitoring.