summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/postfix/README.md
blob: ba5565499a65b30069159026fd558af10e203de5 (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
<!--
title: "Postfix monitoring with Netdata"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/postfix/README.md"
sidebar_label: "Postfix"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Integrations/Monitor/Webapps"
-->

# Postfix collector

Monitors MTA email queue statistics using [postqueue](http://www.postfix.org/postqueue.1.html) tool.

The collector executes  `postqueue -p` to get Postfix queue statistics.

## Requirements

Postfix has internal access controls that limit activities on the mail queue. By default, all users are allowed to view
the queue. If your system is configured with stricter access controls, you need to grant the `netdata` user access to
view the mail queue. In order to do it, add `netdata` to `authorized_mailq_users` in the `/etc/postfix/main.cf` file.

See the `authorized_mailq_users` setting in
the [Postfix documentation](https://www.postfix.org/postconf.5.html) for more details.

## Charts

It produces only two charts:

1. **Postfix Queue Emails**

    - emails

2. **Postfix Queue Emails Size** in KB

    - size

## Configuration

Configuration is not needed.
### Troubleshooting

To troubleshoot issues with the `postfix` module, run the `python.d.plugin` with the debug option enabled. The 
output will give you the output of the data collection job or error messages on why the collector isn't working.

First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's 
not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the 
plugin's directory, switch to the `netdata` user.

```bash
cd /usr/libexec/netdata/plugins.d/
sudo su -s /bin/bash netdata
```

Now you can manually run the `postfix` module in debug mode:

```bash
./python.d.plugin postfix debug trace
```