runtimepy.metrics
index
/home/vkottler/src/vkottler/workspace/runtimepy/runtimepy/metrics/__init__.py

A module defining common metrics interfaces.

 
Package Contents
       
channel
connection
task

 
Classes
       
builtins.object
runtimepy.metrics.channel.ChannelMetrics
runtimepy.metrics.connection.ConnectionMetrics
builtins.tuple(builtins.object)
runtimepy.metrics.task.PeriodicTaskMetrics

 
class ChannelMetrics(builtins.object)
    ChannelMetrics() -> None
 
Metrics for a network channel.
 
  Methods defined here:
__init__(self) -> None
Initialize this instance.
__str__(self) -> str
Get metrics as a string.
increment(self, count: int, time_ns: int = None) -> None
Update tracking.
poll(self, time_ns: int = None) -> None
Poll kbps tracking.
reset(self) -> None
Reset metrics.
update(self, other: 'ChannelMetrics') -> None
Update values in this instance from values in another instance.

Data descriptors defined here:
__dict__
dictionary for instance variables
__weakref__
list of weak references to the object

 
class ConnectionMetrics(builtins.object)
    ConnectionMetrics() -> None
 
Metrics for a network connection.
 
  Methods defined here:
__init__(self) -> None
Initialize this instance.
poll(self, time_ns: int = None) -> None
Poll channels.
reset(self) -> None
Reset metrics.
update(self, other: 'ConnectionMetrics') -> None
Update values in this instance from values in another instance.

Data descriptors defined here:
__dict__
dictionary for instance variables
__weakref__
list of weak references to the object

 
class PeriodicTaskMetrics(builtins.tuple)
    PeriodicTaskMetrics(dispatches: runtimepy.primitives.int.Uint32Primitive, rate_hz: runtimepy.primitives.float.FloatPrimitive, average_s: runtimepy.primitives.float.FloatPrimitive, max_s: runtimepy.primitives.float.FloatPrimitive, min_s: runtimepy.primitives.float.FloatPrimitive, overruns: runtimepy.primitives.int.Uint16Primitive)
 
Metrics for a periodic tasks.
 
 
Method resolution order:
PeriodicTaskMetrics
builtins.tuple
builtins.object

Methods defined here:
__getnewargs__(self)
Return self as a plain tuple.  Used by copy and pickle.
__repr__(self)
Return a nicely formatted representation string
_asdict(self)
Return a new dict which maps field names to their values.
_replace(self, /, **kwds)
Return a new PeriodicTaskMetrics object replacing specified fields with new values
measure(self, eloop: asyncio.events.AbstractEventLoop, rate: vcorelib.math.analysis.rate.RateTracker, dispatch: vcorelib.math.analysis.average.MovingAverage, iter_time: runtimepy.primitives.float.DoublePrimitive, period_s: float) -> Iterator[NoneType]
Measure the time spent yielding and update data.

Class methods defined here:
_make(iterable) from builtins.type
Make a new PeriodicTaskMetrics object from a sequence or iterable

Static methods defined here:
__new__(_cls, dispatches: runtimepy.primitives.int.Uint32Primitive, rate_hz: runtimepy.primitives.float.FloatPrimitive, average_s: runtimepy.primitives.float.FloatPrimitive, max_s: runtimepy.primitives.float.FloatPrimitive, min_s: runtimepy.primitives.float.FloatPrimitive, overruns: runtimepy.primitives.int.Uint16Primitive)
Create new instance of PeriodicTaskMetrics(dispatches, rate_hz, average_s, max_s, min_s, overruns)
create() -> 'PeriodicTaskMetrics'
Create a new metrics instance.

Data descriptors defined here:
dispatches
Alias for field number 0
rate_hz
Alias for field number 1
average_s
Alias for field number 2
max_s
Alias for field number 3
min_s
Alias for field number 4
overruns
Alias for field number 5

Data and other attributes defined here:
__annotations__ = {'average_s': <class 'runtimepy.primitives.float.FloatPrimitive'>, 'dispatches': <class 'runtimepy.primitives.int.Uint32Primitive'>, 'max_s': <class 'runtimepy.primitives.float.FloatPrimitive'>, 'min_s': <class 'runtimepy.primitives.float.FloatPrimitive'>, 'overruns': <class 'runtimepy.primitives.int.Uint16Primitive'>, 'rate_hz': <class 'runtimepy.primitives.float.FloatPrimitive'>}
__match_args__ = ('dispatches', 'rate_hz', 'average_s', 'max_s', 'min_s', 'overruns')
__orig_bases__ = (<function NamedTuple>,)
_field_defaults = {}
_fields = ('dispatches', 'rate_hz', 'average_s', 'max_s', 'min_s', 'overruns')

Methods inherited from builtins.tuple:
__add__(self, value, /)
Return self+value.
__contains__(self, key, /)
Return bool(key in self).
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__getattribute__(self, name, /)
Return getattr(self, name).
__getitem__(self, key, /)
Return self[key].
__gt__(self, value, /)
Return self>value.
__hash__(self, /)
Return hash(self).
__iter__(self, /)
Implement iter(self).
__le__(self, value, /)
Return self<=value.
__len__(self, /)
Return len(self).
__lt__(self, value, /)
Return self<value.
__mul__(self, value, /)
Return self*value.
__ne__(self, value, /)
Return self!=value.
__rmul__(self, value, /)
Return value*self.
count(self, value, /)
Return number of occurrences of value.
index(self, value, start=0, stop=9223372036854775807, /)
Return first index of value.
 
Raises ValueError if the value is not present.

Class methods inherited from builtins.tuple:
__class_getitem__(...) from builtins.type
See PEP 585

 
Data
        METRICS_DEPTH = 50
__all__ = ['ChannelMetrics', 'METRICS_DEPTH', 'ConnectionMetrics', 'PeriodicTaskMetrics']