SMB Server Shares
Plugin: windows.plugin Module: PerflibSMB
Overview
Monitor SMB server share activity and throughput counters on Windows systems.
It reads the 'SMB Server Shares' performance counters through the Performance Data Helper (PDH), the same
source as Performance Monitor and Get-Counter. The registry view of this object reports some counters
under the wrong names on some Windows builds, so it is not used.
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
This collector is enabled by default and automatically detects all SMB shares served by this host. The aggregate _Total instance is not collected. On systems without the SMB server role, no SMB metrics are collected; the collector keeps checking and starts collecting once the role is installed, without restarting the Agent.
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
| Option | Description | Default | Required |
|---|---|---|---|
| update every | Data collection frequency. | 1 | no |
via File
The configuration file name for this integration is netdata.conf.
Configuration for this specific integration is located in the [plugin:windows:PerflibSMB] section within that file.
The file format is a modified INI syntax. The general structure is:
[section1]
option1 = some value
option2 = some other value
[section2]
option3 = some third value
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config netdata.conf
Examples
There are no configuration examples.
Alerts
There are no alerts configured by default for this integration.
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Per SMB Share
These metrics refer to SMB shares.
Labels:
| Label | Description |
|---|---|
| share | SMB share name as exposed by the Windows SMB Server Shares performance object. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| smb.server_shares_current_open_file_count | Current total count of open files on the SMB share. | open | files |
| smb.server_shares_write_requests | Write requests on the SMB share. | writes | requests/s |
| smb.server_shares_read_requests | Read requests on the SMB share. | reads | requests/s |
| smb.server_shares_metadata_requests | Metadata requests on the SMB share. | metadata | requests/s |
| smb.server_shares_files_opened | Files opened on the SMB share. | opened | files/s |
| smb.server_shares_tree_connects | Current number of tree connects (client connections) to the SMB share. | connects | connections |
| smb.server_shares_traffic | Bytes received and sent on the SMB share, including SMB protocol data such as packet headers. | received, sent | bytes/s |
Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.