Metrics
The following sFlow counter based metrics are supported by sFlow-RT. However, the subset of available metrics will depend on the sources of sFlow data and can be queried using
REST API /metrics/ or JavaScript metrics() function.
New metrics can be created by Defining Flows
or by sending Custom Metrics.
Interface Identification
| Name | Comment |
|---|
| of_dpid | OpenFlow datapath id |
| of_port | OpenFlow port number |
| ifname | OpenFlow port name or SNMP ifName |
Generic Interface Metrics
| Name | Comment |
|---|
| ifindex | ifIndex |
| ifinoctets | ifInOctets |
| iftype | ifType: ethernetCsmacd | iso88023Csmacd | ... |
| ifspeed | ifSpeed |
| ifdirection | ifDirection: unknown | full-duplex | half-duplex | in | out |
| ifadminstatus | ifAdminStatus: up | down |
| ifoperstatus | ifOperStatus: up | down |
| ifinoctets | ifInOctets |
| ifinucastpkts | ifInUcastPkts |
| ifinmulticastpkts | ifInMulticastPkts |
| ifinbroadcastpkts | ifInBroadcastPkts |
| ifindiscards | ifInDiscards |
| ifinerrors | ifInErrors |
| ifinunknownprotos | ifInUnknownProtos |
| ifinutilization | ifinoctets * 800 / ifspeed |
| ifinoctets | ifInOctets |
| ifinpkts | ifinucastpkts + ifinmulticastpkts + ifinbroadcastpkts |
| ifoutoctets | ifOutOctets |
| ifoutucastpkts | ifOutUcastPkts |
| ifoutmulticastpkts | ifOutMulticastPkts |
| ifoutbroadcastpkts | ifOutBroadcastPkts |
| ifoutdiscards | ifOutDiscards |
| ifouterrors | ifOutErrors |
| ifoututilization | ifoutoctets * 800 / ifspeed |
| ifoutpkts | ifoutucastpkts + ifoutmulticastpkts + ifoutbroadcastpkts |
Ethernet Interface Metrics
| Name | Comment |
|---|
| eth_alignmenterrors | dot3StatsAlignmentErrors |
| eth_fcserrors | dot3StatsFCSErrors |
| eth_singlecollisions | dot3StatsSingleCollisionFrames |
| eth_multiplecollisions | dot3StatsMultipleCollisionFrames |
| eth_sqetesterrors | dot3StatsSQETestErrors |
| eth_deferredtx | dot3StatsDeferredTransmissions |
| eth_latecollision | dot3StatsLateCollisions |
| eth_excessivecollisions | dot3StatsExcessiveCollisions |
| eth_internalmactxerrors | dot3StatsInternalMacTransmitErrors |
| eth_carriersenseerrors | dot3StatsCarrierSenseErrors |
| eth_toolongs | dot3StatsFrameTooLongs |
| eth_internalmacrxerrors | dot3StatsInternalMacReceiveErrors |
| eth_symbolerrors | dot3StatsSymbolErrors |
WiFi Interface Metrics
| Name | Comment |
|---|
| wifi_txfragments | dot11TransmittedFragmentCount |
| wifi_txmulticasts | dot11MulticastTransmittedFrameCount |
| wifi_failures | dot11FailedCount |
| wifi_retries | dot11RetryCount |
| wifi_multiretries | dot11MultipleRetryCount |
| wifi_duplicates | dot11FrameDuplicateCount |
| wifi_rtssuccesses | dot11RTSSuccessCount |
| wifi-rtsfailures | dot11RTSFailureCount |
| wifi_ackfailures | dot11ACKFailureCount |
| wifi_rxfragments | dot11ReceivedFragmentCount |
| wifi_rxmulticasts | dot11MulticastReceivedFrameCount |
| wifi_fcserrors | dot11FCSErrorCount |
| wifi_txframes | dot11TransmittedFrameCount |
| wifi_wepunencryptable | dot11WEPUndecryptableCount |
| wifi_qosdiscardedfragments | dot11QoSDiscardedFragmentCount |
| wifi_associations | dot11AssociatedStationCount |
| wifi_qoscfprx | dot11QoSCFPollsReceivedCount |
| wifi_qoscfpunused | dot11QoSCFPollsUnusedCount |
| wifi_qoscfpunuseable | dot11QoSCFPollsUnusableCount |
| wifi_qoscfplost | dot11QoSCFPollsLostCount |
| radio_on_channel | time in ms spent on channel |
| radio_on_channel_busy | time in ms spent on channel and busy |
LAG Interface Metrics
See Link aggregation for discussion of sFlow LAG reporting.
| Name | Comment |
|---|
| agg_actorsystemid | dot3adAggPortActorSystemID |
| agg_partneropersystemid | dot3adAggPortPartnerOperSystemID |
| agg_attachedaggid | dot3adAggPortAttachedAggID |
| agg_actoradminstate | dot3adAggPortActorAdminState |
| agg_actoroperstate | dot3adAggPortActorOperState |
| agg_partneradminstate | dot3adAggPortPartnerAdminState |
| agg_partneroperstate | dot3adAggPortPartnerOperState |
| agg_lacpdusrx | dot3adAggPortStatsLACPDUsRx |
| agg_markerpdusrx | dot3adAggPortStatsMarkerPDUsRx |
| agg_markerresponsepdusrx | dot3adAggPortStatsMarkerResponsePDUsRx |
| agg_unknownrx | dot3adAggPortStatsUnknownRx |
| agg_illegalrx | dot3adAggPortStatsIllegalRx |
| agg_lacppdustx | dot3adAggPortStatsLACPDUsTx |
| agg_markerpdustx | dot3adAggPortStatsMarkerPDUsTx |
| agg_markerresponsepdustx | dot3adAggPortStatsMarkerResponsePDUsTx |
Optical Interface Metrics
See Lasers! for
discussion of optical monitoring.
| Name | Comment |
|---|
| opt_module_id | Integer identifying optics module within device |
| opt_module_lanes | Total number of optical lanes in module |
| opt_module_voltage | Module supply voltage (mW) |
| opt_module_temperature | Module temperature (thousandths of a degree Celsius |
| opt_num_lanes | Number of lanes associated with this switch port |
| opt_index_<N> | 1-based index of lane within module, 0=unknown |
| opt_tx_bias_<N> | Lane N transmit bias (microamps) |
| opt_tx_power_<N> | Lane N transmit power (microwatts) |
| opt_tx_power_min_<N> | Lane N min transmit power limit (microwatts) |
| opt_tx_power-max_<N> | Lane N max transmit power limit (microwatts) |
| opt_tx_wavelength_<N> | Lane N transmit wavelength (nanometers) |
| opt_rx_power_<N> | Lane N receive power (microwatts) |
| opt_rx_power_min_<N> | Lane N min receive power limit (microwatts) |
| opt_rx_power_max_<N> | Lane N max receive power limit (microwatts) |
| opt_rx_wavelength_<N> | Lane N receive wavelength (nanometers) |
Switch Processor Metrics
| Name | Comment |
|---|
| cpu_5sec | 5 second average CPU utilization |
| cpu_1min | 1 minute average CPU utilization |
| cpu_5min | 5 minute average CPU utilization |
| mem_free | total memory (in bytes) |
| mem_total | free memory (in bytes) |
| mem_utilization | 100 * (mem_total - mem_free) / mem_total |
Host Identification
| Name | Comment |
|---|
| host_name | |
| os_release | |
| uuid | |
| machine_type | unknown | other | x86 | x86_64 | powerpc | arm | ... |
| os_name | unknown | other | linux | windows | ... |
VM Identification
| Name | Comment |
|---|
| vir_host_name | |
| vir_os_release | |
| vir_uuid | |
| vir_machine_type | unknown | other | x86 | x86_64 | powerpc | arm | ... |
| vir_os_name | unknown | other | linux | windows | ... |
| host_parent | |
Host CPU Metrics
| Name | Comment |
|---|
| load_one | |
| load_five | |
| load_fifteen | |
| proc_run |
|
| proc_total | |
| cpu_num | |
| cpu_speed | |
| uptime |
|
| cpu_user | |
| cpu_nice | |
| cpu_system | |
| cpu_idle | |
| cpu_wio | |
| cpu_intr | |
| cpu_sintr | |
| cpu_utilization | |
| interrupts | |
| contexts | |
| cpu_steal | |
| cpu_guest | |
| cpu_guest_nice | |
| load_one_per_cpu | |
| load_five_per_cpu | |
| load_fifteen_per_cpu | |
Host Memory Metrics
| Name | Comment |
|---|
| mem_total | |
| mem_free | |
| mem_shared | |
| mem_buffers | |
| mem_cached | |
| swap_total | |
| swap_free | |
| page_in | |
| page_out | |
| swap_in | |
| mem_utilization | 100 * (mem_total - mem_free - mem_buffers - mem_cached) / mem_total |
Host Disk I/O Metrics
| Name | Comment |
|---|
| disk_total | |
| disk_free | |
| part_max_used | |
| reads | |
| bytes_read | |
| read_time | |
| writes | |
| bytes_written | |
| write_time | |
| disk_utilization | 100 * (disk_total - disk_free) / disk_total |
Host Network I/O Metrics
| Name | Comment |
|---|
| bytes_in | |
| pkts_in | |
| errs_in | |
| drops_in | |
| bytes_out | |
| pkts_out | |
| errs_out | |
| drops_out | |
Host IP Metrics
| Name | Comment |
|---|
| ip_forwarding | |
| ip_defaultttl | |
| ip_inreceives | |
| ip_inhdrerrors | |
| ip_inaddrerrors | |
| ip_forwdatagrams | |
| ip_inunknownprotos | |
| ip_indiscards | |
| ip_indelivers | |
| ip_outrequests | |
| ip_outdiscards | |
| ip_outnoroutes | |
| ip_reasmtimeout | |
| ip_reasmreqds | |
| ip_reasmoks | |
| ip_reasmfails | |
| ip_fragoks | |
| ip_fragfails | |
| ip_fragcreates | |
Host ICMP Metrics
| Name | Comment |
|---|
| icmp_inmsgs | |
| icmp_inerrors | |
| icmp_indestunreachs | |
| icmp_intimeexcds | |
| icmp_inparamprobs | |
| icmp_insrcquenchs | |
| icmp_inredirects | |
| icmp_inechos | |
| icmp_inechoreps | |
| icmp_intimestamps | |
| icmp_inaddrmasks | |
| icmp_inaddrmaskreps | |
| icmp_outmsgs | |
| icmp_outerrors | |
| icmp_outdestunreachs | |
| icmp_outtimeexcds | |
| icmp_outparamprobs | |
| icmp_outsrcquenchs | |
| icmp_outredirects | |
| icmp_outechos | |
| icmp_outechoreps | |
| icmp_outtimestamps | |
| icmp_outtimestampreps | |
| icmp_outaddrmasks | |
| icmp_outaddrmaskreps | |
Host TCP Metrics
| Name | Comment |
|---|
| tcp_rtoalgorithm | |
| tcp_rtomin | |
| tcp_rtomax | |
| tcp_maxconn | |
| tcp_activeopens | |
| tcp_passiveopens | |
| tcp_attemptfails | |
| tcp_estabresets | |
| tcp_currestab | |
| tcp_insegs | |
| tcp_outsegs | |
| tcp_retranssegs | |
| tcp_inerrs | |
| tcp_outrsts | |
| tcp_incsumerrs | |
Host UDP Metrics
| Name | Comment |
|---|
| udp_indatagrams | |
| udp_noports | |
| udp_inerrors | |
| udp_outdatagrams | |
| udp_rcvbuferrors | |
| udp_sndbuferrors | |
| udp_incsumerrors | |
Host Virtualization Node Metrics
| Name | Comment |
|---|
| node_cpu_mhz | |
| node_cpus | |
| node_mem_total | |
| node_mem_free | |
| node_domains | |
Virtual Machine CPU Metrics
| Name | Comment |
|---|
| vir_cpu_state | nostate | running | blocked | ... |
| vir_cpu_utilization | |
| vir_cpu_num | |
Virtual Machine Memory Metrics
| Name | Comment |
|---|
| vir_mem_used | |
| vir_mem_total | |
| vir_mem_free | |
| vir_mem_utilization | |
Virtual Machine Disk I/O Metrics
| Name | Comment |
|---|
| vir_disk_capacity | |
| vir_disk_allocation | |
| vir_disk_physical | |
| vir_reads | |
| vir_bytes_read | |
| vir_writes | |
| vir_bytes_written | |
| vir_errors | |
Virtual Machine Network I/O Metrics
| Name | Comment |
|---|
| vir_bytes_in | |
| vir_pkts_in | |
| vir_errs_in | |
| vir_drops_in | |
| vir_bytes_out | |
| vir_pkts_out | |
| vir_errs_out | |
| vir_drops_out | |
Java Virtual Machine Metrics
See sFlow Blog for articles on Java sFlow
| Name | Comment |
|---|
| jvm_name | |
| jvm_vendor | |
| jvm_version | |
| jvm_heap_initial | |
| jvm_heap_used | |
| jvm_heap_committed | |
| jvm_heap_max | |
| jvm_non_heap_initial | |
| jvm_non_heap_used | |
| jvm_non_heap_committed | |
| jvm_non_heap_max | |
| jvm_gc_count | |
| jvm_gc_utilization | |
| jvm_compilation_utilization | |
| jvm_classes_loaded | |
| jvm_classes_unloaded | |
| jvm_classes_total | |
| jvm_thread_live | |
| jvm_thread_daemon | |
| jvm_thread_started | |
| jvm_fds_open | |
| jvm_fds_max | |
HTTP Metrics
See sFlow Blog for articles on HTTP sFlow
| Name | Comment |
|---|
| http_method_option | |
| http_method_get | |
| http_method_head | |
| http_method_post | |
| http_method_put | |
| http_method_delete | |
| http_method_trace | |
| http_method_connect | |
| http_method_other | | |
| http_status_1xx | |
| http_status_2xx | |
| http_status_3xx | |
| http_status_4xx | |
| http_status_5xx | |
| http_status_other | |
| http_requests | |
Generic Application Metrics
| Name | Comment |
|---|
| app_success | |
| app_other | |
| app_timeout | |
| app_internal_error | |
| app_bad_request | |
| app_forbidden | |
| app_too_large | |
| app_not_implemented | |
| app_not_found | |
| app_unavailable | |
| app_unauthorized | |
| app_requests | |
Application Resource Metrics
| Name | Comment |
|---|
| app_usertime | |
| app_systime | |
| app_mem_used | |
| app_mem_max | |
| app_mem_utilization | |
| app_fd_open | |
| app_fd_max | |
| app_fd_utilization | |
| app_conn_open | |
| app_conn_max | |
| app_conn_utilization | |
Application Worker Pool Metrics
See Thread pools for discussion of sFlow worker pool reporting.
| Name | Comment |
|---|
| workers_active | The number of threads in the thread pool that are actively processing a reques |
| workers_idle | The number of threads in the thread pool that are waiting for a request |
| workers_max | The maximum number of threads that can exist in the thread pool |
| workers_utilization | 100 * workers_active / workers_max |
| req_delayed | The number of tasks that could not be served immediately, but spent time in the task queue |
| req_dropped | The number of tasks that were dropped because the task queue was full |
Open vSwitch Datapath Metrics
See Open vSwitch performance monitoring for discussion of sFlow datapath metrics.
| Name | Comment |
|---|
| ovs_dp_hits | Datapath cache packet hits |
| ovs_dp_misses | Datapath cache packet misses |
| ovs_dp_lost | Datapath packets lost |
| ovs_dp_hitrate | 100 * ovs_dp_hits / (ovs_dp_hits + ovs_dp_misses) |
| ovs_dp_missrate | 100 * ovs_dp_misses / (ovs_dp_hits + ovs_dp_misses) |
| ovs_dp_flows | Size of datapath cache |
| ovs_dp_masks | Number of mask entries |
| ovs_dp_mask_hits | Number packets matched by masks |
| ovs_dp_maskhitsperpacket | ovs_dp_mask_hits / (ovs_dp_hits + ovs_dp_misses) |
Memcache Metrics
See sFlow Blog for articles on Memcache sFlow.
| Name | Comment |
|---|
| memcache_cmdset | |
| memcache_cmdtouch | |
| memcache_cmdflush | |
| memcache_gethits | |
| memcache_getmisses | |
| memcache_deletehits | |
| memcache_deletemisses | |
| memcache_incrhits | |
| memcache_incrmisses | |
| memcache_decrhits | |
| memcache_decrmisses | |
| memcache_cashits | |
| memcache_casmisses | |
| memcache_casbadval | |
| memcache_authcmds | |
| memcache_autherrors | |
| memcache_threads | |
| memcache_connectionyields | |
| memcache_listendisabled | |
| memcache_currentconnections | |
| memcache_rejectedconnections | |
| memcache_connections | |
| memcache_connectionstructures | |
| memcache_evictions | |
| memcache_reclaimed | |
| memcache_currentitems | |
| memcache_totalitems | |
| memcache_bytesread | |
| memcache_byteswritted | |
| memcache_bytes | |
| memcache_maxbytes | |
| memcache_requests | |
| memcache_hitrate | |
| memcache_missrate | |
NVIDIA NVML
See GPU performance monitoring for a discussion of GPU metrics
| Name | Comment |
|---|
| nvml_devicecount | see nvmlDeviceGetCount |
| nvml_processes | see nvmlDeviceGetComputeRunningProcesses |
| nvml_gputime | total milliseconds in which one or more kernels was executing on GPU, sum across all devices, divide by elapsed milliseconds, expressed as a percentage |
| nvml_memtime | total milliseconds during which global device memory was being read/written, sum across all devices, divide by elapsed milliseconds, expressed as a percentage |
| nvml_memtotal | sum of framebuffer memory across devices, see nvmlDeviceGetMemoryInfo |
| nvml_memfree | sum of free framebuffer memory across devices, see nvmlDeviceGetMemoryInfo |
| nvml_memused | nvml_memtotal - nvml_memused |
| nvml_memutilization | 100 * nvml_memused / nvml_memtotal |
| nvml_eccerrors | sum of volatile ECC errors across devices, see nvmlDeviceGetTotalEccErrors |
| nvml_power | sum of millijoules across devices, see nvmlDeviceGetPowerUsage |
| nvml_temperature | maximum temperature in degrees Celsius across devices, see nvmlDeviceGetTemperature |
| nvml_fanspeed | maximum fan speed in percent across devices, see nvmlDeviceGetFanSpeed |
Broadcom ASIC Table Utilization Metrics
See Broadcom ASIC table utilization metrics, DevOps, and SDN for a discussion of monitoring Broadcom based switch resources using sFlow.
| Name | Comment |
|---|
| bcm_host_entries | |
| bcm_host_entries_max | |
| bcm_host_utilization | |
| bcm_ipv4_entries | |
| bcm_ipv4_entries_max | |
| bcm_ipv4_utilization | |
| bcm_ipv6_entries | |
| bcm_ipv6_entries_max | |
| bcm_ipv6_utilization | |
| bcm_ipv4_ipv6_entries | |
| bcm_ipv4_ipv6_entries_max | |
| bcm_ipv4_ipv6_utilization | |
| bcm_long_ipv6_entries | |
| bcm_long_ipv6_entries_max | |
| bcm_long_ipv6_utilization | |
| bcm_total_routes | |
| bcm_total_routes_max | |
| bcm_total_routes_utilization | |
| bcm_ecmp_nexthops | |
| bcm_ecmp_nexthops_max | |
| bcm_ecmp_nexthops_utilization | |
| bcm_mac_entries | |
| bcm_mac_entries_max | |
| bcm_mac_utilization | |
| bcm_ipv4_neighbors | |
| bcm_ipv6_neighbors | |
| bcm_ipv4_routes | |
| bcm_ipv6_routes | |
| bcm_acl_ingress_entries | |
| bcm_acl_ingress_entries_max | |
| bcm_acl_ingress_utilization | |
| bcm_acl_ingress_counters | |
| bcm_acl_ingress_counters_max | |
| bcm_acl_ingress_counters_utilization | |
| bcm_acl_ingress_meters | |
| bcm_acl_ingress_meters_max | |
| bcm_acl_ingress_meters_utilization | |
| bcm_acl_ingress_slices | |
| bcm_acl_ingress_slices_max | |
| bcm_acl_ingress_slices_utilization | |
| bcm_acl_egress_entries | |
| bcm_acl_egress_entries_max | |
| bcm_acl_egress_utilization | |
| bcm_acl_egress_counters | |
| bcm_acl_egress_counters_max | |
| bcm_acl_egress_counters_utilization | |
| bcm_acl_egress_meters | |
| bcm_acl_egress_meters_max | |
| bcm_acl_egress_meters_utilization | |
| bcm_acl_egress_slices | |
| bcm_acl_egress_slices_max | |
| bcm_acl_egress_slices_utilization | |