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 Details

    • EMPTY

      public static final FlushTelemetry 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 a FlushTelemetry record class.
      Parameters:
      flushes - the value for the flushes record component
      points - the value for the points record component
      pointsPerFlush - the value for the pointsPerFlush record component
      dwellMillis - the value for the dwellMillis record component
      engineMillis - the value for the engineMillis record component
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      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 with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • flushes

      public long flushes()
      Returns the value of the flushes record component.
      Returns:
      the value of the flushes record component
    • points

      public long points()
      Returns the value of the points record component.
      Returns:
      the value of the points record component
    • pointsPerFlush

      public Percentiles pointsPerFlush()
      Returns the value of the pointsPerFlush record component.
      Returns:
      the value of the pointsPerFlush record component
    • dwellMillis

      public Percentiles dwellMillis()
      Returns the value of the dwellMillis record component.
      Returns:
      the value of the dwellMillis record component
    • engineMillis

      public Percentiles engineMillis()
      Returns the value of the engineMillis record component.
      Returns:
      the value of the engineMillis record component