| 1 | plugin_name: network-viewer.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-network-viewer.plugin |
| 5 | plugin_name: network-viewer.plugin |
| 6 | module_name: network-viewer.plugin |
| 7 | monitored_instance: |
| 8 | name: Network Connections |
| 9 | link: "" |
| 10 | categories: |
| 11 | - data-collection.networking |
| 12 | icon_filename: network.svg |
| 13 | alternative_monitored_instances: [] |
| 14 | keywords: |
| 15 | - network |
| 16 | - connections |
| 17 | - sockets |
| 18 | - tcp |
| 19 | - udp |
| 20 | - ports |
| 21 | - freebsd |
| 22 | related_resources: |
| 23 | integrations: |
| 24 | list: [] |
| 25 | info_provided_to_referring_integrations: |
| 26 | description: "" |
| 27 | overview: |
| 28 | data_collection: |
| 29 | metrics_description: "" |
| 30 | method_description: | |
| 31 | This plugin reads the system's socket tables to enumerate all active network connections, |
| 32 | including TCP and UDP sockets in all states, for both IPv4 and IPv6. |
| 33 | |
| 34 | On Linux it consumes `NETLINK_INET_DIAG` and the `/proc` socket tables; |
| 35 | on FreeBSD it walks `KERN_PROC_FILEDESC` and consults `net.inet.tcp.pcblist` |
| 36 | to attribute sockets to processes. |
| 37 | supported_platforms: |
| 38 | include: |
| 39 | - Linux |
| 40 | - FreeBSD |
| 41 | exclude: [] |
| 42 | multi_instance: false |
| 43 | additional_permissions: |
| 44 | description: "" |
| 45 | default_behavior: |
| 46 | auto_detection: |
| 47 | description: | |
| 48 | The plugin automatically detects all active network connections on the system. |
| 49 | limits: |
| 50 | description: "" |
| 51 | performance_impact: |
| 52 | description: "" |
| 53 | setup: |
| 54 | prerequisites: |
| 55 | list: [] |
| 56 | configuration: |
| 57 | file: |
| 58 | name: "" |
| 59 | options: |
| 60 | description: "" |
| 61 | folding: |
| 62 | title: "" |
| 63 | enabled: false |
| 64 | list: [] |
| 65 | examples: |
| 66 | folding: |
| 67 | enabled: false |
| 68 | title: "" |
| 69 | list: [] |
| 70 | troubleshooting: |
| 71 | problems: |
| 72 | list: [] |
| 73 | alerts: [] |
| 74 | metrics: |
| 75 | folding: |
| 76 | title: Metrics |
| 77 | enabled: false |
| 78 | description: "" |
| 79 | availability: [] |
| 80 | scopes: [] |
| 81 | functions: |
| 82 | description: | |
| 83 | This plugin exposes real-time functions for viewing active network connections and, |
| 84 | on FreeBSD, system-wide TCP and UDP stack statistics. |
| 85 | list: |
| 86 | - id: network-connections |
| 87 | name: Network Connections |
| 88 | description: | |
| 89 | Shows active network connections with protocol details, states, addresses, ports, and performance metrics. |
| 90 | |
| 91 | Provides both aggregated and detailed views of TCP and UDP connections for IPv4 and IPv6, |
| 92 | including connection direction (listen, inbound, outbound, local), process information, |
| 93 | and TCP performance metrics (RTT, retransmissions). |
| 94 | |
| 95 | On Linux, connections are classified as system or container based on network namespace. |
| 96 | On FreeBSD, namespaces are not exposed to userspace and the classification is omitted. |
| 97 | parameters: [] |
| 98 | returns: |
| 99 | description: "" |
| 100 | columns: [] |
| 101 | performance: "" |
| 102 | security: "" |
| 103 | availability: "" |
| 104 | - id: network-protocols |
| 105 | name: Network Protocols |
| 106 | description: | |
| 107 | Shows FreeBSD TCP and UDP stack statistics grouped by transport protocol. |
| 108 | |
| 109 | Each row covers one transport (TCP or UDP) and reports IPv4+IPv6 combined |
| 110 | traffic counters (received, sent, errors), TCP-specific connection counters |
| 111 | (active opens, currently established, passive opens, resets, total segments, |
| 112 | retransmitted segments), and the UDP-specific datagrams-with-no-port counter. |
| 113 | |
| 114 | Values are per-second deltas sampled from `net.inet.tcp.stats`, |
| 115 | `net.inet.tcp.states`, and `net.inet.udp.stats`. The first call after the |
| 116 | plugin starts returns zeros because there is no previous sample to diff against. |
| 117 | parameters: [] |
| 118 | returns: |
| 119 | description: "" |
| 120 | columns: [] |
| 121 | performance: "" |
| 122 | security: "" |
| 123 | availability: "FreeBSD only." |
| 124 | - meta: |
| 125 | plugin_name: network-viewer.plugin |
| 126 | module_name: PerflibNetworkProtocols |
| 127 | monitored_instance: |
| 128 | name: Windows Network Protocols |
| 129 | link: "https://learn.microsoft.com/en-us/windows/win32/networking" |
| 130 | categories: |
| 131 | - data-collection.networking |
| 132 | icon_filename: windows.svg |
| 133 | alternative_monitored_instances: [] |
| 134 | keywords: |
| 135 | - network |
| 136 | - tcp |
| 137 | - udp |
| 138 | - windows |
| 139 | - perflib |
| 140 | - segments |
| 141 | - datagrams |
| 142 | related_resources: |
| 143 | integrations: |
| 144 | list: [] |
| 145 | info_provided_to_referring_integrations: |
| 146 | description: "" |
| 147 | overview: |
| 148 | data_collection: |
| 149 | metrics_description: | |
| 150 | This collector exposes TCP and UDP stack statistics on Windows systems via a real-time table function. |
| 151 | method_description: | |
| 152 | It queries the TCPv4, TCPv6, UDPv4, and UDPv6 objects from Windows Perflib, |
| 153 | combining the results into a single table grouped by transport protocol and IP family. |
| 154 | supported_platforms: |
| 155 | include: |
| 156 | - windows |
| 157 | exclude: [] |
| 158 | multi_instance: false |
| 159 | additional_permissions: |
| 160 | description: "" |
| 161 | default_behavior: |
| 162 | auto_detection: |
| 163 | description: | |
| 164 | The collector automatically detects all of the metrics, no further configuration is required. |
| 165 | limits: |
| 166 | description: "" |
| 167 | performance_impact: |
| 168 | description: "" |
| 169 | setup: |
| 170 | prerequisites: |
| 171 | list: [] |
| 172 | configuration: |
| 173 | file: |
| 174 | name: "" |
| 175 | options: |
| 176 | description: "" |
| 177 | folding: |
| 178 | title: "" |
| 179 | enabled: false |
| 180 | list: [] |
| 181 | examples: |
| 182 | folding: |
| 183 | title: "" |
| 184 | enabled: false |
| 185 | list: [] |
| 186 | troubleshooting: |
| 187 | problems: |
| 188 | list: [] |
| 189 | alerts: [] |
| 190 | metrics: |
| 191 | folding: |
| 192 | title: Metrics |
| 193 | enabled: false |
| 194 | description: "" |
| 195 | availability: [] |
| 196 | scopes: [] |
| 197 | functions: |
| 198 | description: | |
| 199 | This collector exposes real-time functions for viewing Windows network connections and TCP/UDP stack statistics. |
| 200 | list: |
| 201 | - id: network-connections |
| 202 | name: Network Connections |
| 203 | description: | |
| 204 | Shows active network connections on Windows with protocol details, states, addresses, |
| 205 | ports, and process information. |
| 206 | |
| 207 | Each row represents one TCP connection or UDP endpoint and includes the socket direction |
| 208 | (listen/inbound/outbound), protocol (tcp4/tcp6/udp4/udp6), TCP state, owning process |
| 209 | (PID and name), username, server port name, local and remote addresses and ports, |
| 210 | address space classification (loopback/private/public/multicast/zero), and server port number. |
| 211 | |
| 212 | Data is collected using the Windows IP Helper API (GetExtendedTcpTable, |
| 213 | GetExtendedUdpTable) with process and user resolution via standard Windows APIs. |
| 214 | parameters: [] |
| 215 | returns: |
| 216 | description: "" |
| 217 | columns: [] |
| 218 | performance: "" |
| 219 | security: "" |
| 220 | availability: "" |
| 221 | - id: network-protocols |
| 222 | name: Network Protocols |
| 223 | description: | |
| 224 | Shows Windows TCP and UDP stack counters grouped by transport protocol (TCP/UDP) |
| 225 | and IP family (IPv4/IPv6). |
| 226 | |
| 227 | Each row covers one transport+family combination (TCPv4, TCPv6, UDPv4, UDPv6) and includes |
| 228 | traffic counters (received, sent, errors), TCP-specific connection counters |
| 229 | (active opens, established, passive opens, resets, total segments, retransmitted segments), |
| 230 | and the UDP-specific datagrams-with-no-port counter. |
| 231 | parameters: [] |
| 232 | returns: |
| 233 | description: "" |
| 234 | columns: [] |
| 235 | performance: "" |
| 236 | security: "" |
| 237 | availability: "" |