# Generic network interfaces abstract profile.
# MIB: IF-MIB

metrics:
  - MIB: IF-MIB
    symbol:
      OID: 1.3.6.1.2.1.2.1.0
      name: ifNumber
      chart_meta:
        description: Number of network interfaces regardless of their current state present on this system
        family: 'Network/Interface/Count/Total'
        unit: "{interface}"
  - MIB: IF-MIB
    table:
      OID: 1.3.6.1.2.1.2.2
      name: ifTable
    symbols:
      - OID: 1.3.6.1.2.1.2.2.1.14
        name: ifInErrors
        chart_meta:
          description: Number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol
          family: 'Network/Interface/Error/Total/In'
          unit: "{error}/s"
      - OID: 1.3.6.1.2.1.2.2.1.20
        name: ifOutErrors
        chart_meta:
          description: Number of outbound packets that could not be transmitted because of errors
          family: 'Network/Interface/Error/Total/Out'
          unit: "{error}/s"
      - OID: 1.3.6.1.2.1.2.2.1.13
        name: ifInDiscards
        chart_meta:
          description: Number of inbound packets chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol
          family: 'Network/Interface/Discard/In'
          unit: "{discard}/s"
      - OID: 1.3.6.1.2.1.2.2.1.19
        name: ifOutDiscards
        chart_meta:
          description: Number of outbound packets chosen to be discarded even though no errors had been detected to prevent their being transmitted
          family: 'Network/Interface/Discard/Out'
          unit: "{discard}/s"
      - OID: 1.3.6.1.2.1.2.2.1.7
        name: ifAdminStatus
        chart_meta:
          description: Current administrative state of the interface
          family: 'Network/Interface/Status/Admin'
          unit: "{status}"
        mapping:
          1: up
          2: down
          3: testing
      - OID: 1.3.6.1.2.1.2.2.1.8
        name: ifOperStatus
        chart_meta:
          description: Current operational state of the interface
          family: 'Network/Interface/Status/Operational'
          unit: "{status}"
        mapping:
          1: up
          2: down
          3: testing
          4: unknown
          5: dormant
          6: notPresent
          7: lowerLayerDown
    metric_tags:
      - tag: interface
        table: ifXTable
        symbol:
          OID: 1.3.6.1.2.1.31.1.1.1.1
          name: ifName
      - tag: interface
        symbol:
          OID: 1.3.6.1.2.1.2.2.1.2
          name: ifDescr
      - tag: _if_type
        symbol:
          OID: 1.3.6.1.2.1.2.2.1.3
          name: ifType
        mapping_ref: ifType
  - MIB: IF-MIB
    table:
      OID: 1.3.6.1.2.1.31.1.1
      name: ifXTable
    symbols:
      - OID: 1.3.6.1.2.1.31.1.1.1.6
        name: ifHCInOctets
        chart_meta:
          description: Total number of octets received on the interface including framing characters
          family: 'Network/Interface/Traffic/Total/In'
          unit: "bit/s"
        scale_factor: 8 # octets => bits
      - OID: 1.3.6.1.2.1.31.1.1.1.10
        name: ifHCOutOctets
        chart_meta:
          description: Total number of octets transmitted out of the interface including framing characters
          family: 'Network/Interface/Traffic/Total/Out'
          unit: "bit/s"
        scale_factor: 8 # octets => bits
      - OID: 1.3.6.1.2.1.31.1.1.1.7
        name: ifHCInUcastPkts
        chart_meta:
          description: Number of packets delivered by this sub-layer to a higher layer which were not addressed to a multicast or broadcast address
          family: 'Network/Interface/Packet/Unicast/In'
          unit: "{packet}/s"
      - OID: 1.3.6.1.2.1.31.1.1.1.8
        name: ifHCInMulticastPkts
        chart_meta:
          description: Number of packets delivered by this sub-layer to a higher layer which were addressed to a multicast address
          family: 'Network/Interface/Packet/Multicast/In'
          unit: "{packet}/s"
      - OID: 1.3.6.1.2.1.31.1.1.1.9
        name: ifHCInBroadcastPkts
        chart_meta:
          description: Number of packets delivered by this sub-layer to a higher layer which were addressed to a broadcast address
          family: 'Network/Interface/Packet/Broadcast/In'
          unit: "{packet}/s"
      - OID: 1.3.6.1.2.1.31.1.1.1.11
        name: ifHCOutUcastPkts
        chart_meta:
          description: Total number of packets that higher-level protocols requested be transmitted and which were not addressed to a multicast or broadcast address
          family: 'Network/Interface/Packet/Unicast/Out'
          unit: "{packet}/s"
      - OID: 1.3.6.1.2.1.31.1.1.1.12
        name: ifHCOutMulticastPkts
        chart_meta:
          description: Total number of packets that higher-level protocols requested be transmitted and which were addressed to a multicast address
          family: 'Network/Interface/Packet/Multicast/Out'
          unit: "{packet}/s"
      - OID: 1.3.6.1.2.1.31.1.1.1.13
        name: ifHCOutBroadcastPkts
        chart_meta:
          description: Total number of packets that higher-level protocols requested be transmitted and which were addressed to a broadcast address
          family: 'Network/Interface/Packet/Broadcast/Out'
          unit: "{packet}/s"
      - OID: 1.3.6.1.2.1.31.1.1.1.15
        name: ifHighSpeed
        chart_meta:
          description: Estimate of the interface's current bandwidth
          family: 'Network/Interface/Speed'
          unit: "bit/s"
        scale_factor: 1000000 # Megabits => bits
    metric_tags:
      - tag: interface
        symbol:
          OID: 1.3.6.1.2.1.31.1.1.1.1
          name: ifName
      - tag: interface
        table: ifTable
        symbol:
          OID: 1.3.6.1.2.1.2.2.1.2
          name: ifDescr
      - tag: _if_type
        table: ifTable
        symbol:
          OID: 1.3.6.1.2.1.2.2.1.3
          name: ifType
        mapping_ref: ifType

virtual_metrics:
  - name: ifTotalTrafficIn
    sources:
      - metric: ifHCInOctets
        table: ifXTable
    chart_meta:
      description: Total inbound traffic across all interfaces
      family: 'Network/Total/Traffic/In'
      unit: "bit/s"
  - name: ifTotalTrafficOut
    sources:
      - metric: ifHCOutOctets
        table: ifXTable
    chart_meta:
      description: Total outbound traffic across all interfaces
      family: 'Network/Total/Traffic/Out'
      unit: "bit/s"
  - name: ifTotalOperStatus
    sources:
      - metric: ifOperStatus
        table: ifTable
    chart_meta:
      description: Total count of interfaces by operational status
      family: 'Network/Total/Interface/Status'
      unit: "{status}"