#SMB Server Shares

Plugin: windows.plugin Module: PerflibSMB

#Overview

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:

• windows

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

#Default Behavior

#Auto-Detection

This collector is disabled by default. When enabled, it automatically detects all available SMB share instances and metrics.

#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

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	Dimensions	Unit
smb.server_shares_current_open_file_count	open	files
smb.server_shares_tree_connect_count	connections	connections
smb.server_shares_received_bytes	received	bytes/s
smb.server_shares_write_requests	writes	requests/s
smb.server_shares_read_requests	reads	requests/s
smb.server_shares_metadata_requests	metadata	requests/s
smb.server_shares_sent_bytes	sent	bytes/s
smb.server_shares_files_opened	opened	files/s