Server Diagnostics

JasperReports Server provides comprehensive diagnostics so administrators can monitor the health and performance of the running server. As of version 5.0, the server augments the audit logging with monitoring data that's easier to report against. Version 5.0 also introduced diagnostics that provide real-time information about the running server, such as memory use. All of these tools can help you troubleshoot issues and analyze performance.

Auditing stores key events of interest to system administrators, such as login/logout time, user, report generated, report details, and object sizes. The audited events can be saved and moved to an archive automatically after a specified number of days.
Monitoring is based on audit events and provides a multi-dimensional Domain to create Ad Hoc views. This helps you generate reports that contain key metrics such as which reports use the most resources. This allow you to find places to optimize your data sources and your reports.
Diagnostics provide run-time data that shows the overall health of your server instance. For example, it includes values such as logged in users, currently running reports, scheduled reports, and memory use and performance in the Ad Hoc cache. The diagnostic data is exposed in a custom data source and can be easily viewed in a report or integrated with industry standard management consoles.

This section describes functionality that can be restricted by the software license for JasperReports Server. If you don’t see some of the options described in this section, your license may prohibit you from using them. To find out what you're licensed to use, or to upgrade your license, contact us.

This chapter contains the following sections:

Events Being Audited and Monitored
Configuring Auditing and Monitoring
Using the Audit Data
Using the Monitoring Data
Importing and Exporting Event Data
Real-Time Diagnostics
Exposing Diagnostics Through Jaspersoft's JMX Agent
Using the Diagnostic Data in Reports
Excluding Diagnostic Attributes
Disabling Real-Time Diagnostics