Out-of-the-box KPIs for performance metrics

This section outlines the default Key Performance Indicators (KPIs) available for monitoring network and device performance in Cisco Crosswork Network Controller. These out-of-the-box KPIs provide predefined metrics that enable you to track network components. The table in this section present each KPI with its name, the version of Cisco Crosswork Network Controller in which it became available, and a brief description of its function.

Out-of-the-box KPIs for performance metrics

Table 1. Built-in Performance Metrics and KPIs

Name

Available since

KPIs

Description

Interface Health 7.0 crcDuration (milliseconds) Sample interval
crcPercentage (0% to 100%) CRC errors as percentage
crc (packets per second) CRC error rate
Interface Health - Stats 7.0 ifSpeed (bits per second) Interface speed
interfaceDuration (milliseconds) Sample interval
ifAdminDown (percentage) Admin down (1=down, x100)
ifAdminUpOperDown (0% to 100%) Admin up, oper down
ifAdminUpOperUp (0% to 100%) Admin and oper up
ifInBitsRate (bits per second) Ingress traffic rate
ifInUtilization (0% to 100%) Ingress utilization
ifInPktsRate (packets per second) Ingress packet rate
ifInDiscardsRate (packets per second) Ingress drop rate
ifInDiscardsPercent (0% to 100%) Ingress drop percentage
ifInErrorsRate (packets per second) Ingress error rate
ifInErrorsPercent (0% to 100%) Ingress error percentage
ifOutBitsRate (bits per second) Egress traffic rate
ifOutUtilization (0% to 100%) Egress utilization
ifOutPktsRate (packets per second) Egress packet rate
ifOutErrorsRate (packets per second) Egress error rate
ifOutErrorsPercent (0% to 100%) Egress error percentage
ifOutDiscardsRate (packets per second) Egress drop rate
ifOutDiscardsPercent (0% to 100%) Egress drop percentage
Device Health CPU 7.0 cpuUtilization (0% to 100%) CPU usage
Device Health Availability 7.0 deviceAvailability (0% to 100%) Device availability
lastRebootTime (epoch time) Last reboot time
deviceAvailabilityDuration (milliseconds) Sample interval
Device Health Temperature 7.0 isInlet (boolean) Inlet sensor indicator (1 = inlet)
envTemperature (Celsius x100) Environment temperature
Device Health - Memory 7.0 memoryUtilization (0% to 100%) Memory usage
memoryPoolUsed (bytes) Used memory bytes
memoryPoolFree (bytes) Free memory bytes
OPTICALSFP 7.0 temperature (Celcius) Optical module temperature
voltage (Volts) Module voltage
txBias (milliamps) Transmit bias current
txPower (dBm) Transmit optical power
rxPower (dBm) Receive optical power
OPTICSLANE 7.0 receivePower (dBm) Average receive power
minReceivePower(dBm) Minimum receive power
maxReceivePower(dBm) Maximum receive power
transmitPower (dBm) Average transmit power
minTransmitPower (dBm) Minimum transmit power
maxTransmitPower (dBm) Maximum transmit power
OTUCONTROLLERSINF 7.0 preFecBer (bits per second) Pre-FEC Bit Error Rate
postFecBer (bits per second) Post-FEC Bit Error Rate
qmargin (dBQ) Q-margin
qfactor (dB) Q-factor
ec (bits per second) Corrected bit errors
uc (number) Uncorrected word count
duration (milliseconds) Sampling interval
LSP Policy 7.0 state (integer) LSP policy state
pathName (string) LSP path name
duration (milliseconds) Sampling interval
outPktsRate (packets per second) Transmitted packet rate
outBitRate (bits per second) Transmitted bit rate
GNSS 7.1 gnssModuleLockStatus (integer) Module lock status
gnssModulePresenceStatus (integer) Module presence status
gnssModuleSlotInfo (integer) Module slot info
gnssModuleSlotState (integer) Module slot state
gnssSatelliteVisibilityStatus (number) Satellite visibility
gnssModuleSatelliteCount (number) Satellite count
gnssAntennaShortAlarmStatus (integer) Antenna short alarm
gnssAntennaOpenAlarmStatus (integer) Antenna open alarm
gnssModuleSvIdSNR (dB (string)) Module SNR
PTP 7.1 ptpClockPortName (string) Clock port name
ptpClockPortRole (integer) Port role (client/server)
ptpClockClass(0 to 255) Grandmaster clock quality class
ptpClockState (1 to 5) PTP clock state
ptpClockAssociatedPorts (integer) Associated peers
ptpClockUTCOffset (0 to 65535) UTC offset
SYNCE 7.1 syncEqualityLevelInput (1 to 36) Input clock quality level
syncEPriority Input clock source priority