Record Class FlushTelemetry
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.storage.strategy.FlushTelemetry
- Record Components:
flushes- the total number of completed flushes, including those outside the window.points- the total points those flushes attempted, stored plus failed, since startup.pointsPerFlush- the attempted point count of each flush, stored plus failed.dwellMillis- how long the oldest point of each flush waited before the flush fired.engineMillis- how long each flush took downstream, from dispatch to result.
public record FlushTelemetry(long flushes, long points, Percentiles pointsPerFlush, Percentiles dwellMillis, Percentiles engineMillis)
extends Record
A reading of the flushes a buffering
PointStorageStrategy has completed, over a sliding
window of recent flushes. Reported by PointStorageStrategy.flushTelemetry(). Unlike
StorageStrategyMetrics, which describes what is queued now, it describes how flushing has
gone: batch sizes, how long points waited, and how long the engine took to store them.- Since:
- 2027.02
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionFlushTelemetry(long flushes, long points, Percentiles pointsPerFlush, Percentiles dwellMillis, Percentiles engineMillis) Creates an instance of aFlushTelemetryrecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thedwellMillisrecord component.Returns the value of theengineMillisrecord component.final booleanIndicates whether some other object is "equal to" this one.longflushes()Returns the value of theflushesrecord component.final inthashCode()Returns a hash code value for this object.longpoints()Returns the value of thepointsrecord component.Returns the value of thepointsPerFlushrecord component.final StringtoString()Returns a string representation of this record class.
-
Field Details
-
EMPTY
The reading before any flush.
-
-
Constructor Details
-
FlushTelemetry
public FlushTelemetry(long flushes, long points, Percentiles pointsPerFlush, Percentiles dwellMillis, Percentiles engineMillis) Creates an instance of aFlushTelemetryrecord class.- Parameters:
flushes- the value for theflushesrecord componentpoints- the value for thepointsrecord componentpointsPerFlush- the value for thepointsPerFlushrecord componentdwellMillis- the value for thedwellMillisrecord componentengineMillis- the value for theengineMillisrecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
flushes
-
points
-
pointsPerFlush
Returns the value of thepointsPerFlushrecord component.- Returns:
- the value of the
pointsPerFlushrecord component
-
dwellMillis
Returns the value of thedwellMillisrecord component.- Returns:
- the value of the
dwellMillisrecord component
-
engineMillis
Returns the value of theengineMillisrecord component.- Returns:
- the value of the
engineMillisrecord component
-