|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Generated(value="com.neeve.adm.AdmGenerator", date="Wed Mar 28 10:54:31 EDT 2018") @AdmGenerated(compatLevel="3.8.0", admVersion="nvx-adm v3.7.265 (build 0)", date="3/28/18 10:54 AM", buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)") public interface ISrvMonIntSeries
Holds raw and histographical data on a series of integer data points.
SrvMonIntSeries reports interval and running histogram data for a series of integer data points. It may also be used to report the captured datapoints, but ecause reporting the raw data is costly both in terms of collection and size/bandwith the captured values are typically not reported. SrvMonIntSeries is frequently used to capture measured latency timings, but can also be used to capture any integer data series.
Method Summary | |
---|---|
void |
addDataPoints(int val)
Adds the provided value to the list of 'dataPoints' values. |
void |
clearDataPoints()
Clears the value of 'dataPoints' Field Description Holds the collected raw data points (when reported). |
void |
clearIntervalStats()
Clears the value of 'intervalStats' Field Description Computed latency statistics for the collection period corresponding to this heartbeat. |
void |
clearLastSequenceNumber()
Clears the value of 'lastSequenceNumber' Field Description The sequence number of the last data point collected or 0 if no data points have been collected. |
void |
clearNumDataPoints()
Clears the value of 'numDataPoints' Field Description The number of data points collected in this interval. |
void |
clearRunningStats()
Clears the value of 'runningStats' Field Description Computed latency statistics over the lifetime of the metric being collected. |
void |
clearSkippedDatapoints()
Clears the value of 'skippedDatapoints' Field Description The number of data points skipped due to undersampling The runtime only holds on to a fixed number of data points for any particular statistic. |
int[] |
getDataPoints()
Gets the value of 'dataPoints' If the field is not set this method will return null . |
int[] |
getDataPointsEmptyIfNull()
Gets the value of 'dataPoints' or an empty array if the value is null or not set. |
XIntIterator |
getDataPointsIterator()
Gets the value of 'dataPoints' as iterator of values. |
SrvMonIntHistogram |
getIntervalStats()
Gets the value of 'intervalStats' Field Description Computed latency statistics for the collection period corresponding to this heartbeat. |
void |
getIntervalStatsTo(SrvMonIntHistogram val)
Copies the value of SrvMonIntHistogram into the provided value. |
long |
getLastSequenceNumber()
Gets the value of 'lastSequenceNumber' Field Description The sequence number of the last data point collected or 0 if no data points have been collected. |
int |
getNumDataPoints()
Gets the value of 'numDataPoints' Field Description The number of data points collected in this interval. |
SrvMonIntHistogram |
getRunningStats()
Gets the value of 'runningStats' Field Description Computed latency statistics over the lifetime of the metric being collected. |
void |
getRunningStatsTo(SrvMonIntHistogram val)
Copies the value of SrvMonIntHistogram into the provided value. |
long |
getSkippedDatapoints()
Gets the value of 'skippedDatapoints' Field Description The number of data points skipped due to undersampling The runtime only holds on to a fixed number of data points for any particular statistic. |
boolean |
hasIntervalStats()
Checks for the presence of 'intervalStats' Field Description Computed latency statistics for the collection period corresponding to this heartbeat. |
boolean |
hasLastSequenceNumber()
Checks for the presence of 'lastSequenceNumber' Field Description The sequence number of the last data point collected or 0 if no data points have been collected. |
boolean |
hasNumDataPoints()
Checks for the presence of 'numDataPoints' Field Description The number of data points collected in this interval. |
boolean |
hasRunningStats()
Checks for the presence of 'runningStats' Field Description Computed latency statistics over the lifetime of the metric being collected. |
boolean |
hasSkippedDatapoints()
Checks for the presence of 'skippedDatapoints' Field Description The number of data points skipped due to undersampling The runtime only holds on to a fixed number of data points for any particular statistic. |
void |
lendIntervalStats(SrvMonIntHistogram val)
'Lends' a reference of the SrvMonIntHistogram to the message for this field. |
void |
lendRunningStats(SrvMonIntHistogram val)
'Lends' a reference of the SrvMonIntHistogram to the message for this field. |
void |
setDataPoints(int[] val)
Sets the value of 'dataPoints' Field Description Holds the collected raw data points (when reported). |
void |
setDataPointsFrom(XIntIterator val)
Sets the value of 'dataPoints' using the values from the provided iterator. |
void |
setIntervalStats(SrvMonIntHistogram val)
Sets the value of 'intervalStats' Field Description Computed latency statistics for the collection period corresponding to this heartbeat. |
void |
setLastSequenceNumber(long val)
Sets the value of 'lastSequenceNumber' Field Description The sequence number of the last data point collected or 0 if no data points have been collected. |
void |
setNumDataPoints(int val)
Sets the value of 'numDataPoints' Field Description The number of data points collected in this interval. |
void |
setRunningStats(SrvMonIntHistogram val)
Sets the value of 'runningStats' Field Description Computed latency statistics over the lifetime of the metric being collected. |
void |
setSkippedDatapoints(long val)
Sets the value of 'skippedDatapoints' Field Description The number of data points skipped due to undersampling The runtime only holds on to a fixed number of data points for any particular statistic. |
SrvMonIntHistogram |
takeIntervalStats()
'Takes' a reference to the intervalStats field from the message. |
SrvMonIntHistogram |
takeRunningStats()
'Takes' a reference to the runningStats field from the message. |
Methods inherited from interface com.neeve.rog.IRogValidatable |
---|
getValidationErrors, isValid |
Method Detail |
---|
void setLastSequenceNumber(long val)
Sequence numbers for collected data points start at 1, a value of 0 indicates that no data points have been collected. The Sequence Number always indicates the number or data points that have been collected since the statistic has been created or was last reset. If the statistic is reset then this value will reset to 0, when
val
- The value to set.long getLastSequenceNumber()
Sequence numbers for collected data points start at 1, a value of 0 indicates that no data points have been collected. The Sequence Number always indicates the number or data points that have been collected since the statistic has been created or was last reset. If the statistic is reset then this value will reset to 0, when
void clearLastSequenceNumber()
Sequence numbers for collected data points start at 1, a value of 0 indicates that no data points have been collected. The Sequence Number always indicates the number or data points that have been collected since the statistic has been created or was last reset. If the statistic is reset then this value will reset to 0, when
setLastSequenceNumber(long)
boolean hasLastSequenceNumber()
Sequence numbers for collected data points start at 1, a value of 0 indicates that no data points have been collected. The Sequence Number always indicates the number or data points that have been collected since the statistic has been created or was last reset. If the statistic is reset then this value will reset to 0, when
getLastSequenceNumber()
void setNumDataPoints(int val)
Indicates the number of data points collected in this interval. If no data points were collected numDataPoints will be 0. The sequence number of the first value collected in this interval can be determined by subtracting numDataPoints from lastSequenceNumber. This can be used to determine if two consecutive datapoints have skipped data points due to under sampling or a missing heartbeat.
val
- The value to set.int getNumDataPoints()
Indicates the number of data points collected in this interval. If no data points were collected numDataPoints will be 0. The sequence number of the first value collected in this interval can be determined by subtracting numDataPoints from lastSequenceNumber. This can be used to determine if two consecutive datapoints have skipped data points due to under sampling or a missing heartbeat.
void clearNumDataPoints()
Indicates the number of data points collected in this interval. If no data points were collected numDataPoints will be 0. The sequence number of the first value collected in this interval can be determined by subtracting numDataPoints from lastSequenceNumber. This can be used to determine if two consecutive datapoints have skipped data points due to under sampling or a missing heartbeat.
setNumDataPoints(int)
boolean hasNumDataPoints()
Indicates the number of data points collected in this interval. If no data points were collected numDataPoints will be 0. The sequence number of the first value collected in this interval can be determined by subtracting numDataPoints from lastSequenceNumber. This can be used to determine if two consecutive datapoints have skipped data points due to under sampling or a missing heartbeat.
getNumDataPoints()
void setSkippedDatapoints(long val)
The runtime only holds on to a fixed number of data points for any particular statistic. If the sampling interval is too high then some datapoints may be skipped. For example let's say Latency stats are configured to hold on to a sample size of 1000 datapoints. If the number of data points being captured per second is 2000, and the stats collection interval is 1 second then on each collection, 1000 datapoints will be missed which will skew results. The skipped data points counter thus indicates how many datapoints have been missed in the reported runningStats. And if the count grows over two successive heartbeats indicates that the values the intervalStats don't reflect all the activity since the last interval. The skipped data points counter is a running counter ... it tracks the total number of data points that have been skipped since the underlying statistic was last reset.
val
- The value to set.long getSkippedDatapoints()
The runtime only holds on to a fixed number of data points for any particular statistic. If the sampling interval is too high then some datapoints may be skipped. For example let's say Latency stats are configured to hold on to a sample size of 1000 datapoints. If the number of data points being captured per second is 2000, and the stats collection interval is 1 second then on each collection, 1000 datapoints will be missed which will skew results. The skipped data points counter thus indicates how many datapoints have been missed in the reported runningStats. And if the count grows over two successive heartbeats indicates that the values the intervalStats don't reflect all the activity since the last interval. The skipped data points counter is a running counter ... it tracks the total number of data points that have been skipped since the underlying statistic was last reset.
void clearSkippedDatapoints()
The runtime only holds on to a fixed number of data points for any particular statistic. If the sampling interval is too high then some datapoints may be skipped. For example let's say Latency stats are configured to hold on to a sample size of 1000 datapoints. If the number of data points being captured per second is 2000, and the stats collection interval is 1 second then on each collection, 1000 datapoints will be missed which will skew results. The skipped data points counter thus indicates how many datapoints have been missed in the reported runningStats. And if the count grows over two successive heartbeats indicates that the values the intervalStats don't reflect all the activity since the last interval. The skipped data points counter is a running counter ... it tracks the total number of data points that have been skipped since the underlying statistic was last reset.
setSkippedDatapoints(long)
boolean hasSkippedDatapoints()
The runtime only holds on to a fixed number of data points for any particular statistic. If the sampling interval is too high then some datapoints may be skipped. For example let's say Latency stats are configured to hold on to a sample size of 1000 datapoints. If the number of data points being captured per second is 2000, and the stats collection interval is 1 second then on each collection, 1000 datapoints will be missed which will skew results. The skipped data points counter thus indicates how many datapoints have been missed in the reported runningStats. And if the count grows over two successive heartbeats indicates that the values the intervalStats don't reflect all the activity since the last interval. The skipped data points counter is a running counter ... it tracks the total number of data points that have been skipped since the underlying statistic was last reset.
getSkippedDatapoints()
void setDataPoints(int[] val)
When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
val
- The value to set.void setDataPointsFrom(XIntIterator val)
This method will call XIntIterator.toFirst()
before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'dataPoints' accessor can copy the values without iteration.
When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
NOTE:
Passing a null
or empty iterator has the same affect as calling setDataPoints(int[])
with
a value of null
.
val
- the values to set.void addDataPoints(int val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'dataPoints' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
val
- the value to add.XIntIterator getDataPointsIterator()
This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(com.neeve.lang.XIntIterator)
method
can perform a direct copy of the underlying values without iteration.
When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
int[] getDataPoints()
If the field is not set this method will return null
.
When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
null
.int[] getDataPointsEmptyIfNull()
null
or not set.
When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
null
if not set.getDataPoints()
void clearDataPoints()
When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
setDataPoints(int[])
void setIntervalStats(SrvMonIntHistogram val)
Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.
val
- The value to set.void lendIntervalStats(SrvMonIntHistogram val)
Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.
NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
val
- the value to 'lend' to lend.SrvMonIntHistogram getIntervalStats()
Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.
void getIntervalStatsTo(SrvMonIntHistogram val)
IF the value is not set, then the contents of the provided SrvMonIntHistogram are cleared.
val
- the value to copy intoSrvMonIntHistogram.copyInto(SrvMonIntHistogram)
SrvMonIntHistogram takeIntervalStats()
Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.
NOTE:
A nested entity reference returned by getXXX() is only valid until the entity is disposed
i.e. the act of getting an entity does not transfer ownership of the entity to the application
A message disposes of its reference to its contained entities when it is disposed itself.
An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
null
if the field is not set.boolean hasIntervalStats()
Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.
getIntervalStats()
void clearIntervalStats()
Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.
setIntervalStats(SrvMonIntHistogram)
void setRunningStats(SrvMonIntHistogram val)
Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.
val
- The value to set.void lendRunningStats(SrvMonIntHistogram val)
Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.
NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
val
- the value to 'lend' to lend.SrvMonIntHistogram getRunningStats()
Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.
void getRunningStatsTo(SrvMonIntHistogram val)
IF the value is not set, then the contents of the provided SrvMonIntHistogram are cleared.
val
- the value to copy intoSrvMonIntHistogram.copyInto(SrvMonIntHistogram)
SrvMonIntHistogram takeRunningStats()
Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.
NOTE:
A nested entity reference returned by getXXX() is only valid until the entity is disposed
i.e. the act of getting an entity does not transfer ownership of the entity to the application
A message disposes of its reference to its contained entities when it is disposed itself.
An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
null
if the field is not set.boolean hasRunningStats()
Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.
getRunningStats()
void clearRunningStats()
Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.
setRunningStats(SrvMonIntHistogram)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |