src/collectors/windows.plugin/integrations/smb_server_shares.md
Plugin: windows.plugin Module: PerflibSMB
Monitor SMB server share activity and throughput counters on Windows systems.
It queries the 'SMB Server Shares' object from Perflib in order to gather the metrics.
This collector is only supported on the following platforms:
This collector only supports collecting metrics from a single instance of this integration.
This collector is enabled by default and automatically detects all available SMB share instances and metrics. On systems where the 'SMB Server Shares' object is not available, no SMB metrics are collected.
The default configuration for this integration does not impose any limits on data collection.
The default configuration for this integration is not expected to impose a significant performance impact on the system.
No action required.
| Option | Description | Default | Required |
|---|---|---|---|
| update every | Data collection frequency. | 1 | no |
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
There are no configuration examples.
There are no alerts configured by default for this integration.
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
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 |