Using the Monitoring Data

JasperReports Server makes the monitoring data available to administrators through a Domain and several prepared views and reports. These are located in the /Public/Monitoring folder of the repository.

Monitoring Reports in the Repository

To create an Ad Hoc View based on the audit Domains, select Create > Ad Hoc View, select the Domains tab in the Data Chooser, and select the monitoring Domain. For instructions on using Domains in reports, see the Ad Hoc chapter in JasperReports Server User Guide. For documentation of Domains in general, see the JasperReports Server Data Management Using Domains.

The following sections explain the contents of the Domains and the reports provided.

Monitoring Domain Items

The monitoring Domain exposes the fields of the monitoring tables stored in the server's internal database. As with all Domains, the database tables are joined, and the fields are presented as items that can be used in Ad Hoc views.

In this release of JasperReports Server, the monitoring fields are limited to those that record report execution events:

Domain Item

Description

Day

Day of the month the report finished running.

Editing Action

The Ad Hoc editing step the user just performed (null for report execution):

•

insertDimensionInAxisWithChild – A dimension was added.

•

addMeasure – A measure was added.

•

setProperty – A property was set.

•

moveDimension – A dimension was moved.

Event Context

The context that triggered the report execution. Possible values are:

•

ui – The report ran interactively from the user interface.

•

web services – The report was run via web services.

•

internal – The report ran from an internal process, usually the scheduler.

Event Type

The type of report that was executed. Possible values are:

•

report execution – A report that ran from the repository.

•

ad hoc editing – A report that ran from an Ad Hoc view being edited.

Hour

Hour the report finished running.

ID number of the monitoring event.

Minute

Minute the report finished running.

Month

Month report finished running.

Query Execution Time

The time spent executing the SQL query in the database.

Report Rendering Time

The time spent rendering the report after receiving the query results (dataset).

Report URI

Repository path of the report that was run.

Time Stamp

Full time and date when the report was finished running, including milliseconds.

Total Report Execution Time

The total time spent running the report. Typically this is a little more than the sum of the query execution and report rendering times, due to overhead. such as loading repository resources (report unit, data source, etc) and obtaining a DB connection from the data source.

User Name

The user who ran the report.

User Organization

The organization of the user who ran the report.

Year

Year the report finished running.

Monitoring Reports and Ad Hoc Views

The monitoring reports and their views are blank by default, because the audit subsystem that monitoring depends on is disabled by default and no audit data exists. To view these reports, first enable auditing as described in section Configuring Auditing and Monitoring, then wait for user activity to generate events.

A number of Ad Hoc views and reports based on the monitoring Domain are provided in the /Public/Monitoring/Monitoring Reports folder.

The reports are designed to cover common monitoring needs and can be used as-is. When monitoring is enabled, audit events are recorded, and the reports contain an up-to-the-minute record of events on your server. You can run the reports or schedule them as needed.

The Ad Hoc views used to create each report are also included. You can open them in the Ad Hoc Editor to explore the monitoring data in real-time. You can also modify these views in the Ad Hoc Editor to generate new reports to suit your monitoring requirements.

The following views and reports are provided:

•

Report Monitoring Resources Report – Gives a list of all reports and shows their average and high-low execution times.

•

Report Monitoring Details Report – A crosstab that shows report execution times on one axis and many dimensions such as a time hierarchy, user and organization, and event type on the other axis.

Sign In