Record Class IngestTelemetry

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.storage.IngestTelemetry
Record Components:
pointsPerSecond - successfully stored points per second.
flushes - the number of completed flushes.
pointsPerFlush - the attempted points per flush, stored plus failed.
dwellMillis - how long points waited before their flush fired.
engineMillis - how long a flush took downstream.

public record IngestTelemetry(IngestTelemetry.Rate pointsPerSecond, long flushes, Percentiles pointsPerFlush, Percentiles dwellMillis, Percentiles engineMillis) extends Record
What a running historian's ingest has been doing: the rate points are stored at, joined with the shape of the flushes storing them. Reported by AbstractStorageEngine.ingestTelemetry(); the flush figures come from the storage strategy, so an engine whose strategy does not buffer reports nothing.
Since:
2027.02
  • Constructor Details

  • 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.
    • pointsPerSecond

      public IngestTelemetry.Rate pointsPerSecond()
      Returns the value of the pointsPerSecond record component.
      Returns:
      the value of the pointsPerSecond record component
    • flushes

      public long flushes()
      Returns the value of the flushes record component.
      Returns:
      the value of the flushes 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