postfix metadata.yaml - add links and some descriptions (#15544)
* add links and some descriptions
Andrew Maguire committed
Jul 26, 2023 at 14:01 UTC
5dbe24185edbd83147feab7200bde2502c7d6dd5
1 file changed
+79
-33
collectors/python.d.plugin/postfix/metadata.yaml
+79
-33
@@ -1,53 +1,98 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: python.d.plugin
5
module_name: postfix
6
monitored_instance:
7
name: Postfix
6
- link: ''
8
+ link: https://www.postfix.org/
9
categories:
8
- - data-collection.mail-servers
9
- icon_filename: 'postfix.png'
10
+ - data-collection.mail-servers
11
+ icon_filename: "postfix.png"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
16
+ description: ""
17
+ keywords:
18
+ - postfix
19
+ - mail
20
+ - mail server
21
most_popular: false
22
overview:
23
data_collection:
19
- metrics_description: 'Keep an eye on Postfix metrics for efficient mail server operations. Improve your mail server performance with Netdata''s real-time metrics and built-in alerts.'
20
- method_description: ''
24
+ metrics_description: >
25
+ Keep an eye on Postfix metrics for efficient mail server operations.
26
+
27
+ Improve your mail server performance with Netdata's real-time metrics and built-in alerts.
28
+ method_description: >
29
+ Monitors MTA email queue statistics using [postqueue](http://www.postfix.org/postqueue.1.html) tool.
30
supported_platforms:
31
include: []
32
exclude: []
33
multi_instance: true
34
additional_permissions:
26
- description: ''
35
+ description: >
36
+ Postfix has internal access controls that limit activities on the mail queue. By default, all users are allowed to view
37
+ the queue. If your system is configured with stricter access controls, you need to grant the `netdata` user access to
38
+ view the mail queue. In order to do it, add `netdata` to `authorized_mailq_users` in the `/etc/postfix/main.cf` file.
39
+
40
+ See the `authorized_mailq_users` setting in
41
+ the [Postfix documentation](https://www.postfix.org/postconf.5.html) for more details.
42
default_behavior:
43
auto_detection:
29
- description: ''
44
+ description: "The collector executes `postqueue -p` to get Postfix queue statistics."
45
limits:
31
- description: ''
46
+ description: ""
47
performance_impact:
33
- description: ''
48
+ description: ""
49
setup:
50
prerequisites:
51
list: []
52
configuration:
53
file:
39
- name: ''
40
- description: ''
54
+ name: ""
55
+ description: ""
56
options:
42
- description: ''
57
+ description: |
58
+ There are 2 sections:
59
+
60
+ * Global variables
61
+ * One or more JOBS that can define multiple different instances to monitor.
62
+
63
+ The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
64
+
65
+ Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
66
+
67
+ Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
68
folding:
44
- title: ''
69
+ title: Config options
70
enabled: true
46
- list: []
71
+ list:
72
+ - name: update_every
73
+ description: Sets the default data collection frequency.
74
+ default_value: 1
75
+ required: false
76
+ - name: priority
77
+ description: Controls the order of charts at the netdata dashboard.
78
+ default_value: 60000
79
+ required: false
80
+ - name: autodetection_retry
81
+ description: Sets the job re-check interval in seconds.
82
+ default_value: 0
83
+ required: false
84
+ - name: penalty
85
+ description: Indicates whether to apply penalty to update_every in case of failures.
86
+ default_value: yes
87
+ required: false
88
+ - name: name
89
+ description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
90
+ default_value: ""
91
+ required: false
92
examples:
93
folding:
94
enabled: true
50
- title: ''
95
+ title: ""
96
list: []
97
troubleshooting:
98
problems:
@@ -60,19 +105,20 @@ metrics:
105
description: ""
106
availability: []
107
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: postfix.qemails
68
- description: Postfix Queue Emails
69
- unit: "emails"
70
- chart_type: line
71
- dimensions:
72
- - name: emails
73
- - name: postfix.qsize
74
- description: Postfix Queue Emails Size
75
- unit: "KiB"
76
- chart_type: area
77
- dimensions:
78
- - name: size
108
+ - name: global
109
+ description: |
110
+ These metrics refer to the entire monitored application.
111
+ labels: []
112
+ metrics:
113
+ - name: postfix.qemails
114
+ description: Postfix Queue Emails
115
+ unit: "emails"
116
+ chart_type: line
117
+ dimensions:
118
+ - name: emails
119
+ - name: postfix.qsize
120
+ description: Postfix Queue Emails Size
121
+ unit: "KiB"
122
+ chart_type: area
123
+ dimensions:
124
+ - name: size