Project: Netdata (Observability and Analysis / Observability)
File: samba.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/collectors/python.d.plugin/samba/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/python.d.plugin/samba/metadata.yaml" sidebar_label: "Samba" learn_status: "Published" learnrelpath: "Collecting Metrics/Storage, Mount Points and Filesystems" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/samba.svg" width="150"/> Plugin: python.d.plugin Module: samba <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 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. 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. The default configuration for this integration is not expected to impose a significant performance impact on the system. 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 the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | syscall.rw | sendfile, recvfile | KiB/s | | smb2.rw | readout, writein, readin, writeout | KiB/s | | smb2.create_close | create, close | operations/s | | smb2.getsetinfo | 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. The `samba` collector is disabled by default. To enable it, use `edit-config` from the Netdata , which is typically at `/etc/netdata`, to edit the `python.d.conf` file. ```bash 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 for your system. 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

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. ```bash netdata ALL=(root) NOPASSWD: /path/to/smbstatus ``` Reset Netdata's systemd unit (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: ```cmd 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 . ```bash 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, autodetectionretry, updateevery, 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. <details><summary>Config options</summary> | 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 | </details> A basic example configuration. <details><summary>Config</summary> ```yaml myjobname: name: my_name update_every: 1 ``` </details> 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]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `python.d.plugin` to debug the collector: ```bash ./python.d.plugin samba debug trace ```