SMB Client Shares
Plugin: windows.plugin Module: PerflibSMBClient
Overview
Monitor the remote SMB shares this Windows host uses as a client: traffic, requests, queues, and latency.
It queries the 'SMB Client Shares' object from Perflib. Each remote share the host has open is one instance,
named \server\share; the aggregate _Total instance and names that do not split into a server and a
share are skipped.
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. It charts every remote share the host is connected to, including shares connected after the Agent starts, and removes a share's charts when the connection closes. A host with no SMB client connections produces no charts.
Limits
One set of nine charts is created per connected remote share; the number of charts follows the number of shares the host has open.
Performance Impact
One Perflib query per collection interval.
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:PerflibSMBClient] 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 client share
These metrics refer to a remote SMB share this host is connected to.
Labels:
| Label | Description |
|---|---|
| server | Server part of the share path, as reported by the SMB Client Shares performance object. |
| share | Share name on that server. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| smb.client_share_traffic | SMB client share traffic | read, write | bytes/s |
| smb.client_share_requests | SMB client share requests | read, write, metadata | requests/s |
| smb.client_share_smbdirect_traffic | SMB client share traffic via SMB Direct | read, write | bytes/s |
| smb.client_share_smbdirect_requests | SMB client share requests via SMB Direct | read, write | requests/s |
| smb.client_share_turbo_io | SMB client share Turbo I/O requests | read, write | requests/s |
| smb.client_share_credit_stalls | SMB client share requests delayed by insufficient credits | stalls | stalls/s |
| smb.client_share_outstanding_requests | SMB client share outstanding requests | outstanding | requests |
| smb.client_share_avg_queue_length | SMB client share average queue length | read, write | requests |
| smb.client_share_latency | SMB client share average request latency | read, write, data | milliseconds |
Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.