Add samba plugin to python plugins README
Christopher Cox committed
Apr 27, 2017 at 11:20 UTC
484049b18cf22541860ea0593fb32c85db2402ab
1 file changed
+62
python.d/README.md
+62
@@ -1251,6 +1251,68 @@ When no configuration file is found, module tries to connect to TCP/IP socket: `
1251
1252
---
1253
1254
+# samba
1255
+
1256
+Performance metrics of Samba file sharing.
1257
+
1258
+It produces the following charts:
1259
+
1260
+1. **Syscall R/Ws** in kilobytes/s
1261
+ * sendfile
1262
+ * recvfle
1263
+
1264
+2. **Smb2 R/Ws** in kilobytes/s
1265
+ * readout
1266
+ * writein
1267
+ * readin
1268
+ * writeout
1269
+
1270
+3. **Smb2 Create/Close** in operations/s
1271
+ * create
1272
+ * close
1273
+
1274
+4. **Smb2 Info** in operations/s
1275
+ * getinfo
1276
+ * setinfo
1277
+
1278
+5. **Smb2 Find** in operations/s
1279
+ * find
1280
+
1281
+6. **Smb2 Notify** in operations/s
1282
+ * notify
1283
+
1284
+7. **Smb2 Lesser Ops** as counters
1285
+ * tcon
1286
+ * negprot
1287
+ * tdis
1288
+ * cancel
1289
+ * logoff
1290
+ * flush
1291
+ * lock
1292
+ * keepalive
1293
+ * break
1294
+ * sessetup
1295
+
1296
+### configuration
1297
+
1298
+Requires that smbd has been compiled with profiling enabled. Also required
1299
+that `smbd` was started either with the `-P 1` option or inside `smb.conf`
1300
+using `smbd profiling level`.
1301
+
1302
+This plugin uses `smbstatus -P` which can only be executed by root. It uses
1303
+sudo and assumes that it is configured such that the `netdata` user can
1304
+execute smbstatus as root without password.
1305
+
1306
+For example:
1307
+
1308
+ netdata ALL=(ALL) NOPASSWD: /usr/bin/smbstatus -P
1309
+
1310
+```yaml
1311
+update_every : 5 # update frequency
1312
+```
1313
+
1314
+---
1315
+
1316
# sensors
1317
1318
System sensors information.