@Generated(value="com.neeve.protobuf.adm.ProtobufAdmNodeGenerator", date="Tue Sep 16 04:36:05 UTC 2025") @AdmGenerated(encoding="xbuf", compatLevel="5.0.0", admVersion="Unknown Version", date="9/16/25 4:36 AM", buildInfo="nvx-rumi-server-4.0.595 (Rumi ADM Maven Plugin)") @AdmFactoryInfo(factoryClass=SrvMonHeartbeatFactory.class, vfid=32, ofid=32, typeId=228) public final class SrvMonLongSeries extends Object implements ISrvMonLongSeries, MessageReflector, com.neeve.query.impl.index.IdxMappable, UtlPool.Item<SrvMonLongSeries>, AdmRuntime.BufferSizer
SrvMonLongSeries reports interval and running histogram data for a series of long data points. It may also be used to report the captured datapoints, but because reporting the raw data is costly both in terms of collection and size/bandwidth the captured values are typically not reported. SrvMonLongSeries is frequently used to capture measured latency timings, but can also be used to capture any long data series.
| ADM Type | Embedded Entity |
| Factory | SrvMonHeartbeatFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| dataPoints | Long[] | 16 |
Holds the collected raw data points (when reported).
When the XVM 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 dictated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored. |
| intervalStats | SrvMonLongHistogram |
19 |
Computed latency statistics for the collection period corresponding to this heartbeat.
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 XVM. |
| lastSequenceNumber | Long | 17 |
The sequence number of the last data point collected or 0 if no data points have been collected.
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 |
| numDataPoints | Integer | 18 |
The number of data points collected in this interval.
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. |
| runningStats | SrvMonLongHistogram |
20 |
Computed latency statistics over the lifetime of the metric being collected.
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. |
| skippedDatapoints | Long | 21 |
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. 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. |
| Modifier and Type | Class and Description |
|---|---|
static class |
SrvMonLongSeries.Deserializer
The deserializer
|
static class |
SrvMonLongSeries.PacketBody
The backing packet type for SrvMonLongSeries (used internally for serialization purposes).
|
static class |
SrvMonLongSeries.Pojo
The POJO
|
static class |
SrvMonLongSeries.Serializer
The serializer
|
| Modifier and Type | Field and Description |
|---|---|
static SrvMonLongSeries[] |
EMPTY_ARRAY |
| Modifier and Type | Method and Description |
|---|---|
SrvMonLongSeries |
acquire() |
void |
addDataPoints(long val)
Adds the provided value to the list of 'dataPoints' values.
|
boolean |
appendFieldValueTo(Object node,
String[] pathComponents,
XString target)
Appends a reflected field value as a string into the given XString.
|
boolean |
appendFieldValueTo(Object message,
String name,
XString target)
Appends a reflected field value as a string into the given XString.
|
void |
clear() |
void |
clear(boolean disposeMembers) |
void |
clearContent()
Deprecated.
|
void |
clearDataPoints()
Clears the value of 'dataPoints'.
|
void |
clearIntervalStats()
Clears the value of 'intervalStats'.
|
void |
clearLastSequenceNumber()
Clears the value of 'lastSequenceNumber'.
|
void |
clearNumDataPoints()
Clears the value of 'numDataPoints'.
|
void |
clearRunningStats()
Clears the value of 'runningStats'.
|
void |
clearSkippedDatapoints()
Clears the value of 'skippedDatapoints'.
|
Object |
clone()
Creates a clone of this object.
|
SrvMonLongSeries |
copy() |
void |
copyInto(SrvMonLongSeries copy) |
static SrvMonLongSeries |
create() |
SrvMonLongSeries |
deserializeFrom(byte[] array,
int offset,
int len) |
SrvMonLongSeries |
deserializeFrom(ByteBuffer buffer) |
SrvMonLongSeries |
deserializeFrom(IOBuffer buffer,
int offset,
int len) |
SrvMonLongSeries |
deserializeFrom(IOElasticBuffer buffer,
int offset,
int len) |
SrvMonLongSeries |
deserializeFrom(long addr,
int offset,
int len) |
SrvMonLongSeries |
deserializeFrom(PktPacket packet) |
SrvMonLongSeries |
deserializeFrom(SrvMonLongSeries.Deserializer deserializer) |
SrvMonLongSeries |
deserializeFrom(SrvMonLongSeries val) |
SrvMonLongSeries |
deserializeFromByteArray(byte[] array) |
SrvMonLongSeries |
deserializeFromByteBuffer(ByteBuffer buffer) |
SrvMonLongSeries |
deserializeFromJson(String json) |
SrvMonLongSeries |
deserializeFromNative(long addr,
int offset,
int len)
Deprecated.
|
SrvMonLongSeries |
deserializeFromPacket(PktPacket packet) |
SrvMonLongSeries |
deserializeFromRawJson(String json) |
SrvMonLongSeries.Deserializer |
deserializer() |
SrvMonLongSeries.Deserializer |
deserializer(boolean createBuffer) |
void |
dispose() |
void |
disposeDeserializer() |
void |
disposePojo() |
void |
disposePojo(boolean sync) |
void |
disposeSerializedBuffer() |
void |
disposeSerializedBuffer(boolean gcDisposed) |
void |
disposeSerializer() |
long |
ensureCapacity(long addr,
int capacity)
Method invoked by the serializer to ensure there is enough space in the target
buffer to accommodate a field being serialized
|
boolean |
fieldExists(Object message,
String name)
Check if a field of the supplied name exists in a message.
|
long[] |
getDataPoints()
Gets the value of 'dataPoints'.
|
long |
getDataPointsAt(int index)
Gets the element at a specific index in 'dataPoints'.
|
int |
getDataPointsCount()
Gets the number of elements in 'dataPoints'.
|
long[] |
getDataPointsEmptyIfNull()
Gets the value of 'dataPoints' or an empty array if the value is
null or not set. |
static int |
getDataPointsFieldId() |
XLongIterator |
getDataPointsIterator()
Gets the value of 'dataPoints' as iterator of values.
|
static <T> IRogFieldReflector<SrvMonLongSeries,T> |
getFieldReflector(String name)
Get a field reflector.
|
static <T> IRogFieldReflector<SrvMonLongSeries,T> |
getFieldReflector(String[] pathComponents)
Get a field reflector.
|
XString |
getFieldValueAsRawString(Object message,
String name)
Get the value of a reflectable field in a message as a string.
|
XString |
getFieldValueAsRawString(Object message,
String[] pathComponents)
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String name)
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String[] pathComponents)
Get the value of a reflectable field in a message as a string.
|
SrvMonLongHistogram |
getIntervalStats()
Gets the value of 'intervalStats'.
|
static int |
getIntervalStatsFieldId() |
void |
getIntervalStatsTo(SrvMonLongHistogram to)
Copies the value of SrvMonLongHistogram into the provided value.
|
long |
getLastSequenceNumber()
Gets the value of 'lastSequenceNumber'.
|
Long |
getLastSequenceNumberAsObject()
Gets the value of 'lastSequenceNumber'.
|
static int |
getLastSequenceNumberFieldId() |
int |
getNumDataPoints()
Gets the value of 'numDataPoints'.
|
Integer |
getNumDataPointsAsObject()
Gets the value of 'numDataPoints'.
|
static int |
getNumDataPointsFieldId() |
int |
getOwnershipCount() |
UtlPool<SrvMonLongSeries> |
getPool()
Get a pool item's pool.
|
Object |
getQueryFieldValue(String name)
Gets an indexable value identified by a key.
|
SrvMonLongHistogram |
getRunningStats()
Gets the value of 'runningStats'.
|
static int |
getRunningStatsFieldId() |
void |
getRunningStatsTo(SrvMonLongHistogram to)
Copies the value of SrvMonLongHistogram into the provided value.
|
long |
getSerializedBuffer() |
int |
getSerializedBufferCapacity() |
int |
getSerializedBufferLength() |
int |
getSerializeToNativeLength()
Deprecated.
|
long |
getSkippedDatapoints()
Gets the value of 'skippedDatapoints'.
|
Long |
getSkippedDatapointsAsObject()
Gets the value of 'skippedDatapoints'.
|
static int |
getSkippedDatapointsFieldId() |
void |
getValidationErrors(List<XString> results,
String errorPrefix)
Collects validation errors into the provided list.
|
boolean |
hasDirtyPojo() |
boolean |
hasIntervalStats()
Checks for the presence of 'intervalStats'.
|
boolean |
hasLastSequenceNumber()
Checks for the presence of 'lastSequenceNumber'.
|
boolean |
hasNumDataPoints()
Checks for the presence of 'numDataPoints'.
|
boolean |
hasPojo() |
boolean |
hasRunningStats()
Checks for the presence of 'runningStats'.
|
boolean |
hasSerializedBuffer() |
boolean |
hasSkippedDatapoints()
Checks for the presence of 'skippedDatapoints'.
|
SrvMonLongSeries |
init()
Initialize an item.
|
boolean |
isFieldReflectable(Object message,
String name)
Check if a field of the supplied name is reflectable.
|
boolean |
isValid()
Tests if this object has any validation errors.
|
void |
lendIntervalStats(SrvMonLongHistogram val)
'Lends' a reference of the SrvMonLongHistogram to the message for this field.
|
void |
lendRunningStats(SrvMonLongHistogram val)
'Lends' a reference of the SrvMonLongHistogram to the message for this field.
|
boolean |
needsSync()
Check if a view needs to be sync'd for reflection.
|
SrvMonLongSeries.Pojo |
pojo() |
SrvMonLongSeries.Pojo |
pojo(boolean onlyPojos) |
void |
reset() |
void |
reset(boolean disposeMembers) |
SrvMonLongSeries.Serializer |
serializer() |
SrvMonLongSeries.Serializer |
serializer(int minimumLength) |
SrvMonLongSeries.Serializer |
serializer(int length,
boolean autoResizeTargetBuffer) |
int |
serializeTo(byte[] array,
int offset) |
int |
serializeTo(ByteBuffer buffer) |
int |
serializeTo(IOBuffer buffer,
int offset) |
int |
serializeTo(IOElasticBuffer buffer,
int offset) |
int |
serializeTo(long addr,
int offset) |
int |
serializeTo(PktPacket packet) |
int |
serializeTo(SrvMonLongSeries.Serializer serializer) |
byte[] |
serializeToByteArray() |
ByteBuffer |
serializeToByteBuffer() |
IOBuffer |
serializeToIOBuffer(boolean useNative) |
String |
serializeToJson() |
int |
serializeToNative(long addr,
int offset)
Deprecated.
|
PktPacket |
serializeToPacket() |
String |
serializeToRawJson() |
void |
setAsReadOnly() |
void |
setDataPoints(long[] val)
Sets the value of 'dataPoints'.
|
void |
setDataPointsFrom(XLongIterator val)
Sets the value of 'dataPoints' using the values from the provided iterator.
|
void |
setIntervalStats(SrvMonLongHistogram val)
Sets the value of 'intervalStats'.
|
void |
setLastSequenceNumber(long val)
Sets the value of 'lastSequenceNumber'.
|
void |
setNumDataPoints(int val)
Sets the value of 'numDataPoints'.
|
SrvMonLongSeries |
setPool(UtlPool<SrvMonLongSeries> pool)
Set a pool item's pool.
|
void |
setRunningStats(SrvMonLongHistogram val)
Sets the value of 'runningStats'.
|
void |
setSkippedDatapoints(long val)
Sets the value of 'skippedDatapoints'.
|
void |
sync() |
SrvMonLongHistogram |
takeIntervalStats()
'Takes' a reference to the intervalStats field from the message.
|
SrvMonLongHistogram |
takeRunningStats()
'Takes' a reference to the runningStats field from the message.
|
String |
toString() |
SrvMonLongSeries |
wrap(IOBuffer buffer,
int len) |
public static final SrvMonLongSeries[] EMPTY_ARRAY
public static SrvMonLongSeries create()
public final boolean hasSerializedBuffer()
public final long getSerializedBuffer()
public final int getSerializedBufferCapacity()
public final int getSerializedBufferLength()
@Deprecated public final int getSerializeToNativeLength()
public final SrvMonLongSeries.Serializer serializer(int length, boolean autoResizeTargetBuffer)
public final SrvMonLongSeries.Serializer serializer(int minimumLength)
public final SrvMonLongSeries.Serializer serializer()
public final long ensureCapacity(long addr,
int capacity)
AdmRuntime.BufferSizerensureCapacity in interface AdmRuntime.BufferSizeraddr - The native address of the target buffercapacity - The required capacity of the bufferThis method is invoked by a serializer each time it serializes a field or part of a field to the target buffer to ensure that the target buffer has the desired capacity to hold the data being added.
public final SrvMonLongSeries.Deserializer deserializer(boolean createBuffer)
public final SrvMonLongSeries.Deserializer deserializer()
public final boolean hasPojo()
public final boolean hasDirtyPojo()
public final SrvMonLongSeries.Pojo pojo(boolean onlyPojos)
public final SrvMonLongSeries.Pojo pojo()
public final void disposeSerializedBuffer(boolean gcDisposed)
public final void disposeSerializedBuffer()
public final void disposeSerializer()
public final void disposeDeserializer()
public final void disposePojo(boolean sync)
public final void disposePojo()
public final void clear(boolean disposeMembers)
public final void clear()
@Deprecated public final void clearContent()
public final void reset(boolean disposeMembers)
public final void reset()
public final String serializeToRawJson()
public final int serializeTo(SrvMonLongSeries.Serializer serializer)
public final void sync()
public final byte[] serializeToByteArray()
public final int serializeTo(byte[] array,
int offset)
public final ByteBuffer serializeToByteBuffer()
public final int serializeTo(ByteBuffer buffer)
public final IOBuffer serializeToIOBuffer(boolean useNative)
public final int serializeTo(IOBuffer buffer, int offset)
public final int serializeTo(IOElasticBuffer buffer, int offset)
public final PktPacket serializeToPacket()
public final int serializeTo(PktPacket packet)
public final int serializeTo(long addr,
int offset)
@Deprecated public final int serializeToNative(long addr, int offset)
public final String serializeToJson()
public final SrvMonLongSeries deserializeFromRawJson(String json)
public final SrvMonLongSeries deserializeFrom(SrvMonLongSeries.Deserializer deserializer)
public final SrvMonLongSeries deserializeFrom(SrvMonLongSeries val)
public final SrvMonLongSeries wrap(IOBuffer buffer, int len)
public final SrvMonLongSeries deserializeFromByteArray(byte[] array)
public final SrvMonLongSeries deserializeFrom(byte[] array, int offset, int len)
public final SrvMonLongSeries deserializeFromByteBuffer(ByteBuffer buffer)
public final SrvMonLongSeries deserializeFrom(ByteBuffer buffer)
public final SrvMonLongSeries deserializeFrom(IOBuffer buffer, int offset, int len)
public final SrvMonLongSeries deserializeFrom(IOElasticBuffer buffer, int offset, int len)
public final SrvMonLongSeries deserializeFromPacket(PktPacket packet)
public final SrvMonLongSeries deserializeFrom(PktPacket packet)
public final SrvMonLongSeries deserializeFrom(long addr, int offset, int len)
@Deprecated public final SrvMonLongSeries deserializeFromNative(long addr, int offset, int len)
public final SrvMonLongSeries deserializeFromJson(String json)
public final void copyInto(SrvMonLongSeries copy)
public final SrvMonLongSeries copy()
public boolean needsSync()
MessageReflectorneedsSync in interface MessageReflectorpublic final boolean fieldExists(Object message, String name)
MessageReflectorfieldExists in interface MessageReflectormessage - The message to check in.name - The field to check for.public final boolean isFieldReflectable(Object message, String name)
MessageReflectorisFieldReflectable in interface MessageReflectormessage - The message to check in.name - The field to check for.public final String getFieldValueAsString(Object message, String name)
MessageReflector
Note that this method is generally less efficient than its variant
MessageReflector.getFieldValueAsString(Object, String[]) since this method requires
splitting the supplied path name into its dot separated path components. In cases
where the caller intends to reuse the same path name often, it is better
for the caller to supply it in split form.
getFieldValueAsString in interface MessageReflectormessage - The message to introspect.name - The field whose value is to be retrieved specified as a bean pathMessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final String getFieldValueAsString(Object message, String[] pathComponents)
MessageReflectorgetFieldValueAsString in interface MessageReflectormessage - The message to introspect.pathComponents - The path components to use to access the field.MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final XString getFieldValueAsRawString(Object message, String name)
MessageReflector
Note that this method is generally less efficient than its variant
MessageReflector.getFieldValueAsString(Object, String[]) since this method requires
splitting the supplied path name into its dot separated path components. In cases
where the caller intends to reuse the same path name often, it is better
for the caller to supply it in split form.
getFieldValueAsRawString in interface MessageReflectormessage - The message to introspect.name - The field whose value is to be retrieved specified as a bean pathMessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final XString getFieldValueAsRawString(Object message, String[] pathComponents)
MessageReflectorgetFieldValueAsRawString in interface MessageReflectormessage - The message to introspect.pathComponents - The path components to use to access the field.MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final boolean appendFieldValueTo(Object message, String name, XString target)
MessageReflectorIf the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.
appendFieldValueTo in interface MessageReflectormessage - the node on which to reflect (which need not be this object).name - the bean path to the field.target - The target XString into which to append the result.public final boolean appendFieldValueTo(Object node, String[] pathComponents, XString target)
MessageReflectorIf the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.
appendFieldValueTo in interface MessageReflectornode - the node on which to reflect (which need not be this object).pathComponents - the bean path to the field on the provided object split by its '.' separated components.target - The target XString into which to append the result.public final void setAsReadOnly()
public static final int getLastSequenceNumberFieldId()
public final void setLastSequenceNumber(long val)
ISrvMonLongSeriesSequence 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 in interface ISrvMonLongSeriesval - The value to set.public final long getLastSequenceNumber()
ISrvMonLongSeriesSequence 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 in interface ISrvMonLongSeriespublic final Long getLastSequenceNumberAsObject()
ISrvMonLongSeriesSequence 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
getLastSequenceNumberAsObject in interface ISrvMonLongSeriespublic final boolean hasLastSequenceNumber()
ISrvMonLongSeriesSequence 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
hasLastSequenceNumber in interface ISrvMonLongSeriesISrvMonLongSeries.getLastSequenceNumber()public final void clearLastSequenceNumber()
ISrvMonLongSeriesSequence 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
clearLastSequenceNumber in interface ISrvMonLongSeriesISrvMonLongSeries.setLastSequenceNumber(long)public static final int getNumDataPointsFieldId()
public final void setNumDataPoints(int val)
ISrvMonLongSeriesIndicates 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 in interface ISrvMonLongSeriesval - The value to set.public final int getNumDataPoints()
ISrvMonLongSeriesIndicates 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 in interface ISrvMonLongSeriespublic final Integer getNumDataPointsAsObject()
ISrvMonLongSeriesIndicates 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.
getNumDataPointsAsObject in interface ISrvMonLongSeriespublic final boolean hasNumDataPoints()
ISrvMonLongSeriesIndicates 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.
hasNumDataPoints in interface ISrvMonLongSeriesISrvMonLongSeries.getNumDataPoints()public final void clearNumDataPoints()
ISrvMonLongSeriesIndicates 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.
clearNumDataPoints in interface ISrvMonLongSeriesISrvMonLongSeries.setNumDataPoints(int)public static final int getSkippedDatapointsFieldId()
public final void setSkippedDatapoints(long val)
ISrvMonLongSeriesThe 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 in interface ISrvMonLongSeriesval - The value to set.public final long getSkippedDatapoints()
ISrvMonLongSeriesThe 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 in interface ISrvMonLongSeriespublic final Long getSkippedDatapointsAsObject()
ISrvMonLongSeriesThe 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.
getSkippedDatapointsAsObject in interface ISrvMonLongSeriespublic final boolean hasSkippedDatapoints()
ISrvMonLongSeriesThe 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.
hasSkippedDatapoints in interface ISrvMonLongSeriesISrvMonLongSeries.getSkippedDatapoints()public final void clearSkippedDatapoints()
ISrvMonLongSeriesThe 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.
clearSkippedDatapoints in interface ISrvMonLongSeriesISrvMonLongSeries.setSkippedDatapoints(long)public static final int getDataPointsFieldId()
public final void setDataPoints(long[] val)
ISrvMonLongSeriesWhen the XVM 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 dictated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
setDataPoints in interface ISrvMonLongSeriesval - The value to set.public final void setDataPointsFrom(XLongIterator val)
ISrvMonLongSeries
This method will call XLongIterator.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 XVM 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 dictated 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 ISrvMonLongSeries.setDataPoints(long[]) with
a value of null.
setDataPointsFrom in interface ISrvMonLongSeriesval - the values to set.public final void addDataPoints(long val)
ISrvMonLongSeriesThis 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 XVM 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 dictated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
addDataPoints in interface ISrvMonLongSeriesval - the value to add.public final int getDataPointsCount()
ISrvMonLongSeriesWhen the XVM 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 dictated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
getDataPointsCount in interface ISrvMonLongSeriespublic final long getDataPointsAt(int index)
ISrvMonLongSeriesWhen the XVM 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 dictated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
getDataPointsAt in interface ISrvMonLongSeriespublic final long[] getDataPoints()
ISrvMonLongSeries
If the field is not set this method will return null.
When the XVM 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 dictated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
getDataPoints in interface ISrvMonLongSeriesnull.public final long[] getDataPointsEmptyIfNull()
ISrvMonLongSeriesnull or not set.
When the XVM 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 dictated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
getDataPointsEmptyIfNull in interface ISrvMonLongSeriesnull if not set.ISrvMonLongSeries.getDataPoints()public final XLongIterator getDataPointsIterator()
ISrvMonLongSeriesThis 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.XLongIterator) method
can perform a direct copy of the underlying values without iteration.
When the XVM 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 dictated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
getDataPointsIterator in interface ISrvMonLongSeriespublic final void clearDataPoints()
ISrvMonLongSeriesWhen the XVM 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 dictated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.
clearDataPoints in interface ISrvMonLongSeriesISrvMonLongSeries.setDataPoints(long[])public static final int getIntervalStatsFieldId()
public final void setIntervalStats(SrvMonLongHistogram val)
ISrvMonLongSeriesHold 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 XVM.
setIntervalStats in interface ISrvMonLongSeriesval - The value to set.public final void lendIntervalStats(SrvMonLongHistogram val)
ISrvMonLongSeriesHold 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 XVM.
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.
lendIntervalStats in interface ISrvMonLongSeriesval - the value to 'lend' to lend.public final SrvMonLongHistogram getIntervalStats()
ISrvMonLongSeriesHold 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 XVM.
getIntervalStats in interface ISrvMonLongSeriespublic final void getIntervalStatsTo(SrvMonLongHistogram to)
ISrvMonLongSeriesIF the value is not set, then the contents of the provided SrvMonLongHistogram are cleared.
getIntervalStatsTo in interface ISrvMonLongSeriesto - the value to copy intoSrvMonLongHistogram.copyInto(SrvMonLongHistogram)public final SrvMonLongHistogram takeIntervalStats()
ISrvMonLongSeriesHold 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 XVM.
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.
takeIntervalStats in interface ISrvMonLongSeriesnull if the field is not set.public final boolean hasIntervalStats()
ISrvMonLongSeriesHold 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 XVM.
hasIntervalStats in interface ISrvMonLongSeriesISrvMonLongSeries.getIntervalStats()public final void clearIntervalStats()
ISrvMonLongSeriesHold 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 XVM.
clearIntervalStats in interface ISrvMonLongSeriesISrvMonLongSeries.setIntervalStats(SrvMonLongHistogram)public static final int getRunningStatsFieldId()
public final void setRunningStats(SrvMonLongHistogram val)
ISrvMonLongSeriesHold 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 in interface ISrvMonLongSeriesval - The value to set.public final void lendRunningStats(SrvMonLongHistogram val)
ISrvMonLongSeriesHold 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.
lendRunningStats in interface ISrvMonLongSeriesval - the value to 'lend' to lend.public final SrvMonLongHistogram getRunningStats()
ISrvMonLongSeriesHold 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 in interface ISrvMonLongSeriespublic final void getRunningStatsTo(SrvMonLongHistogram to)
ISrvMonLongSeriesIF the value is not set, then the contents of the provided SrvMonLongHistogram are cleared.
getRunningStatsTo in interface ISrvMonLongSeriesto - the value to copy intoSrvMonLongHistogram.copyInto(SrvMonLongHistogram)public final SrvMonLongHistogram takeRunningStats()
ISrvMonLongSeriesHold 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.
takeRunningStats in interface ISrvMonLongSeriesnull if the field is not set.public final boolean hasRunningStats()
ISrvMonLongSeriesHold 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.
hasRunningStats in interface ISrvMonLongSeriesISrvMonLongSeries.getRunningStats()public final void clearRunningStats()
ISrvMonLongSeriesHold 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.
clearRunningStats in interface ISrvMonLongSeriesISrvMonLongSeries.setRunningStats(SrvMonLongHistogram)public static final <T> IRogFieldReflector<SrvMonLongSeries,T> getFieldReflector(String name)
name - The name of the field ('.' delimited for nested fields)public static final <T> IRogFieldReflector<SrvMonLongSeries,T> getFieldReflector(String[] pathComponents)
pathComponents - The path to the field whose reflector is to be returnedpublic final Object getQueryFieldValue(String name)
com.neeve.query.impl.index.IdxMappableImplementation should ensure that the the type of the value returned is consistent across types.
getQueryFieldValue in interface com.neeve.query.impl.index.IdxMappablename - The name of the field whose value is to be accessed.public final SrvMonLongSeries init()
UtlPool.ItemThis method is invoked by an item pool very time an item is put into the pool. The method should wipe the contents of the item so as to present a fresh instance of the item to the caller when retrieved from the pool.
init in interface UtlPool.Item<SrvMonLongSeries>public final SrvMonLongSeries setPool(UtlPool<SrvMonLongSeries> pool)
UtlPool.ItemThis method is invoked by an item pool at the time an item is added to the pool. The intent is to record the item's source pool in the item so it can be disposed back into the pool when the user is done working with it.
setPool in interface UtlPool.Item<SrvMonLongSeries>public final UtlPool<SrvMonLongSeries> getPool()
UtlPool.Item
This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
getPool in interface UtlPool.Item<SrvMonLongSeries>UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)public final SrvMonLongSeries acquire()
public final int getOwnershipCount()
public final void dispose()
public final Object clone()
This method differs from the copy() method in that:
public final boolean isValid()
IRogValidatableisValid in interface IRogValidatablepublic final void getValidationErrors(List<XString> results, String errorPrefix)
IRogValidatablegetValidationErrors in interface IRogValidatableresults - A results list into which validation errors will be collected.errorPrefix - The bean path prefix to use when identifying invalid fields or null if validating a top level entity.Copyright © 2019 N5 Technologies, Inc. All Rights Reserved.