| 1 | <!--startmeta |
| 2 | custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/integrations/softnet_statistics.md" |
| 3 | meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/metadata.yaml" |
| 4 | sidebar_label: "Softnet Statistics" |
| 5 | learn_status: "Published" |
| 6 | learn_rel_path: "Collecting Metrics/Collectors/Networking" |
| 7 | keywords: ['softnet'] |
| 8 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" |
| 9 | endmeta--> |
| 10 | |
| 11 | # Softnet Statistics |
| 12 | |
| 13 | |
| 14 | <img src="https://netdata.cloud/img/linuxserver.svg" width="150"/> |
| 15 | |
| 16 | |
| 17 | Plugin: proc.plugin |
| 18 | Module: /proc/net/softnet_stat |
| 19 | |
| 20 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 21 | |
| 22 | ## Overview |
| 23 | |
| 24 | `/proc/net/softnet_stat` provides statistics that relate to the handling of network packets by softirq. |
| 25 | |
| 26 | It provides information about: |
| 27 | |
| 28 | - Total number of processed packets (`processed`). |
| 29 | - Times ksoftirq ran out of quota (`dropped`). |
| 30 | - Times net_rx_action was rescheduled. |
| 31 | - Number of times processed all lists before quota. |
| 32 | - Number of times did not process all lists due to quota. |
| 33 | - Number of times net_rx_action was rescheduled for GRO (Generic Receive Offload) cells. |
| 34 | - Number of times GRO cells were processed. |
| 35 | |
| 36 | Monitoring the /proc/net/softnet_stat file can be useful for: |
| 37 | |
| 38 | - **Network performance monitoring**: By tracking the total number of processed packets and how many packets |
| 39 | were dropped, you can gain insights into your system's network performance. |
| 40 | |
| 41 | - **Troubleshooting**: If you're experiencing network-related issues, this collector can provide valuable clues. |
| 42 | For instance, a high number of dropped packets may indicate a network problem. |
| 43 | |
| 44 | - **Capacity planning**: If your system is consistently processing near its maximum capacity of network |
| 45 | packets, it might be time to consider upgrading your network infrastructure. |
| 46 | |
| 47 | |
| 48 | |
| 49 | |
| 50 | This collector is supported on all platforms. |
| 51 | |
| 52 | This collector supports collecting metrics from multiple instances of this integration, including remote instances. |
| 53 | |
| 54 | |
| 55 | ### Default Behavior |
| 56 | |
| 57 | #### Auto-Detection |
| 58 | |
| 59 | This integration doesn't support auto-detection. |
| 60 | |
| 61 | #### Limits |
| 62 | |
| 63 | The default configuration for this integration does not impose any limits on data collection. |
| 64 | |
| 65 | #### Performance Impact |
| 66 | |
| 67 | The default configuration for this integration is not expected to impose a significant performance impact on the system. |
| 68 | |
| 69 | ## Setup |
| 70 | |
| 71 | |
| 72 | ### Prerequisites |
| 73 | |
| 74 | No action required. |
| 75 | |
| 76 | ### Configuration |
| 77 | |
| 78 | #### Options |
| 79 | |
| 80 | |
| 81 | |
| 82 | There are no configuration options. |
| 83 | |
| 84 | |
| 85 | |
| 86 | #### via File |
| 87 | |
| 88 | There is no configuration file. |
| 89 | |
| 90 | ##### Examples |
| 91 | There are no configuration examples. |
| 92 | |
| 93 | |
| 94 | |
| 95 | ## Alerts |
| 96 | |
| 97 | |
| 98 | The following alerts are available: |
| 99 | |
| 100 | | Alert name | On metric | Description | |
| 101 | |:------------|:----------|:------------| |
| 102 | | [ 1min_netdev_backlog_exceeded ](https://github.com/netdata/netdata/blob/master/src/health/health.d/softnet.conf) | system.softnet_stat | average number of dropped packets in the last minute due to exceeded net.core.netdev_max_backlog | |
| 103 | | [ 1min_netdev_budget_ran_outs ](https://github.com/netdata/netdata/blob/master/src/health/health.d/softnet.conf) | system.softnet_stat | average number of times ksoftirq ran out of sysctl net.core.netdev_budget or net.core.netdev_budget_usecs with work remaining over the last minute (this can be a cause for dropped packets) | |
| 104 | |
| 105 | |
| 106 | ## Metrics |
| 107 | |
| 108 | Metrics grouped by *scope*. |
| 109 | |
| 110 | The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. |
| 111 | |
| 112 | |
| 113 | |
| 114 | ### Per Softnet Statistics instance |
| 115 | |
| 116 | |
| 117 | |
| 118 | This scope has no labels. |
| 119 | |
| 120 | Metrics: |
| 121 | |
| 122 | | Metric | Dimensions | Unit | |
| 123 | |:------|:----------|:----| |
| 124 | | system.softnet_stat | processed, dropped, squeezed, received_rps, flow_limit_count | events/s | |
| 125 | |
| 126 | ### Per cpu core |
| 127 | |
| 128 | |
| 129 | |
| 130 | This scope has no labels. |
| 131 | |
| 132 | Metrics: |
| 133 | |
| 134 | | Metric | Dimensions | Unit | |
| 135 | |:------|:----------|:----| |
| 136 | | cpu.softnet_stat | processed, dropped, squeezed, received_rps, flow_limit_count | events/s | |
| 137 | |
| 138 |