com.sun.sgs.impl.profile.listener
Class ProfileSummaryListener

java.lang.Object
  com.sun.sgs.impl.profile.listener.ProfileSummaryListener

All Implemented Interfaces:

ProfileListener

public class ProfileSummaryListener
extends Object
implements ProfileListener

A text-output listener that generates task-periodic summary reports about the performance of tasks being executed by a server. Each report summaries a fixed number of tasks. The number of tasks summarized can be modified by setting the com.sun.sgs.profile.listener.window.size property in the system properties. The default number of tasks is 5000.

Each report is structured like the following example:

 past 5000 tasks:
   mean runtime: 1.21ms,  max:    216ms,  failed: 33 (0.17%)
   mean ready count: 1.64,  mean lag time: 0.18ms
   mean tasks running concurrently: 1.05
   mean throughput: 861.46 txn/sec,  mean latency: 1.39 ms/txn
 past 25000 tasks:
   mean runtime: 1.24ms,  failed: 0.99%
   mean ready count: 3.70,  mean lag time: 2.37ms
   mean throughput: 804.74 txn/sec,  mean latency: 3.62 ms/txn
 

Note that the mean runtime, max, mean lag time, mean throughput, and mean latency reports only apply to successful tasks.

Field Summary

Fields inherited from interface com.sun.sgs.profile.ProfileListener

WINDOW_SIZE_PROPERTY

Constructor Summary

ProfileSummaryListener(Properties properties, Identity owner, ComponentRegistry registry)
Creates an instance of ProfileSummaryListener.

Method Summary

void	propertyChange(PropertyChangeEvent event) Notifies this listener of a new change in the system properties.
void	report(ProfileReport profileReport) Reports a completed task that has been run through the scheduler.
void	shutdown() Tells this listener that the system is shutting down.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProfileSummaryListener

public ProfileSummaryListener(Properties properties,
                              Identity owner,
                              ComponentRegistry registry)

Creates an instance of ProfileSummaryListener.

Parameters:

properties - the Properties for this listener

owner - the Identity to use for all tasks run by this listener

registry - the ComponentRegistry containing the available system components

Method Detail

propertyChange

public void propertyChange(PropertyChangeEvent event)

Notifies this listener of a new change in the system properties. This method is called for any property that changes.

The current list of supported property names is as follows:

name	description	new value	old value
com.sun.sgs.profile.newop	a new operation is registered with the system.	the new operation : ProfileOperation	null
com.sun.sgs.profile.threadcount	the number of threads in the system has changed.	the current number of threads : Integer	the previous number of threads : Integer
com.sun.sgs.profile.nodeid	the local node has been assigned a unique identifier	the identifier for the local node: Long	null

Specified by:

propertyChange in interface ProfileListener

Parameters:

event - A PropertyChangeEvent object describing the name of the property, its old and new values and the source of the change.

report

public void report(ProfileReport profileReport)

Reports a completed task that has been run through the scheduler. The task may have completed successfully or may have failed. If a task is re-tried, then this method will be called multiple times for each re-try of the same task. Note that in this case the scheduledStartTime will remain constant but the actualStartTime will change for each re-try of the same task.

Specified by:

report in interface ProfileListener

Parameters:

profileReport - the ProfileReport for the task

shutdown

public void shutdown()

Tells this listener that the system is shutting down.

Specified by:

shutdown in interface ProfileListener