Samba

Plugin: go.d.plugin Module: samba

Overview

This collector monitors Samba syscalls and SMB2 calls. It relies on the smbstatus CLI tool but avoids directly executing the binary. Instead, it utilizes ndsudo, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. This approach eliminates the need to use sudo, improving security and potentially simplifying permission management. Executed commands:

• smbstatus -P

This collector is supported on all platforms.

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

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

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.

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 syscall

These metrics refer to the the Syscall.

Labels:

Label	Description
syscall	Syscall name

Metrics:

Metric	Dimensions	Unit
samba.syscall_calls	syscalls	calls/s
samba.syscall_transferred_data	transferred	bytes/s

Per smb2call

These metrics refer to the the SMB2 Call.

Labels:

Label	Description
smb2call	SMB2 call name

Metrics:

Metric	Dimensions	Unit
samba.smb2_call_calls	smb2	calls/s
samba.smb2_call_transferred_data	in, out	bytes/s

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

Verifying and Enabling Profiling for SMBd

1. Check for Profiling Support

   Before enabling profiling, it's important to verify if smbd was compiled with profiling capabilities. Run the following command as root user (using sudo) to check:

   $ sudo smbd --build-options | grep WITH_PROFILE
   WITH_PROFILE

   If the command outputs WITH_PROFILE, profiling is supported. If not, you'll need to recompile smbd with profiling enabled (refer to Samba documentation for specific instructions).

2. Enable Profiling

   Once you've confirmed profiling support, you can enable it using one of the following methods:

   • Command-Line Option Start smbd with the -P 1 option when invoking it directly from the command line.

   • Configuration File Modify the smb.conf configuration file located at /etc/samba/smb.conf (the path might vary slightly depending on your system). Add the following line to the [global] section:

     smbd profiling level = count

3. Restart the Samba service

Configuration

File

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

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name1

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

Options

The following options can be defined globally: update_every.

Config options

Name	Description	Default	Required
update_every	Data collection frequency.	10	no
timeout	smbstatus binary execution timeout.	2	no

Examples

Custom update_every

Allows you to override the default data collection interval.

Config

jobs:
  - name: samba
    update_every: 5  # Collect statistics every 5 seconds

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the samba collector, run the go.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 go.d.plugin to debug the collector:

  ./go.d.plugin -d -m samba

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