Statistics Object

class activelogic.StatisticsObject

Object representing a statistics object in the ruleset.

Parameters:

• name (str) – Name of the object.

• id (int) – Id of the object.

• aggregate (bool) – Aggregate to the aggregation server.

• graph_freq (int) – Graph frequency in seconds.

• total_fields (StatisticsTotalField) – Fields to be included in daily summaries.

• graph_fields (StatisticsGraphField) – Fields to be included in graph.

• min_bytes_in (int) – Min bytes in (default 100kB).

• min_bytes_out (int) – Min bytes out (default 100kB).

• netobject_root (int) – NetObject root.

• serviceobject_root (int) – ServiceObject root.

• split (str) – Split string.

>>> obj = rs.add(StatisticsObject('mystatsobj',
... total_fields=StatisticsTotalField.BYTES_IN | StatisticsTotalField.BYTES_OUT,
... graph_fields=StatisticsGraphField.BPS_IN | StatisticsGraphField.BPS_OUT))

class activelogic.StatisticsTotalField

Defines a set of numeric constants representing available fields to be included in daily summary:

Variables:

• BYTES_IN – Incoming bytes

• BYTES_OUT – Outgoing bytes

• BYTES_TOTAL – Total bytes

• SHAPING_BYTEDROPS_IN – Incoming shaping dropped bytes

• SHAPING_BYTEDROPS_OUT – Outgoing shaping dropped bytes

• CONNS – Connections

• UCONNS – Unestablished connections

• CONNS_IN – Incoming connections

• CONNS_OUT – Outgoing connections

• UCONNS_IN – Incoming unestablished connections

• UCONNS_OUT – Outgoing unestablished connections

• CURCONNS_IN – Incoming concurrent connections

• CURCONNS_OUT – Outgoing concurrent connections

• PKTDROPS_IN – Incoming dropped packets

• PKTDROPS_OUT – Outgoing dropped packets

• PACKETS_IN – Incoming packets

• PACKETS_OUT – Outgoing packets

• AVG_LATENCY_IN – Incoming avg latency

• AVG_LATENCY_OUT – Outgoing avg latency

• SUBITEMS – Sub-item count

• QUALITY_IN – Incoming quality

• QUALITY_OUT – Outgoing quality

• QUALITY_IN_INT – Incoming quality (internal)

• QUALITY_OUT_INT – Outgoing quality (internal)

• QUALITY_IN_EXT – Incoming quality (external)

• QUALITY_OUT_EXT – Outgoing quality (external)

• QUALITY_DROPS_IN – Incoming quality drops

• QUALITY_DROPS_OUT – Outgoing quality drops

• QUALITY_RETRANSMISSIONS_IN – Incoming retransmissions

• QUALITY_RETRANSMISSIONS_OUT – Outgoing retransmissions

• RTT_IN – Internal avg handshake RTT

• RTT_OUT – External avg handshake RTT

class activelogic.StatisticsGraphField

Defines a set of numeric constants representing available graph points:

Variables:

• BPS_IN – Incomping bps

• BPS_OUT – Outgoing bps

• BPS_TOTAL – Total bps

• SHAPING_BYTEDROPS_IN – Incoming shaping dropped bytes

• SHAPING_BYTEDROPS_OUT – Outgoing shaping dropped bytes

• LINK_UTILIZATION_IN – Incoming link utilization

• LINK_UTILIZATION_OUT – Outgoing link utilization

• CPS – Connections

• UCPS – Unestablished connections

• CPS_IN – Incoming connections

• CPS_OUT – Outgoing connections

• UCPS_IN – Incoming unestablished connections

• UCPS_OUT – Outgoing unestablished connections

• CURCONNS_IN – Incoming concurrent connections

• CURCONNS_OUT – Outgoing concurrent connections

• PKTDROPS_IN – Incoming dropped packets

• PKTDROPS_OUT – Outgoing dropped packets

• PACKETS_IN – Incoming packets

• PACKETS_OUT – Outgoing packets

• AVG_LATENCY_IN – Incoming avg latency

• AVG_LATENCY_OUT – Outgoing avg latency

• SUBITEMS – Sub-item count

• QUALITY_IN – Incoming quality

• QUALITY_OUT – Outgoing quality

• QUALITY_IN_INT – Incoming quality (internal)

• QUALITY_OUT_INT – Outgoing quality (internal)

• QUALITY_IN_EXT – Incoming quality (external)

• QUALITY_OUT_EXT – Outgoing quality (external)

• QUALITY_DROPS_IN – Incoming quality drops

• QUALITY_DROPS_OUT – Outgoing quality drops

• QUALITY_RETRANSMISSIONS_IN – Incoming retransmissions

• QUALITY_RETRANSMISSIONS_OUT – Outgoing retransmissions

• RTT_IN – Internal avg handshake RTT

• RTT_OUT – External avg handshake RTT