Network-Interface metric type provides the metrics, properties, and tags to represent the performance of physical and virtual network adapters.

The VMware Telco Cloud Operations collectors constructs this metric type with Network adapter performance metrics for network devices, servers, and virtual devices. In the VMware Telco Cloud Operations out-of-the box reports, this metric type is used to show the summary of Network Adapter performance trends per device and per Network Adapter instance. Leverage this metric type to create custom reports to represent Network Adapter performance using other Grafana widgets or new filters. Similarly, custom collectors can construct the metric type for the different vendor and create custom reports.

Example of Metric Collection format.

{
"type" : "Kafka-Collector",
"instance" : "KC-1",
"timestamp" : 1573186658,
"processedTimestamp" : 1573186658,
"metricType" : "Network-Interface",
"properties" : {
"dataSource" : "10.100.10.10",
"deviceType" : "Switch",
"deviceName" : "Switch-1.1.1.1",
"entityType" : "Interface",
"entityName" : "INT-node-113/eth1"
},
"metrics" : {
"ifInOctets" : "100",
"ifInUcastPkts" : "100",
"ifInUnknownProtos" : "100",
"ifInDiscards" : "0",
"ifInErrors" : "0",
"ifInBroadcastPkts" : "100",
"ifInMulticastPkts" : "100",
"ifOutOctets" : "100",
"ifOutUcastPkts" : "100",
"ifOutBroadcastPkts" : "100",
"ifOutErrors" : "0",
"ifOutDiscards" : "0",
"ifOutMulticastPkts" : "100",
"CurrentUtilization" : "70",
"ifAdminStatus" : "1",
"ifOperStatus" : "1"
},
"tags" : {
"model" : "CAT-100",
"version" : "1.0.0.1",
"customer" : "customer-1",
"location" : "main street",
"city" : "Zurich",
"address" : "abc",
"zip" : "90882",
"region" : "region-1",
"deviceCoordinates" : "45.444348, -75.693934",
"ifSpeed": "1000000"
}
}

MetricType (Catalog)

