com.espertech.esper.client
Class ConfigurationMetricsReporting

java.lang.Object
  com.espertech.esper.client.ConfigurationMetricsReporting

All Implemented Interfaces:

java.io.Serializable

public class ConfigurationMetricsReporting
extends java.lang.Object
implements java.io.Serializable

Configuratiom for metrics reporting.

See Also:

Serialized Form

Nested Class Summary

static class

ConfigurationMetricsReporting.StmtGroupMetrics Class to configure statement metrics reporting for a group of one or more statements.

Constructor Summary

ConfigurationMetricsReporting()
Ctor.

Method Summary

void	addStmtGroup(java.lang.String name, ConfigurationMetricsReporting.StmtGroupMetrics config) Add a statement group, allowing control of metrics reporting interval per statement or per multiple statements.
long	getEngineInterval() Returns the engine metrics production interval in milliseconds.
java.util.Map<java.lang.String,ConfigurationMetricsReporting.StmtGroupMetrics>	getStatementGroups() Returns a map of statement group and metrics configuration for the statement group.
long	getStatementInterval() Returns the statement metrics production interval in milliseconds, unless statement groups have been defined that override this setting for certain statements.
boolean	isEnableMetricsReporting() Returns true if metrics reporting is turned on, false if not.
boolean	isJmxEngineMetrics() Returns true if the engine registers JMX mbeans, with the platform mbean server, that provide key engine metrics.
boolean	isThreading() Returns true to indicate that metrics reporting takes place in a separate thread (default), or false to indicate that metrics reporting takes place as part of timer processing.
void	setEnableMetricsReporting(boolean enableMetricsReporting) Set to true to turn metrics reporting on, or false to turn metrics reporting off.
void	setEngineInterval(long engineInterval) Sets the engine metrics production interval in milliseconds.
void	setJmxEngineMetrics(boolean jmxEngineMetrics) Set to true to have the the engine register JMX mbeans, with the platform mbean server, that provide key engine metrics.
void	setStatementGroupInterval(java.lang.String stmtGroupName, long newInterval) Sets a new interval for a statement group identified by name.
void	setStatementInterval(long statementInterval) Sets the statement metrics production interval in milliseconds, unless statement groups have been defined that override this setting for certain statements.
void	setThreading(boolean threading) Set to true to indicate that metrics reporting should take place in a separate thread, or false to indicate that metrics reporting takes place as part of timer processing.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationMetricsReporting

public ConfigurationMetricsReporting()

Ctor.

Method Detail

addStmtGroup

public void addStmtGroup(java.lang.String name,
                         ConfigurationMetricsReporting.StmtGroupMetrics config)

Add a statement group, allowing control of metrics reporting interval per statement or per multiple statements. The reporting interval and be changed at runtime.

Add pattern include and exclude criteria to control which

Parameters:

name - of statement group, not connected to statement name, assigned as an arbitrary identifier for runtime changes to the interval

config - the statement group metrics configuration

isEnableMetricsReporting

public boolean isEnableMetricsReporting()

Returns true if metrics reporting is turned on, false if not.

Returns:

indicator whether metrics reporting is turned on

setEnableMetricsReporting

public void setEnableMetricsReporting(boolean enableMetricsReporting)

Set to true to turn metrics reporting on, or false to turn metrics reporting off.

Parameters:

enableMetricsReporting - indicator whether metrics reporting should be turned on

isThreading

public boolean isThreading()

Returns true to indicate that metrics reporting takes place in a separate thread (default), or false to indicate that metrics reporting takes place as part of timer processing.

Returns:

indicator whether metrics reporting is threaded

setThreading

public void setThreading(boolean threading)

Set to true to indicate that metrics reporting should take place in a separate thread, or false to indicate that metrics reporting takes place as part of timer processing.

Parameters:

threading - indicator whether metrics reporting is threaded

getEngineInterval

public long getEngineInterval()

Returns the engine metrics production interval in milliseconds.

Returns:

engine metrics production interval

setEngineInterval

public void setEngineInterval(long engineInterval)

Sets the engine metrics production interval in milliseconds.

Use a negative or zero value to disable engine metrics production.

Parameters:

engineInterval - engine metrics production interval

getStatementInterval

public long getStatementInterval()

Returns the statement metrics production interval in milliseconds, unless statement groups have been defined that override this setting for certain statements.

Returns:

statement metrics production interval

setStatementInterval

public void setStatementInterval(long statementInterval)

Sets the statement metrics production interval in milliseconds, unless statement groups have been defined that override this setting for certain statements.

Parameters:

statementInterval - statement metrics production interval

getStatementGroups

public java.util.Map<java.lang.String,ConfigurationMetricsReporting.StmtGroupMetrics> getStatementGroups()

Returns a map of statement group and metrics configuration for the statement group.

Returns:

map of statement group and metrics configuration

isJmxEngineMetrics

public boolean isJmxEngineMetrics()

Returns true if the engine registers JMX mbeans, with the platform mbean server, that provide key engine metrics.

Returns:

indicator

setJmxEngineMetrics

public void setJmxEngineMetrics(boolean jmxEngineMetrics)

Set to true to have the the engine register JMX mbeans, with the platform mbean server, that provide key engine metrics.

Parameters:

jmxEngineMetrics - indicator whether enabled or not

setStatementGroupInterval

public void setStatementGroupInterval(java.lang.String stmtGroupName,
                                      long newInterval)

Sets a new interval for a statement group identified by name.

Parameters:

stmtGroupName - name of statement group as assigned through configuration

newInterval - new interval, or a -1 or zero value to disable reporting