Coherence 3.4 provides a JMX reporting capability (the Reporter). The Reporter provides out-of-the-box reports that help administrators and developers manage capacity and trouble shoot problems.
 | Plan for archiving and removing
Due to the volume of the information created by the Reporter, you must have a plan for archiving and/or removing the results BEFORE starting the Reporter. |
Basic Configuration
Enabling the Reporter with basic content requires setting the system properties:
On the "management" node:
-Dtangosol.coherence.management.report.autostart=true
-Dtangosol.coherence.management=all
-Dcom.sun.management.jmxremote
On the "managed" node:
-Dtangosol.coherence.management.remote=true
Basic configuration will create a single Reporter node that will log the JMX statistics for all nodes in the cluster. The log files will be placed in the working directory of the application.
Administration
The JMX Reporter is managed through an MBean under the Coherence Domain. The Reporter MBean provides information related to the status and performance of the Reporter. The MBean also provides the capability to start and stop the service as well as run a report on demand.
For a full description of the Reporter Attribute see the Reporter section of the java doc
Data Analysis
Seven files are created each hour by the Reporter. Each file is prefixed with the date and hour the report was executed in a YYYYMMDDHH format. This allows for easy location and purging of unwanted information. The files generated are:
| YYYYMMDDHH-memory-status.txt |
Contains memory and garbage collection information about each node. |
| YYYYMMDDHH-network-health.txt |
Contains the publisher success rates and receiver success rates for the entire grid |
| YYYYMMDDHH-network-health-detail.txt |
Contains the publisher success rates and receiver success rates for each node |
| YYYYMMDDHH-node.txt |
Contains the list of nodes that were members of the grid |
| YYYYMMDDHH-service.txt |
Contains Request and Task information for each service. |
| YYYYMMDDHH-proxy.txt |
Contains utilization information about each proxy node in the grid |
| YYYYMMDDHH-cache-usage.txt |
Contains cache utilization(put, get,etc) statistic for each cache |
Click here for a complete description of the data contained in each file.
Advanced Configuration
Custom Reports
- Create the custom report configuration file.
- Update report batch to execute the report.
- Run on demand.
Distributed Configuration
A distributed configuration is only recommended in situations where grid stability is an issue. In this configuration, the distributed reporters will run independently, and the execution times will not align. Therefore, grid level analysis is extremely difficult but node level analysis during periods when nodes may be leaving or joining the grid will still be available.
When running in distributed mode, each node logs local JMX statistics while allowing for centralized management of the Reporters. To enable this configuration set the following system properties
On the "managing" node:
-Dtangosol.coherence.management.report.autostart=false
-Dtangosol.coherence.management.report.distributed=true
-Dtangosol.coherence.management=all
-Dcom.sun.management.jmxremote
On the "managed" node:
-Dtangosol.coherence.management.report.autostart=true
-Dtangosol.coherence.management.report.distributed=true
-Dtangosol.coherence.management=local-only
-Dtangosol.coherence.management.remote=true
