|
Oracle Fusion Middleware Java API Reference for Oracle Event Processing 11g Release 1 (11.1.1.7) E14303-11 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The Monitor service allows one to monitor the throughput and latency of Event Server application endpoints. An Event Server endpoint is either the entry or the exit point in an application stage. Clients can register at the Monitor service to receive events in the form of a MetricEvent that indicate the throughput and the latency metric of an endpoint as defined by the interval parameter. Even though the monitoring activities are processed separately from the application events, monitoring still adds some overhead to the system, hence it is disabled by default.
Endpoint
, Stage
, MetricEvent
Field Summary | |
static java.lang.String |
CONTROL_STREAM_FILTER |
static java.lang.String |
CONTROL_STREAM_ID |
static java.lang.String |
SERVICE_FILTER |
static java.lang.String |
SERVICE_ID |
static java.lang.String |
STREAM_FILTER |
static java.lang.String |
STREAM_ID |
static java.util.concurrent.TimeUnit |
TIME_UNIT |
Method Summary | |
Endpoint |
createEndpoint(java.lang.String applicationId, java.lang.String stageId, Endpoint.Direction stagepoint) Returns endpoint that represents a 'place' in the Event Server that can be monitored. |
boolean |
isEnabled() Returns if the Monitor service is enabled. |
Statement |
monitorAvgLatency(Endpoint start, Endpoint end, long averageInterval, java.util.concurrent.TimeUnit unit) Starts monitoring the average latency of events between specified end points. |
java.lang.String |
monitorAvgLatency(Endpoint start, Endpoint end, long averageInterval, java.util.concurrent.TimeUnit unit, EventSink listener) Starts monitoring the average latency of events between specified end points. |
Statement |
monitorAvgLatencyThreshold(Endpoint start, Endpoint end, long averageInterval, long threshold, java.util.concurrent.TimeUnit unit) Starts monitoring the average latency of events between specified end points to see if it crosses the specified threshold. |
java.lang.String |
monitorAvgLatencyThreshold(Endpoint start, Endpoint end, long averageInterval, long threshold, java.util.concurrent.TimeUnit unit, EventSink listener) Starts monitoring the average latency of events between specified end points to see if it crosses the specified threshold. |
Statement |
monitorAvgThroughput(Endpoint endpoint, long throughputInterval, long averageInterval, java.util.concurrent.TimeUnit unit) Starts monitoring average throughput of events at the specified endpoint. |
java.lang.String |
monitorAvgThroughput(Endpoint endpoint, long throughputInterval, long averageInterval, java.util.concurrent.TimeUnit unit, EventSink listener) Starts monitoring average throughput of events at the specified endpoint. |
Statement |
monitorMaxLatency(Endpoint start, Endpoint end, long maxInterval, java.util.concurrent.TimeUnit unit) Starts monitoring the maximum latency of events between specified end points. |
java.lang.String |
monitorMaxLatency(Endpoint start, Endpoint end, long averageInterval, java.util.concurrent.TimeUnit unit, EventSink listener) Starts monitoring the maximum latency of events between specified end points. |
void |
setEnabled(boolean enabled) Enables the Monitor service. |
void |
terminateAllMonitoring(Endpoint endpoint) Terminates all monitoring activity for the specified Endpoint. |
Methods inherited from interface com.bea.wlevs.ede.api.EventSink |
onEvent |
Field Detail |
public static final java.util.concurrent.TimeUnit TIME_UNIT
public static final java.lang.String SERVICE_ID
public static final java.lang.String SERVICE_FILTER
public static final java.lang.String STREAM_ID
public static final java.lang.String STREAM_FILTER
public static final java.lang.String CONTROL_STREAM_ID
public static final java.lang.String CONTROL_STREAM_FILTER
Method Detail |
public void setEnabled(boolean enabled)
enabled
- public boolean isEnabled()
public Endpoint createEndpoint(java.lang.String applicationId, java.lang.String stageId, Endpoint.Direction stagepoint)
public Statement monitorAvgThroughput(Endpoint endpoint, long throughputInterval, long averageInterval, java.util.concurrent.TimeUnit unit)
throughputInterval
parameter. Average throughput is calculated by averaging the throughput across averageInterval
parameter. A MetricEvent containing the average throughput is output at the end of every averageInterval.endpoint
- the Endpoint
to be monitoredthroughputInterval
- throughput interval defined in units specified by unit
parameteraverageInterval
- average interval defined in units specified by unit
parameterunit
- time unit for intervals specified by throughputInterval
and averageInterval
parameters. This must be seconds or milliseconds and cannot be less than 100 millisecondspublic java.lang.String monitorAvgThroughput(Endpoint endpoint, long throughputInterval, long averageInterval, java.util.concurrent.TimeUnit unit, EventSink listener)
throughputInterval
parameter. Average throughput is calculated by averaging the throughput across averageInterval
parameter. A MetricEvent containing the average throughput is output at the end of every averageInterval.endpoint
- the Endpoint
to be monitoredthroughputInterval
- throughput interval defined in units specified by unit
parameteraverageInterval
- average interval defined in units specified by unit
parameterunit
- time unit for intervals specified by throughputInterval
and averageInterval
parameters. This must be seconds or milliseconds and cannot be less than 100 millisecondslistener
- (@link com.bea.wlevs.ede.api.EventSink} listener for MetricEvents with average throughput valuespublic Statement monitorAvgLatency(Endpoint start, Endpoint end, long averageInterval, java.util.concurrent.TimeUnit unit)
averageInterval
parameter. A MetricEvent containing the average latency in microseconds is output at the end of every averageInterval.start
- start end-point for latency calculationend
- end end-point for latency calculatinoaverageInterval
- the time interval for average calculation in units specified by unit
parameterunit
- TimeUnit for averageInterval
parameterpublic java.lang.String monitorAvgLatency(Endpoint start, Endpoint end, long averageInterval, java.util.concurrent.TimeUnit unit, EventSink listener)
averageInterval
parameter. A MetricEvent containing the average latency in microseconds is output at the end of every averageInterval.start
- start end-point for latency calculationend
- end end-point for latency calculatinoaverageInterval
- the time interval for average calculation in units specified by unit
parameterunit
- TimeUnit for averageInterval
parameterlistener
- (@link com.bea.wlevs.ede.api.EventSink} listener for MetricEvents with average latency valuespublic Statement monitorAvgLatencyThreshold(Endpoint start, Endpoint end, long averageInterval, long threshold, java.util.concurrent.TimeUnit unit)
averageInterval
parameter. A MetricEvent containing the average latency in microseconds is output at the end of every averageInterval where the average latency crosses the specified threshold.start
- start end-point for latency calculationend
- end end-point for latency calculatinoaverageInterval
- the time interval for average calculation in units specified by unit
parameterthreshold
- latency threshold value in microsecondsunit
- TimeUnit for averageInterval
parameterpublic java.lang.String monitorAvgLatencyThreshold(Endpoint start, Endpoint end, long averageInterval, long threshold, java.util.concurrent.TimeUnit unit, EventSink listener)
averageInterval
parameter. A MetricEvent containing the average latency in microseconds is output at the end of every averageInterval where the average latency crosses the specified threshold.start
- start end-point for latency calculationend
- end end-point for latency calculatinoaverageInterval
- the time interval for average calculation in units specified by unit
parameterthreshold
- latency threshold value in microsecondsunit
- TimeUnit for averageInterval
parameterlistener
- EventSink
listener for MetricEvents that contain the average latency values that cross the thresholdpublic Statement monitorMaxLatency(Endpoint start, Endpoint end, long maxInterval, java.util.concurrent.TimeUnit unit)
maxInterval
parameter. A MetricEvent containing the maximum latency in microseconds is output at the end of every maxInterval.start
- start end-point for latency calculationend
- end end-point for latency calculatinomaxInterval
- the time interval, in units specified by unit
parameter, for which maximum latency is to be calculatedunit
- TimeUnit for maxInterval
parameterpublic java.lang.String monitorMaxLatency(Endpoint start, Endpoint end, long averageInterval, java.util.concurrent.TimeUnit unit, EventSink listener)
maxInterval
parameter. A MetricEvent containing the maximum latency in microseconds is output at the end of every maxInterval.start
- start end-point for latency calculationend
- end end-point for latency calculatinomaxInterval
- the time interval, in units specified by unit
parameter, for which maximum latency is to be calculatedunit
- TimeUnit for maxInterval
parameterlistener
- EventSink
listener for MetricEvents that contain the maximum latency valuespublic void terminateAllMonitoring(Endpoint endpoint)
endpoint
- The Endpoint
for which monitoring activities must be stopped.
|
Copyright © 2007, 2013 Oracle and/or its affiliates. All rights reserved. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |