| 1 | <!--startmeta |
| 2 | custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/integrations/socket_statistics.md" |
| 3 | meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/metadata.yaml" |
| 4 | sidebar_label: "Socket statistics" |
| 5 | learn_status: "Published" |
| 6 | learn_rel_path: "Collecting Metrics/Collectors/Networking" |
| 7 | keywords: ['sockets'] |
| 8 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" |
| 9 | endmeta--> |
| 10 | |
| 11 | # Socket statistics |
| 12 | |
| 13 | |
| 14 | <img src="https://netdata.cloud/img/network-wired.svg" width="150"/> |
| 15 | |
| 16 | |
| 17 | Plugin: proc.plugin |
| 18 | Module: /proc/net/sockstat |
| 19 | |
| 20 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 21 | |
| 22 | ## Overview |
| 23 | |
| 24 | This integration provides socket statistics. |
| 25 | |
| 26 | |
| 27 | |
| 28 | This collector is supported on all platforms. |
| 29 | |
| 30 | This collector supports collecting metrics from multiple instances of this integration, including remote instances. |
| 31 | |
| 32 | |
| 33 | ### Default Behavior |
| 34 | |
| 35 | #### Auto-Detection |
| 36 | |
| 37 | This integration doesn't support auto-detection. |
| 38 | |
| 39 | #### Limits |
| 40 | |
| 41 | The default configuration for this integration does not impose any limits on data collection. |
| 42 | |
| 43 | #### Performance Impact |
| 44 | |
| 45 | The default configuration for this integration is not expected to impose a significant performance impact on the system. |
| 46 | |
| 47 | ## Setup |
| 48 | |
| 49 | |
| 50 | ### Prerequisites |
| 51 | |
| 52 | No action required. |
| 53 | |
| 54 | ### Configuration |
| 55 | |
| 56 | #### Options |
| 57 | |
| 58 | |
| 59 | |
| 60 | There are no configuration options. |
| 61 | |
| 62 | |
| 63 | |
| 64 | #### via File |
| 65 | |
| 66 | There is no configuration file. |
| 67 | |
| 68 | ##### Examples |
| 69 | There are no configuration examples. |
| 70 | |
| 71 | |
| 72 | |
| 73 | ## Alerts |
| 74 | |
| 75 | |
| 76 | The following alerts are available: |
| 77 | |
| 78 | | Alert name | On metric | Description | |
| 79 | |:------------|:----------|:------------| |
| 80 | | [ tcp_orphans ](https://github.com/netdata/netdata/blob/master/src/health/health.d/tcp_orphans.conf) | ipv4.sockstat_tcp_sockets | orphan IPv4 TCP sockets utilization | |
| 81 | | [ tcp_memory ](https://github.com/netdata/netdata/blob/master/src/health/health.d/tcp_mem.conf) | ipv4.sockstat_tcp_mem | TCP memory utilization | |
| 82 | |
| 83 | |
| 84 | ## Metrics |
| 85 | |
| 86 | Metrics grouped by *scope*. |
| 87 | |
| 88 | The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. |
| 89 | |
| 90 | |
| 91 | |
| 92 | ### Per Socket statistics instance |
| 93 | |
| 94 | |
| 95 | |
| 96 | This scope has no labels. |
| 97 | |
| 98 | Metrics: |
| 99 | |
| 100 | | Metric | Dimensions | Unit | |
| 101 | |:------|:----------|:----| |
| 102 | | ip.sockstat_sockets | used | sockets | |
| 103 | | ipv4.sockstat_tcp_sockets | alloc, orphan, inuse, timewait | sockets | |
| 104 | | ipv4.sockstat_tcp_mem | mem | KiB | |
| 105 | | ipv4.sockstat_udp_sockets | inuse | sockets | |
| 106 | | ipv4.sockstat_udp_mem | mem | sockets | |
| 107 | | ipv4.sockstat_udplite_sockets | inuse | sockets | |
| 108 | | ipv4.sockstat_raw_sockets | inuse | sockets | |
| 109 | | ipv4.sockstat_frag_sockets | inuse | fragments | |
| 110 | | ipv4.sockstat_frag_mem | mem | KiB | |
| 111 | |
| 112 |