Skip to main content

SMB Client Shares

SMB Client Shares

Plugin: windows.plugin Module: PerflibSMBClient

Maintained by Netdata

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​

OptionDescriptionDefaultRequired
update everyData collection frequency.1no

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:

LabelDescription
serverServer part of the share path, as reported by the SMB Client Shares performance object.
shareShare name on that server.

Metrics:

MetricDescriptionDimensionsUnit
smb.client_share_trafficSMB client share trafficread, writebytes/s
smb.client_share_requestsSMB client share requestsread, write, metadatarequests/s
smb.client_share_smbdirect_trafficSMB client share traffic via SMB Directread, writebytes/s
smb.client_share_smbdirect_requestsSMB client share requests via SMB Directread, writerequests/s
smb.client_share_turbo_ioSMB client share Turbo I/O requestsread, writerequests/s
smb.client_share_credit_stallsSMB client share requests delayed by insufficient creditsstallsstalls/s
smb.client_share_outstanding_requestsSMB client share outstanding requestsoutstandingrequests
smb.client_share_avg_queue_lengthSMB client share average queue lengthread, writerequests
smb.client_share_latencySMB client share average request latencyread, write, datamilliseconds

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.