at.spardat.xma.monitoring
Interface IMonitoring


public interface IMonitoring

Interface used by the runtime to report time measurements of RPC executions. To get these measurements into your monitoring system, do the following:

  1. Write a class implementing this interface, that reports the information to your monitoring system
  2. Configure the plugin by adding the following line to the xma-app.xml files of your XMA-applications.
    <plugin-impl implements="at.spardat.xma.monitoring.IMonitoring" implServer="<YourClassName>" />


Method Summary
 void endTiming(java.lang.Object event, boolean success)
          Report the end of a timing.
 void reportValue(java.lang.String varName, int value, boolean success)
          Report the observerd value of a parameter.
 java.lang.Object startTiming(java.lang.String varName)
          Report the start of a timing.
 

Method Detail

startTiming

public java.lang.Object startTiming(java.lang.String varName)
Report the start of a timing.

Parameters:
varName - The name of the variable to observe. The runtime uses names like env<p>:server<listits1m4vm1>:app<listit>:rpcServerEnter
Returns:
a reference to the measurement, that must be passed with endTiming(Object, boolean).

endTiming

public void endTiming(java.lang.Object event,
                      boolean success)
Report the end of a timing. If this method is called more than once for the same event object, only the first call defines the duration and success status. Additional calls for the same event object must be ignored by the monitoring plugin.

Parameters:
event - the object returned by the corresponding call to startTiming(String) of the measurement.
success - The runtime reports if the measured operation completet without errors in this parameter. If the measured operation resulted in an exception false is passed here.

reportValue

public void reportValue(java.lang.String varName,
                        int value,
                        boolean success)
Report the observerd value of a parameter.

Parameters:
varName - The name of the observed variable.
value - The numeric value of the parameter to report.
success - Indicates if the observation should be reported as success or error.