Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Requesting Interface Statistics for a Trace

 

Use the Cloud Analytics Engine DLE API as follows to retrieve detailed device interface packet transmit and receive statistics for a DLE flow path trace.

GET /api/v1/traces/{traceId}/interface-stats

Use this DLE API request to get detailed interface statistics samples collected by DLE for the specified trace ID.

Request Format:

  • GET method

Request Parameters:

  • Table 1 describes the request parameters, including the devices to sample.

    Table 1: Trace Interface Statistics Request Parameters

    Request Parameter

    Description

    device-serials

    (String) Comma-separated list of device serial number strings in the trace’s flow path from which to retrieve interface statistics.

    interface-name

    (String) Device interface name.

    start-time

    (Numeric) Starting time (epoch time in ms) from which to retrieve interface statistics samples.

    end-time

    (Numeric) Ending time (epoch time in ms) up until which to retrieve interface statistics samples.

    trace-id

    (String) Trace ID from which to retrieve statistics for the specified interface.

Response Data:

See Trace Interface Statistics Data Learning Engine API Example for a sample trace interface statistics request and response.

Trace Interface Statistics Transfer Object

Table 2 describes the Trace Interface Statistics transfer object, which provides detailed interface statistics from the devices in the flow path for a particular trace managed by DLE, in JSON format. See GET /api/v1/traces/{traceId}/interface-stats.

Table 2: Trace Interface Statistics Transfer Object

Element Name

Description

id

(String) Trace ID.

totalSize

(Numeric) Number of interfaces for which statistics are returned in this response in the traceStats list element.

traceStats

List of Trace Interface Statistics for the requested device(s), described in Table 3.

uri

(String) URI of the API request for this response data.

Table 3 describes the Trace Interface Statistics data elements.

Table 3: Trace Interface Statistics Data Object

Element Name

Description

deviceSerialNumber

(String) Serial number of the device.

iflCount

(Numeric) Number of iflTrafficRates list elements in this response.

iflTrafficRates

List of Trace Interface Traffic Statistics Samples data objects for the requested device(s) and interface(s), described in Table 4, which includes receive and transmit traffic statistics samples.

Table 4 describes the Trace Interface Traffic Statistics Samples data elements.

Table 4: Trace Interface Traffic Statistics Samples Data Object

Element Name

Description

interfaceName

(String) Interface name.

sampleCount

(Numeric) Number of samples list elements in this response.

samples

List of Trace Interface Packet Statistics data objects, described in Table 5.

Table 5 describes the Trace Interface Packet Statistics data elements, representing packet transmit and receive statistics samples.

Table 5: Trace Interface Packet Statistics Data Object

Element Name

Description

timestamp

Timestamp (epoch time in ms) of this sample in the requested sampling period.

tx_Pkts

(Numeric) Total transmitted (Tx) packets on the interface.

rx_Pkts

(Numeric) Total received (Rx) packets on the interface.

tx_UcPkts

(Numeric) Total number of egress/transmitted unicast packets on the interface.

rx_UcPkts

(Numeric) Total number of ingress/received unicast packets on the interface.

tx_BcPkts

(Numeric) Total number of outgoing broadcast packets.

rx_BcPkts

(Numeric) Total number of incoming broadcast packets.

tx_McPkts

(Numeric) Total number of outgoing multicast packets.

rx_McPkts

(Numeric) Total number of incoming multicast packets.

tx_Pps

(Numeric) Transmit bandwidth (packets per second).

rx_Pps

(Numeric) Receive bandwidth (packets per second).

tx_CrcErrors

(Numeric) Total CRC align errors while transmitting.

rx_CrcErrors

(Numeric) Total CRC align errors while receiving.

tx_DropPkt

(Numeric) Cumulative Tx packet drop in all the queues for the interface.

rx_DropPkt

(Numeric) Ingress Rx packet drops on the interface. This could be due to a buffer full condition.

tx_Bytes

(Numeric) Total transmit bytes.

rx_Bytes

(Numeric) Total receive bytes.

tx_Bw

(Numeric) Transmit bandwidth (bytes per second), the average rate at which packet bytes are transmitted.

rx_Bw

(Numeric) Receive bandwidth (bytes per second), the average rate at which packet bytes are received.

errorCntr

(Numeric) Error counter.

Trace Interface Statistics Data Learning Engine API Example

The following is a DLE API example for retrieving trace interface statistics. See GET /api/v1/traces/{traceId}/interface-stats. The response data for these requests is in JSON format.

Request:

http://192.168.55.102:8282/api/v1/traces/

NTYuNS4zLjE1OjMxMTgtNjYuNS4zLjE1OjQxMTgtdWRwQDE0MjMwODgzMzQ1NTE=/

interface-stats?end-time=1429641444500&device-serials=TA3714140387

&start-time=1429641004500&interface-name=et-0%2F0%2F48.0

&trace-id=NTYuNS4zLjE1OjMxMTgtNjYuNS4zLjE1OjQxMTgtdWRwQDE0MjMwODgzMzQ1NTE=

Response data: