Pre-defined KPIs for performance metrics
Crosswork Network Controller includes default KPIs for monitoring device and network performance. These KPIs provide metrics for tracking health, utilization, and service quality. The table lists each KPI, the software release in which it was introduced, and a brief description.
|
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 | ||
|
QoS |
7.2 | classifierName ( string) | Name of the class map |
| direction (interger) | Direction of the policy map (Input - 1, Output -2) | ||
| interfaceName (string) | Interface name | ||
| policyMapName (string) | Name of the policy map | ||
| conformBitsRate (bits per second) | Conformed traffic rate | ||
| conformPktsRate (packets per second) | Conformed packets rate | ||
| dropBitsPercent (%) | Dropped traffic percent | ||
| dropBitsRate (bits per second) | Dropped traffic rate | ||
| dropPktsPercent (%) | Dropped packets percent | ||
| dropPktsRate (packets per second) | Dropped packets rate | ||
| exceedBitsRate (bits per second) | Exceeded traffic rate | ||
| exceedPktsRate (packets per second) | Exceeded packets rate | ||
| matchCos (string) | Matches packets with IEEE 802.1Q/ISL CoS values (0–7). Can be specified between 1 to 4 per line. | ||
| postPolicyBitsRate (bits per second) | Post-policy traffic rate | ||
| prePolicyBitsRate (bits per second) | Pre-policy traffic rate | ||
| prePolicyPktsRate (packets per second) | Pre-policy packets rate | ||
| queueDiscardBitsRate (bits per second) | Queue dropped traffic rate | ||
| queueDiscardPktsRate (packets per second) | Queue dropped packets rate | ||
| sampleDuration (integer) | The sample's interval | ||
| violateBitsRate (bits per second) | Violated traffic rate | ||
| violatePktsRate (packets per second) | Violated packets rate |
Feedback