|
1
|
plugin_name: go.d.plugin |
|
2
|
modules: |
|
3
|
- meta: |
|
4
|
plugin_name: go.d.plugin |
|
5
|
module_name: postfix |
|
6
|
monitored_instance: |
|
7
|
name: Postfix |
|
8
|
link: https://www.postfix.org/ |
|
9
|
categories: |
|
10
|
- data-collection.applications |
|
11
|
icon_filename: "postfix.svg" |
|
12
|
related_resources: |
|
13
|
integrations: |
|
14
|
list: [] |
|
15
|
info_provided_to_referring_integrations: |
|
16
|
description: "" |
|
17
|
keywords: |
|
18
|
- postfix |
|
19
|
- mail |
|
20
|
- mail server |
|
21
|
overview: |
|
22
|
data_collection: |
|
23
|
metrics_description: > |
|
24
|
This collector retrieves statistics about the Postfix mail queue using the [postqueue](https://www.postfix.org/postqueue.1.html) command-line tool. |
|
25
|
method_description: > |
|
26
|
It periodically executes the `postqueue -p` command. The collection interval is set to 10 seconds by default, but this can be configurable. |
|
27
|
supported_platforms: |
|
28
|
include: [] |
|
29
|
exclude: [] |
|
30
|
multi_instance: false |
|
31
|
additional_permissions: |
|
32
|
description: > |
|
33
|
Postfix has internal access controls for the mail queue. By default, all users can view the queue. If your system has stricter controls, grant the `netdata` user access by adding it to `authorized_mailq_users` in the `/etc/postfix/main.cf `file. |
|
34
|
For more details, refer to the `authorized_mailq_users` setting in the [Postfix documentation](https://www.postfix.org/postconf.5.html). |
|
35
|
default_behavior: |
|
36
|
auto_detection: |
|
37
|
description: "The collector executes `postqueue -p` to get Postfix queue statistics." |
|
38
|
limits: |
|
39
|
description: "" |
|
40
|
performance_impact: |
|
41
|
description: "" |
|
42
|
setup: |
|
43
|
prerequisites: |
|
44
|
list: [] |
|
45
|
configuration: |
|
46
|
file: |
|
47
|
name: "go.d/postfix.conf" |
|
48
|
options: |
|
49
|
description: | |
|
50
|
The following options can be defined globally: update_every. |
|
51
|
folding: |
|
52
|
title: Config options |
|
53
|
enabled: true |
|
54
|
list: |
|
55
|
- name: update_every |
|
56
|
description: Data collection frequency. |
|
57
|
default_value: 10 |
|
58
|
required: false |
|
59
|
- name: binary_path |
|
60
|
description: Path to the `postqueue` binary. If an absolute path is provided, the collector will use it directly; otherwise, it will search for the binary in directories specified in the PATH environment variable. |
|
61
|
default_value: /usr/sbin/postqueue |
|
62
|
required: true |
|
63
|
- name: timeout |
|
64
|
description: Timeout for executing the binary, specified in seconds. |
|
65
|
default_value: 2 |
|
66
|
required: false |
|
67
|
examples: |
|
68
|
folding: |
|
69
|
enabled: true |
|
70
|
title: "" |
|
71
|
list: |
|
72
|
- name: Custom binary path |
|
73
|
description: The executable is not in the directories specified in the PATH environment variable. |
|
74
|
config: | |
|
75
|
jobs: |
|
76
|
- name: custom_path |
|
77
|
binary_path: /usr/local/sbin/postqueue |
|
78
|
troubleshooting: |
|
79
|
problems: |
|
80
|
list: [] |
|
81
|
alerts: [] |
|
82
|
metrics: |
|
83
|
folding: |
|
84
|
title: Metrics |
|
85
|
enabled: false |
|
86
|
description: "" |
|
87
|
availability: [] |
|
88
|
scopes: |
|
89
|
- name: global |
|
90
|
description: | |
|
91
|
These metrics refer to the entire monitored application. |
|
92
|
labels: [] |
|
93
|
metrics: |
|
94
|
- name: postfix.qemails |
|
95
|
description: Postfix Queue Emails |
|
96
|
unit: emails |
|
97
|
chart_type: line |
|
98
|
dimensions: |
|
99
|
- name: emails |
|
100
|
- name: postfix.qsize |
|
101
|
description: Postfix Queue Emails Size |
|
102
|
unit: KiB |
|
103
|
chart_type: area |
|
104
|
dimensions: |
|
105
|
- name: size |