@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
yaml 204 lines 6.76 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-dovecot
5 plugin_name: go.d.plugin
6 module_name: dovecot
7 monitored_instance:
8 name: Dovecot
9 link: 'https://www.dovecot.org/'
10 categories:
11 - data-collection.applications
12 icon_filename: "dovecot.svg"
13 related_resources:
14 integrations:
15 list: []
16 info_provided_to_referring_integrations:
17 description: ""
18 keywords:
19 - dovecot
20 - imap
21 - mail
22 overview:
23 data_collection:
24 metrics_description: |
25 This collector monitors Dovecot metrics about sessions, logins, commands, page faults and more.
26 method_description: |
27 It reads the server's response to the `EXPORT\tglobal\n` command.
28 supported_platforms:
29 include: []
30 exclude: []
31 multi_instance: true
32 additional_permissions:
33 description: ""
34 default_behavior:
35 auto_detection:
36 description: |
37 Automatically discovers and collects Dovecot statistics from the following default locations:
38
39 - localhost:24242
40 - unix:///var/run/dovecot/old-stats
41 limits:
42 description: ""
43 performance_impact:
44 description: ""
45 setup:
46 prerequisites:
47 list:
48 - title: Enable old_stats plugin
49 description: |
50 To enable `old_stats` plugin, see [Old Statistics](https://doc.dovecot.org/configuration_manual/stats/old_statistics/#old-statistics).
51 configuration:
52 file:
53 name: go.d/dovecot.conf
54 options:
55 description: |
56 The following options can be defined globally: update_every, autodetection_retry.
57 folding:
58 title: Config options
59 enabled: true
60 list:
61 - name: update_every
62 description: Data collection interval (seconds).
63 default_value: 1
64 required: false
65 group: Collection
66 - name: autodetection_retry
67 description: Autodetection retry interval (seconds). Set 0 to disable.
68 default_value: 0
69 required: false
70 group: Collection
71
72 - name: address
73 description: "Dovecot socket address (Unix or TCP). Used by the [old_stats](https://doc.dovecot.org/configuration_manual/stats/old_statistics/#old-statistics) plugin."
74 default_value: 127.0.0.1:24242
75 required: true
76 group: Target
77 - name: timeout
78 description: Connection, read, write, and name resolution timeout (seconds).
79 default_value: 1
80 required: false
81 group: Target
82
83 - name: vnode
84 description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes).
85 default_value: ""
86 required: false
87 group: Virtual Node
88 examples:
89 folding:
90 title: Config
91 enabled: true
92 list:
93 - name: Basic (TCP)
94 description: A basic example configuration.
95 config: |
96 jobs:
97 - name: local
98 address: 127.0.0.1:24242
99 - name: Basic (UNIX)
100 description: A basic example configuration using a UNIX socket.
101 config: |
102 jobs:
103 - name: local
104 address: unix:///var/run/dovecot/old-stats
105 - name: Multi-instance
106 description: |
107 > **Note**: When you define multiple jobs, their names must be unique.
108
109 Collecting metrics from local and remote instances.
110 config: |
111 jobs:
112 - name: local
113 address: 127.0.0.1:24242
114
115 - name: remote
116 address: 203.0.113.0:24242
117 troubleshooting:
118 problems:
119 list: []
120 alerts: []
121 metrics:
122 folding:
123 title: Metrics
124 enabled: false
125 description: ""
126 availability: []
127 scopes:
128 - name: global
129 description: "These metrics refer to the entire monitored application."
130 labels: []
131 metrics:
132 - name: dovecot.session
133 description: Dovecot Active Sessions
134 unit: "sessions"
135 chart_type: line
136 dimensions:
137 - name: active
138 - name: dovecot.logins
139 description: Dovecot Logins
140 unit: "logins"
141 chart_type: line
142 dimensions:
143 - name: logins
144 - name: dovecot.auth
145 description: Dovecot Authentications
146 unit: "attempts/s"
147 chart_type: stacked
148 dimensions:
149 - name: ok
150 - name: failed
151 - name: dovecot.commands
152 description: Dovecot Commands
153 unit: "commands"
154 chart_type: line
155 dimensions:
156 - name: commands
157 - name: dovecot.context_switches
158 description: Dovecot Context Switches
159 unit: "switches/s"
160 chart_type: line
161 dimensions:
162 - name: voluntary
163 - name: voluntary
164 - name: dovecot.io
165 description: Dovecot Disk I/O
166 unit: "KiB/s"
167 chart_type: area
168 dimensions:
169 - name: read
170 - name: write
171 - name: dovecot.net
172 description: Dovecot Network Bandwidth
173 unit: "kilobits/s"
174 chart_type: area
175 dimensions:
176 - name: read
177 - name: write
178 - name: dovecot.syscalls
179 description: Dovecot Number of SysCalls
180 unit: "syscalls/s"
181 chart_type: line
182 dimensions:
183 - name: read
184 - name: write
185 - name: dovecot.lookup
186 description: Dovecot Lookups
187 unit: "lookups/s"
188 chart_type: stacked
189 dimensions:
190 - name: path
191 - name: attr
192 - name: dovecot.cache
193 description: Dovecot Cache Hits
194 unit: "hits/s"
195 chart_type: line
196 dimensions:
197 - name: hits
198 - name: dovecot.auth_cache
199 description: Dovecot Authentication Cache
200 unit: "requests/s"
201 chart_type: stacked
202 dimensions:
203 - name: hits
204 - name: misses