{
  "type" : "Collector/KPI Type",
  "instance" : "Collector/KPI instance",
  "timestamp" : "Time at which the metrics were collected by collector or KPI, in milli-seconds since Epoch (00:00:00 Jan 1, 1970 UTC)",
  "processedTimestamp" : "Internal Usage",
  "metricType" : "Network-Interface",
  "properties" : {
    "dataSource" : "The IP address or host name of the data source",
    "deviceType" : "The type of the device (for example, switch, firewall, or server).",
    "deviceName" : "Instance name of the device.",
    "entityType" : "The type of the entity in the device (for example, port, or interface) to which the below metrics belong",
    "entityName" : "Instance name of the entity"
 },
  "metrics" : {
    "ifInOctets" : {
      "definition" : {
        "description" : "The total number of octets received on the interface,including framing characters.",
        "range" : "",
        "unit" : "octets"
 }
    },
    "ifInUcastPkts" : {
      "definition" : {
        "description" : "The number of packets, delivered by this sub-layer to a\nhigher (sub-)layer, which were not addressed to a multicast\nor broadcast address at this sub-layer.",
        "range" : "",
        "unit" : "packets"
 }
    },
    "ifInDiscards" : {
      "definition" : {
        "description" : "The number of inbound packets which were chosen to be\ndiscarded even though no errors had been detected to prevent\n\ntheir being deliverable to a higher-layer protocol. One\npossible reason for discarding such a packet could be to\nfree up buffer space.",
        "range" : "",
        "unit" : "packets"
 }
    },
    "ifInErrors" : {
      "definition" : {
        "description" : "For packet-oriented interfaces, the number of inbound\npackets that contained errors preventing them from being\ndeliverable to a higher-layer protocol. For character-\noriented or fixed-length interfaces, the number of inbound\ntransmission units that contained errors preventing them\nfrom being deliverable to a higher-layer protocol.",
        "range" : "",
        "unit" : "packets"
 }
    },
    "ifInUnknownProtos" : {
      "definition" : {
        "description" : "For packet-oriented interfaces, the number of packets\nreceived via the interface which were discarded because of\nan unknown or unsupported protocol. For character-oriented\nor fixed-length interfaces that support protocol\nmultiplexing the number of transmission units received via\nthe interface which were discarded because of an unknown or\nunsupported protocol. For any interface that does not\nsupport protocol multiplexing, this counter will always be\n0.",
        "range" : "",
        "unit" : "packets"
 }
    },
    "ifOutOctets" : {
      "definition" : {
        "description" : "The total number of octets transmitted out of the\ninterface, including framing characters.",
        "range" : "",
        "unit" : "octets"
 }
    },
    "ifOutUcastPkts" : {
      "definition" : {
        "description" : "The total number of packets that higher-level protocols\nrequested be transmitted, and which were not addressed to a\nmulticast or broadcast address at this sub-layer, including\nthose that were discarded or not sent.",
        "range" : "",
        "unit" : "packets"
 }
    },
    "ifOutDiscards" : {
      "definition" : {
        "description" : "The number of outbound packets which were chosen to be\ndiscarded even though no errors had been detected to prevent\ntheir being transmitted. One possible reason for discarding\nsuch a packet could be to free up buffer space.",
        "range" : "",
        "unit" : "packets"
 }
    },
    "ifOutErrors" : {
      "definition" : {
        "description" : "For packet-oriented interfaces, the number of outbound\npackets that could not be transmitted because of errors.\nFor character-oriented or fixed-length interfaces, the\nnumber of outbound transmission units that could not be\ntransmitted because of errors..",
        "range" : "",
        "unit" : "packets"
 }
    },
    "ifOutNUcastPkts" : {
      "definition" : {
        "description" : "The total number of packets that higher-level protocols\nrequested be transmitted, and which were addressed to a\nmulticast or broadcast address at this sub-layer, including\nthose that were discarded or not sent..",
        "range" : "",
        "unit" : "packets"
 }
    }
  },
  "tags <Non-mandatory meta-data associated with the above metrics>" : {
    "model": "The model of the device.",
    "version" : "The version of the device.",
    "customer" : "A customer or tenant identifier.",
    "location" : "The location of the device.",
    "city" : "The city in which the device is physically located.",
    "address" : "The street address where the device is physically located.",
    "zip" : "The postal code of the address where the device is located.",
    "region" : "The region where the device is located.", 
    "deviceCoordinates" : "The geographical coordinates of the location where the device is located.",
    "parent" : "The multi-level parent of entity, each level parent separated by | "
JSON Description Units
ifInOctets The number of packets, delivered by this sub-layer to a\nhigher (sub-)layer, which were not addressed to a multicast\nor broadcast address at this sub-layer. Packets
ifInUcastPkts Indicates the size of the disk. Packets
ifInUnknownProtos For packet-oriented interfaces, the number of packets received via the interface which were discarded because of an unknown or unsupported protocol. For character-oriented or fixed-length interfaces that support protocol multiplexing the number of transmission units received via the interface which were discarded because of an unknown or\nunsupported protocol. For any interface that does not\nsupport protocol multiplexing, this counter will always be 0. Packets
ifInDiscards The number of inbound packets which were chosen to be\ndiscarded even though no errors had been detected to prevent\n\ntheir being deliverable to a higher-layer protocol. One\npossible reason for discarding such a packet could be to\nfree up buffer space. Packets
ifInErrors For packet-oriented interfaces, the number of inbound\npackets that contained errors preventing them from being\ndeliverable to a higher-layer protocol. For character-\noriented or fixed-length interfaces, the number of inbound\ntransmission units that contained errors preventing them\nfrom being deliverable to a higher-layer protocol. Packets
ifInBroadcastPkts

The number of packets, delivered by this sub-layer to ahigher (sub-)layer, which were addressed to a broadcastaddress at this sub-layer. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of fCounterDiscontinuityTime."

Packets
ifInMulticastPkts

The number of packets, delivered by this sub-layer to ahigher (sub-)layer, which were addressed to a multicastaddress at this sub-layer. For a MAC layer protocol, this includes both Group and Functional addresses. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime."

Packets
ifOutOctets
The total number of octets transmitted out of the\ninterface, including framing characters. Packets
ifOutUcastPkts
The total number of packets that higher-level protocols\nrequested be transmitted, and which were not addressed to a\nmulticast or broadcast address at this sub-layer, including\nthose that were discarded or not sent. Packets
ifOutBroadcastPkts

The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a broadcast address at this sub-layer, including those that were discarded or not sent. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other imes as indicated by the value of ifCounterDiscontinuityTime."

Packets
ifOutErrors
For packet-oriented interfaces, the number of outbound\npackets that could not be transmitted because of errors.\nFor character-oriented or fixed-length interfaces, the\nnumber of outbound transmission units that could not be\ntransmitted because of errors. Packets
ifOutDiscards
The number of outbound packets which were chosen to be\ndiscarded even though no errors had been detected to prevent\ntheir being transmitted. One possible reason for discarding\nsuch a packet could be to free up buffer space. Packets
ifOutMulticastPkts

The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a multicast address at this sub-layer, including those that were discarded or not sent. For a MAC layer protocol, this includes both Group and Functional addresses.

Packets
CurrentUtilization

The current utilization of the NetworkAdapter expressed as a percentage of the bandwidth

Percentage
ifAdminStatus
Administrative Status of Network Adapter Boolean
ifOperStatus
Operation Status of Network Adapter Boolean