Processor: Interface Counters

The Interface Counters processor selects interfaces according to the configuration and outputs counter stats of the specified types (such as ‘tx_bytes’).

Input Types - No inputs. This is a source processor.

Output Types - Number-Set (NS)

Properties

Counter Type (counter_type)

A type of an interface counter. enum of: tx_unicast_packets, tx_broadcast_packets, tx_multicast_packets, tx_bytes, tx_error_packets, tx_discard_packets, rx_unicast_packets, rx_broadcast_packets, rx_multicast_packets, rx_bytes, rx_error_packets, rx_discard_packets.

Graph Query (graph_query)

One or more queries on graph specified as strings, or a list of such queries. (String will be deprecated in a future release.) Multiple queries should provide all the named nodes referenced by the expression fields (including additional_properties). Graph query is executed on the “operation” graph. Results of the queries can be accessed using the “query_result” variable with the appropriate index. For example, if querying property set nodes under name “ps”, the result will be available as “query_result[0][“ps”]”.

In collector processors (*_collector, if_counter) it is used to choose a set of nodes for further processing (for example, all leafs, or all interfaces between leaf and spines)

In other processors it is used for general parameterization and it is only supported as a list of queries.

Fabric Interfaces Example

   graph_query: "node("system", role="leaf", name="system").
                 out("hosted_interfaces").
                 node("interface", name="iface").out("link").
                 node("link", role="spine_leaf")"

Leafs and Spines using two queries Example

   graph_query: ["node("system", role="leaf", name="system")",
                 "node("system", role="spine", name="system")"]

Interface (interface)

Expression mapping from graph query to interface name, e.g. “iface.if_name” if “iface” is a name in the graph query.

System ID

Expression mapping from graph query to a system_id, e.g. “system.system_id” if “system” is a name in the graph query.

Additional Keys

Each additional key/value pair is used to extend properties of output stages where value is considered as an expression executed in context of the graph query and its result is used as a property value with respective key. The value of this property is evaluated for each item to associate items with metrics provided by a corresponding collector service. The association is done by keys because each collector reports a set of metrics where each metric is identified by a key in a format that is specific for each collector.

Enable Streaming (enable_streaming)

Makes samples of output stages streamed if enabled. An optional boolean that defaults to False. If set to True, all output stages of this processor are streamed in the generic protobuf schema.

Interface Counter Example

graph_query: "node("system", name="system").out("hosted_interfaces").
              node("interface", name="iface").out("link").
              node("link", role="spine_leaf")"
counter_type: "rx_bytes"
system_id: "system.system_id"
interface: "interface.if_name"
role: "system.role"

In this example, we create a NSS that has an entry for rx_bytes (per second) per every interface in the system. Each entry is implicitly tagged by “system_id” and “interface”. Furthermore, as we have specified an additional property, each entry is also tagged by role of the system.

Sample Data

[system_id=spine1,role=spine,key=eth0]: 10
[system_id=spine2,role=spine,key=eth1]: 11
[system_id=leaf0,role=leaf, key=swp1]: 12