Statistics

• Display global statistics : GET /api2/statistics/global
  • json structure
• Display port statistics : GET /api2/statistics/ports?ports={port_number(s)}
  • json structure
• Display port statistics as CSV : GET /api2/statistics/ports_file?ports={port_number(s)}
  • json structure
• Display bandwidth statistics : GET /api2/statistics/bandwidth?ports={port_number(s)}&period=1(hours)&entries=1
  • json structure
  • if ports are not specified then statistics for all ports is returned
  • if period is not specified then 1 hour is used as a default value
  • if entries is specified then period is ignored
• Reset statistics : DELETE /api2/statistics/ports?ports={port_number(s)}
  • usage: the request has to be empty
• Reset peak statistics : DELETE /api2/statistics/peak
  • usage: the request has to be empty

Drop counters

Two counters report discarded frames. They separate frames dropped by policy from frames dropped because a buffer was full.

• rx_frame_unrouted: frames received on the port and discarded by the forwarding policy. This includes frames that match no rule, frames removed by a drop filter, and frames whose destination port is down. Counted on the ingress port. These drops are expected in normal operation and do not raise any event or trap.
• buffer_frame_drop: frames discarded because an egress buffer was full, for example when several inputs oversubscribe one output port. Counted on the egress port where the congestion happened, not on the ingress ports that feed it. A change in this counter raises the port_buffer_drop event and the portBufferDroppedTX SNMP trap.

Json structures

Global statistics json structure

{
        "rx_octets_good": 0,
        "rx_octets_all": 0,
        "rx_frame_good": 0,
        "rx_frame_error": 0,
        "rx_frame_all": 0,
        "rx_frame_unrouted": 0,
        "rx_bandwidth": 0,
        "tx_octets_good": 0,
        "tx_octets_all": 0,
        "tx_frame_good": 0,
        "tx_frame_error": 0,
        "tx_frame_all": 0,
        "tx_bandwidth": 0,
        "buffer_frame_drop": 0,
}

Port file statistics json structure

name, rx_usage, tx_usage, rx_ber, buffer_frame_drop, frame_crc_error, rx_bandwidth, rx_fragments, rx_frame_all, rx_frame_bc, rx_frame_error, rx_frame_good, rx_frame_jabber, rx_frame_len_0_64, rx_frame_len_1024_9216, rx_frame_len_128_255, rx_frame_len_256_511, rx_frame_len_512_1023, rx_frame_len_65_127, rx_frame_mc, rx_frame_oversize, rx_frame_pause, rx_frame_uc, rx_frame_undersize, rx_frame_unrouted, rx_octets_all, rx_octets_good, tx_bandwidth, tx_frame_all, tx_frame_bc, tx_frame_error, tx_frame_good, tx_frame_len_0_64, tx_frame_len_1024_9216, tx_frame_len_128_255, tx_frame_len_256_511, tx_frame_len_512_1023, tx_frame_len_65_127, tx_frame_mc, tx_frame_pause, tx_frame_uc, tx_octets_all, tx_octets_good
1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0

Port statistics json structure

[
    {
        "id": 11,
        "rx_octets_good": 0,
        "rx_octets_all": 0,
        "rx_frame_good": 0,
        "rx_frame_error": 0,
        "rx_frame_all": 0,
        "rx_frame_pause": 0,
        "rx_frame_bc": 0,
        "rx_frame_mc": 0,
        "rx_frame_uc": 0,
        "rx_frame_oversize": 0,
        "rx_frame_undersize": 0,
        "rx_frame_jabber": 0,
        "rx_frame_len_0_64": 0,
        "rx_frame_len_65_127": 0,
        "rx_frame_len_128_255": 0,
        "rx_frame_len_256_511": 0,
        "rx_frame_len_512_1023": 0,
        "rx_frame_len_1024_9216": 0,
        "rx_frame_unrouted": 0,
        "rx_fragments": 0,
        "rx_ber": 0,
        "rx_usage": 0,
        "rx_bandwidth": 0,
        "tx_octets_good": 0,
        "tx_octets_all": 0,
        "tx_frame_good": 0,
        "tx_frame_error": 0,
        "tx_frame_all": 0,
        "tx_frame_pause": 0,
        "tx_frame_bc": 0,
        "tx_frame_mc": 0,
        "tx_frame_uc": 0,
        "tx_frame_len_0_64": 0,
        "tx_frame_len_65_127": 0,
        "tx_frame_len_128_255": 0,
        "tx_frame_len_256_511": 0,
        "tx_frame_len_512_1023": 0,
        "tx_frame_len_1024_9216": 0,
        "tx_bandwidth": 0,
        "tx_usage": 0,
        "frame_crc_error": 0,
        "buffer_frame_drop": 0,
        "rx_peak_bandwidth": 0,
        "rx_peak_bandwidth_time": 0,
        "tx_peak_bandwidth": 0,
        "tx_peak_bandwidth_time": 0,
    }
]

Bandwidth statistics json structure

[
    {
        "label": 1555487672,
        "id": 1,
        "rx_bandwidth": 0,
        "tx_bandwidth": 0
    },
    {
        "label": 1555487677,
        "id": 2,
        "rx_bandwidth": 0,
        "tx_bandwidth": 0
    }
]

Back to X2-SERIES API Home