Samba icon



Plugin: python.d.plugin Module: samba


This collector monitors the performance metrics of Samba file sharing.

It is using the smbstatus command-line tool.

Executed commands:

  • sudo -n smbstatus -P

This collector is supported on all platforms.

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

smbstatus is used, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute smbstatus as root without a password.

Default Behavior


After all the permissions are satisfied, the smbstatus -P binary is executed.


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.



Enable the samba collector

The samba collector is disabled by default. To enable it, use edit-config from the Netdata config directory, which is typically at /etc/netdata, to edit the python.d.conf file.

cd /etc/netdata   # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d.conf

Change the value of the samba setting to yes. Save the file and restart the Netdata Agent with sudo systemctl restart netdata, or the appropriate method for your system.

Permissions and programs

To run the collector you need:

  • smbstatus program
  • sudo program
  • smbd must be compiled with profiling enabled
  • smbd must be started either with the -P 1 option or inside smb.conf using smbd profiling level

The module uses smbstatus, which can only be executed by root. It uses sudo and assumes that it is configured such that the netdata user can execute smbstatus as root without a password.

  • add to your /etc/sudoers file:

    which smbstatus shows the full path to the binary.

    netdata ALL=(root)       NOPASSWD: /path/to/smbstatus
  • Reset Netdata’s systemd unit CapabilityBoundingSet (Linux distributions with systemd)

    The default CapabilityBoundingSet doesn’t allow using sudo, and is quite strict in general. Resetting is not optimal, but a next-best solution given the inability to execute smbstatus using sudo.

    As the root user, do the following:

    mkdir /etc/systemd/system/netdata.service.d
    echo -e '[Service]\nCapabilityBoundingSet=~' | tee /etc/systemd/system/netdata.service.d/unset-capability-bounding-set.conf
    systemctl daemon-reload
    systemctl restart netdata.service



The configuration file name for this integration is python.d/samba.conf.

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 python.d/samba.conf


There are 2 sections:

  • Global variables
  • One or more JOBS that can define multiple different instances to monitor.

The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.

Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.

Every configuration JOB starts with a job_name value which will appear in the dashboard, unless a name parameter is specified.

Name Description Default Required
update_every Sets the default data collection frequency. 5 no
priority Controls the order of charts at the netdata dashboard. 60000 no
autodetection_retry Sets the job re-check interval in seconds. 0 no
penalty Indicates whether to apply penalty to update_every in case of failures. yes no



A basic example configuration.

  name: my_name
  update_every: 1


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 Samba instance

These metrics refer to the entire monitored application.

This scope has no labels.


Metric Dimensions Unit sendfile, recvfile KiB/s readout, writein, readin, writeout KiB/s
smb2.create_close create, close operations/s
smb2.get_set_info getinfo, setinfo operations/s
smb2.find find operations/s
smb2.notify notify operations/s
smb2.sm_counters tcon, negprot, tdis, cancel, logoff, flush, lock, keepalive, break, sessetup count


There are no alerts configured by default for this integration.


Debug Mode

To troubleshoot issues with the samba collector, run the python.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn’t working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that’s not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the python.d.plugin to debug the collector:

    ./python.d.plugin samba debug trace

Getting Logs

If you’re encountering problems with the samba collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep samba

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector’s name:

grep samba /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:

docker logs netdata 2>&1 | grep samba

Get Netdata

Sign up for free

Want to see a demonstration of Netdata for multiple use cases?

Go to Live Demo