kieker.analysis.plugin.filter.record
Class MonitoringThroughputFilter

java.lang.Object
  kieker.analysis.analysisComponent.AbstractAnalysisComponent
      kieker.analysis.plugin.AbstractPlugin
          kieker.analysis.plugin.filter.AbstractFilterPlugin
              kieker.analysis.plugin.filter.record.MonitoringThroughputFilter

All Implemented Interfaces:

IAnalysisComponent, IFilterPlugin, IPlugin

public class MonitoringThroughputFilter
extends AbstractFilterPlugin

An instance of this class computes the throughput in terms of the number of records logged within the monitoring instance per time unit.

Since:

1.8

Author:

Andre van Hoorn, Jan Waller

Nested Class Summary

Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin

IPlugin.PluginInputPortReference, IPlugin.STATE

Field Summary

static String	CONFIG_PROPERTY_NAME_INTERVAL_SIZE The name of the property determining the interval size.
static String	CONFIG_PROPERTY_NAME_TIMEUNIT The name of the property determining the time unit.
static String	CONFIG_PROPERTY_VALUE_INTERVAL_SIZE_ONE_SECOND The configuration property value for CONFIG_PROPERTY_NAME_INTERVAL_SIZE, leading to a bin size of 1 second.
static String	CONFIG_PROPERTY_VALUE_TIMEUNIT The default value of the time unit property (nanoseconds).
static String	INPUT_PORT_NAME_RECORDS The name of the input port receiving other objects.
static String	OUTPUT_PORT_NAME_RELAYED_RECORDS The name of the output port delivering the received objects.
static String	OUTPUT_PORT_NAME_THROUGHPUT The name of the output port delivering calculated throughput.
static String	OUTPUT_PORT_NAME_UNCOUNTED_RECORDS The name of the output port delivering the uncounted objects.

Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

CONFIG_NAME

Constructor Summary

MonitoringThroughputFilter(Configuration configuration, IProjectContext projectContext)

Method Summary

Configuration	getCurrentConfiguration() This method should deliver a Configuration object containing the current configuration of this instance.
void	inputRecord(IMonitoringRecord record)

Methods inherited from class kieker.analysis.plugin.filter.AbstractFilterPlugin

init, terminate

Methods inherited from class kieker.analysis.plugin.AbstractPlugin

areAllRepositoryPortsConnected, connect, connect, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getIncomingPlugins, getPluginDescription, getPluginName, getState, isConnectionAllowed, shutdown, start

Methods inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface kieker.analysis.plugin.IPlugin

connect, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getName, getPluginDescription, getPluginName, getState

Field Detail

INPUT_PORT_NAME_RECORDS

public static final String INPUT_PORT_NAME_RECORDS

The name of the input port receiving other objects.

See Also:

Constant Field Values

OUTPUT_PORT_NAME_RELAYED_RECORDS

public static final String OUTPUT_PORT_NAME_RELAYED_RECORDS

The name of the output port delivering the received objects.

See Also:

Constant Field Values

OUTPUT_PORT_NAME_UNCOUNTED_RECORDS

public static final String OUTPUT_PORT_NAME_UNCOUNTED_RECORDS

The name of the output port delivering the uncounted objects.

See Also:

Constant Field Values

OUTPUT_PORT_NAME_THROUGHPUT

public static final String OUTPUT_PORT_NAME_THROUGHPUT

The name of the output port delivering calculated throughput.

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_TIMEUNIT

public static final String CONFIG_PROPERTY_NAME_TIMEUNIT

The name of the property determining the time unit.

See Also:

Constant Field Values

CONFIG_PROPERTY_VALUE_TIMEUNIT

public static final String CONFIG_PROPERTY_VALUE_TIMEUNIT

The default value of the time unit property (nanoseconds).

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_INTERVAL_SIZE

public static final String CONFIG_PROPERTY_NAME_INTERVAL_SIZE

The name of the property determining the interval size.

See Also:

Constant Field Values

CONFIG_PROPERTY_VALUE_INTERVAL_SIZE_ONE_SECOND

public static final String CONFIG_PROPERTY_VALUE_INTERVAL_SIZE_ONE_SECOND

The configuration property value for CONFIG_PROPERTY_NAME_INTERVAL_SIZE, leading to a bin size of 1 second.

See Also:

Constant Field Values

Constructor Detail

MonitoringThroughputFilter

public MonitoringThroughputFilter(Configuration configuration,
                                  IProjectContext projectContext)

Method Detail

getCurrentConfiguration

public Configuration getCurrentConfiguration()

Description copied from class: AbstractAnalysisComponent

This method should deliver a Configuration object containing the current configuration of this instance. In other words: The constructor should be able to use the given object to initialize a new instance of this class with the same intern properties.

Specified by:

getCurrentConfiguration in interface IAnalysisComponent

Specified by:

getCurrentConfiguration in interface IPlugin

Specified by:

getCurrentConfiguration in class AbstractAnalysisComponent

Returns:

A completely filled configuration object.

inputRecord

public final void inputRecord(IMonitoringRecord record)