summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/samba/README.md
blob: ed26d28718edd564e5a2332b52a82a48dff4c72c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<!--
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"
-->

# Samba monitoring with Netdata

Monitors the 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

It produces the following charts:

1.  **Syscall R/Ws** in kilobytes/s

    -   sendfile
    -   recvfile

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
```

## Configuration

**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)](<>)