summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/samba/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/samba/README.md')
-rw-r--r--collectors/python.d.plugin/samba/README.md26
1 files changed, 20 insertions, 6 deletions
diff --git a/collectors/python.d.plugin/samba/README.md b/collectors/python.d.plugin/samba/README.md
index ad99deade..ed26d2871 100644
--- a/collectors/python.d.plugin/samba/README.md
+++ b/collectors/python.d.plugin/samba/README.md
@@ -1,8 +1,14 @@
-# samba
+<!--
+title: "Samba monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/samba/README.md
+sidebar_label: "Samba"
+-->
-Performance metrics of Samba file sharing.
+# Samba monitoring with Netdata
-**Requirements:**
+Monitors the performance metrics of Samba file sharing.
+
+## Requirements
- `smbstatus` program
- `sudo` program
@@ -15,7 +21,7 @@ It produces the following charts:
1. **Syscall R/Ws** in kilobytes/s
- sendfile
- - recvfle
+ - recvfile
2. **Smb2 R/Ws** in kilobytes/s
@@ -67,14 +73,22 @@ Add to `sudoers`:
netdata ALL=(root) NOPASSWD: /path/to/smbstatus
```
-## configuration
+## Configuration
- **samba** is disabled by default. Should be explicitly enabled in `python.d.conf`.
+**samba** is disabled by default. Should be explicitly enabled in `python.d.conf`.
```yaml
samba: yes
```
+Edit the `python.d/samba.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/samba.conf
+```
+
---
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Fsamba%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)