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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordA metered rate over the 1, 5 and 15 minute exponentially weighted windows. -
Constructor Summary
ConstructorsConstructorDescriptionIngestTelemetry(IngestTelemetry.Rate pointsPerSecond, long flushes, Percentiles pointsPerFlush, Percentiles dwellMillis, Percentiles engineMillis) Creates an instance of aIngestTelemetryrecord 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.Returns the value of thepointsPerFlushrecord component.Returns the value of thepointsPerSecondrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
IngestTelemetry
public IngestTelemetry(IngestTelemetry.Rate pointsPerSecond, long flushes, Percentiles pointsPerFlush, Percentiles dwellMillis, Percentiles engineMillis) Creates an instance of aIngestTelemetryrecord class.- Parameters:
pointsPerSecond- the value for thepointsPerSecondrecord componentflushes- the value for theflushesrecord 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. -
pointsPerSecond
Returns the value of thepointsPerSecondrecord component.- Returns:
- the value of the
pointsPerSecondrecord component
-
flushes
-
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
-