diff options
Diffstat (limited to 'collectors/python.d.plugin/samba')
| -rw-r--r-- | collectors/python.d.plugin/samba/README.md | 101 |
1 files changed, 56 insertions, 45 deletions
diff --git a/collectors/python.d.plugin/samba/README.md b/collectors/python.d.plugin/samba/README.md index 97f2e3d3..ad99dead 100644 --- a/collectors/python.d.plugin/samba/README.md +++ b/collectors/python.d.plugin/samba/README.md @@ -3,60 +3,71 @@ Performance metrics of Samba file sharing. **Requirements:** -* `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` -* `netdata` user needs to be able to sudo the `smbstatus` program without password + +- `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` +- `netdata` user needs to be able to sudo the `smbstatus` program without password It produces the following charts: -1. **Syscall R/Ws** in kilobytes/s - * sendfile - * recvfle - -2. **Smb2 R/Ws** in kilobytes/s - * readout - * writein - * readin - * writeout - -3. **Smb2 Create/Close** in operations/s - * create - * close - -4. **Smb2 Info** in operations/s - * getinfo - * setinfo - -5. **Smb2 Find** in operations/s - * find - -6. **Smb2 Notify** in operations/s - * notify - -7. **Smb2 Lesser Ops** as counters - * tcon - * negprot - * tdis - * cancel - * logoff - * flush - * lock - * keepalive - * break - * sessetup - -### prerequisite +1. **Syscall R/Ws** in kilobytes/s + + - sendfile + - recvfle + +2. **Smb2 R/Ws** in kilobytes/s + + - readout + - writein + - readin + - writeout + +3. **Smb2 Create/Close** in operations/s + + - create + - close + +4. **Smb2 Info** in operations/s + + - getinfo + - setinfo + +5. **Smb2 Find** in operations/s + + - find + +6. **Smb2 Notify** in operations/s + + - notify + +7. **Smb2 Lesser Ops** as counters + + - tcon + - negprot + - tdis + - cancel + - logoff + - flush + - lock + - keepalive + - break + - sessetup + +## prerequisite + This 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 password. Add to `sudoers`: - netdata ALL=(root) NOPASSWD: /path/to/smbstatus +``` +netdata ALL=(root) NOPASSWD: /path/to/smbstatus +``` -### configuration +## configuration **samba** is disabled by default. Should be explicitly enabled in `python.d.conf`. @@ -66,4 +77,4 @@ samba: yes --- -[]() +[](<>) |