<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/network-viewer.plugin/integrations/windows_network_protocols.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/network-viewer.plugin/metadata.yaml"
sidebar_label: "Windows Network Protocols"
learn_status: "Published"
learn_rel_path: "Collecting Metrics/Collectors/Networking"
keywords: ['network', 'tcp', 'udp', 'windows', 'perflib', 'segments', 'datagrams']
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
endmeta-->

# Windows Network Protocols


<img src="https://netdata.cloud/img/windows.svg" width="150"/>


Plugin: network-viewer.plugin
Module: PerflibNetworkProtocols

<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />

## Overview

This collector exposes TCP and UDP stack statistics on Windows systems via a real-time table function.


It queries the TCPv4, TCPv6, UDPv4, and UDPv6 objects from Windows Perflib,
combining the results into a single table grouped by transport protocol and IP family.


This collector is only supported on the following platforms:

- windows

This collector only supports collecting metrics from a single instance of this integration.


### Default Behavior

#### Auto-Detection

The collector automatically detects all of the metrics, no further configuration is required.


#### Limits

The default configuration for this integration does not impose any limits on data collection.

#### Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

## Setup


### Prerequisites

No action required.

### Configuration

#### Options



There are no configuration options.



#### via File

There is no configuration file.

##### Examples
There are no configuration examples.



## Alerts

There are no alerts configured by default for this integration.



## Metrics




## Live Data

This collector exposes real-time functions for viewing Windows network connections and TCP/UDP stack statistics.


### Network Connections

Shows active network connections on Windows with protocol details, states, addresses,
ports, and process information.

Each row represents one TCP connection or UDP endpoint and includes the socket direction
(listen/inbound/outbound), protocol (tcp4/tcp6/udp4/udp6), TCP state, owning process
(PID and name), username, server port name, local and remote addresses and ports,
address space classification (loopback/private/public/multicast/zero), and server port number.

Data is collected using the Windows IP Helper API (GetExtendedTcpTable,
GetExtendedUdpTable) with process and user resolution via standard Windows APIs.


| Aspect | Description |
|:-------|:------------|
| Name | `Perflibnetworkprotocols:network-connections` |
| Require Cloud | no |
| Performance |  |
| Security |  |
| Availability |  |

#### Prerequisites

No additional configuration is required.

#### Parameters

This function has no parameters.

#### Returns



| Column | Type | Unit | Visibility | Description |
|:-------|:-----|:-----|:-----------|:------------|

### Network Protocols

Shows Windows TCP and UDP stack counters grouped by transport protocol (TCP/UDP)
and IP family (IPv4/IPv6), and per-share SMB Server Shares traffic.

Each row covers one transport+family combination (TCPv4, TCPv6, UDPv4, UDPv6) or one
SMB share, and includes the transport's traffic counters (TCP/UDP: received, sent, errors;
SMB: received bytes, sent bytes, active tree connections), the TCP-specific connection
counters (active opens, established, passive opens, resets, total segments, retransmitted
segments), the UDP-specific datagrams-with-no-port counter, and the SMB-specific
active tree connections, received bytes, and sent bytes columns.

Two stacked-bar charts are exposed: "Traffic" (TCP/UDP segments/datagrams, grouped by
transport or IP family) and "SMB Traffic" (per-share bytes, grouped by share name).


| Aspect | Description |
|:-------|:------------|
| Name | `Perflibnetworkprotocols:network-protocols` |
| Require Cloud | no |
| Performance |  |
| Security |  |
| Availability |  |

#### Prerequisites

No additional configuration is required.

#### Parameters

This function has no parameters.

#### Returns



| Column | Type | Unit | Visibility | Description |
|:-------|:-----|:-----|:-----------|:------------|
