@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
yaml 258 lines 8.72 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-rspamd
5 plugin_name: go.d.plugin
6 module_name: rspamd
7 monitored_instance:
8 name: Rspamd
9 link: https://rspamd.com/
10 categories:
11 - data-collection.applications
12 icon_filename: globe.svg
13 related_resources:
14 integrations:
15 list:
16 - plugin_name: go.d.plugin
17 module_name: httpcheck
18 - plugin_name: apps.plugin
19 module_name: apps
20 alternative_monitored_instances: []
21 info_provided_to_referring_integrations:
22 description: ""
23 keywords:
24 - spam
25 - rspamd
26 - email
27 overview:
28 data_collection:
29 metrics_description: |
30 This collector monitors the activity and performance of Rspamd servers. It gathers various metrics including scanned emails, learned messages, spam/ham counts, and actions taken on emails (reject, rewrite, etc.).
31 method_description: |
32 It retrieves statistics from Rspamd's [built-in web server](https://rspamd.com/doc/workers/controller.html) by making HTTP requests to the `/stat` endpoint.
33 default_behavior:
34 auto_detection:
35 description: |
36 By default, it detects Rspamd instances running on localhost that are listening on port 11334.
37 limits:
38 description: ""
39 performance_impact:
40 description: ""
41 additional_permissions:
42 description: ""
43 multi_instance: true
44 supported_platforms:
45 include: []
46 exclude: []
47 setup:
48 prerequisites:
49 list: []
50 configuration:
51 file:
52 name: go.d/rspamd.conf
53 options:
54 description: |
55 The following options can be defined globally: update_every, autodetection_retry.
56 folding:
57 title: Config options
58 enabled: true
59 list:
60 - name: update_every
61 description: Data collection interval (seconds).
62 default_value: 1
63 required: false
64 group: Collection
65 - name: autodetection_retry
66 description: Autodetection retry interval (seconds). Set 0 to disable.
67 default_value: 0
68 required: false
69 group: Collection
70
71 - name: url
72 description: Target endpoint URL.
73 default_value: http://127.0.0.1:11334
74 required: true
75 group: Target
76 - name: timeout
77 description: HTTP request timeout (seconds).
78 default_value: 1
79 required: false
80 group: Target
81
82 - name: username
83 description: Username for Basic HTTP authentication.
84 default_value: ""
85 required: false
86 group: HTTP Auth
87 - name: password
88 description: Password for Basic HTTP authentication.
89 default_value: ""
90 required: false
91 group: HTTP Auth
92 - name: bearer_token_file
93 description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
94 default_value: ""
95 required: false
96 group: HTTP Auth
97
98 - name: tls_skip_verify
99 description: Skip TLS certificate and hostname verification (insecure).
100 default_value: no
101 required: false
102 group: TLS
103 - name: tls_ca
104 description: Path to CA bundle used to validate the server certificate.
105 default_value: ""
106 required: false
107 group: TLS
108 - name: tls_cert
109 description: Path to client TLS certificate (for mTLS).
110 default_value: ""
111 required: false
112 group: TLS
113 - name: tls_key
114 description: Path to client TLS private key (for mTLS).
115 default_value: ""
116 required: false
117 group: TLS
118
119 - name: proxy_url
120 description: HTTP proxy URL.
121 default_value: ""
122 required: false
123 group: Proxy
124 - name: proxy_username
125 description: Username for proxy Basic HTTP authentication.
126 default_value: ""
127 required: false
128 group: Proxy
129 - name: proxy_password
130 description: Password for proxy Basic HTTP authentication.
131 default_value: ""
132 required: false
133 group: Proxy
134
135 - name: method
136 description: HTTP method to use.
137 default_value: "GET"
138 required: false
139 group: Request
140 - name: body
141 description: Request body (e.g., for POST/PUT).
142 default_value: ""
143 required: false
144 group: Request
145 - name: headers
146 description: "Additional HTTP headers (one per line as key: value)."
147 default_value: ""
148 required: false
149 group: Request
150 - name: not_follow_redirects
151 description: Do not follow HTTP redirects.
152 default_value: no
153 required: false
154 group: Request
155 - name: force_http2
156 description: Force HTTP/2 (including h2c over TCP).
157 default_value: no
158 required: false
159 group: Request
160
161 - name: vnode
162 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).
163 default_value: ""
164 required: false
165 group: Virtual Node
166 examples:
167 folding:
168 title: Config
169 enabled: true
170 list:
171 - name: Basic
172 description: A basic example configuration.
173 folding:
174 enabled: false
175 config: |
176 jobs:
177 - name: local
178 url: http://127.0.0.1:11334
179 - name: HTTP authentication
180 description: Basic HTTP authentication.
181 config: |
182 jobs:
183 - name: local
184 url: http://127.0.0.1:11334
185 username: username
186 password: password
187 - name: Multi-instance
188 description: |
189 > **Note**: When you define multiple jobs, their names must be unique.
190
191 Collecting metrics from local and remote instances.
192 config: |
193 jobs:
194 - name: local
195 url: http://127.0.0.1:11334
196
197 - name: remote
198 url: http://192.0.2.1:11334
199 troubleshooting:
200 problems:
201 list: []
202 alerts: []
203 metrics:
204 folding:
205 title: Metrics
206 enabled: false
207 description: ""
208 availability: []
209 scopes:
210 - name: global
211 description: These metrics refer to the entire monitored application.
212 labels: []
213 metrics:
214 - name: rspamd.classifications
215 description: Classifications
216 unit: messages/s
217 chart_type: stacked
218 dimensions:
219 - name: ham
220 - name: spam
221 - name: rspamd.actions
222 description: Actions
223 unit: messages/s
224 chart_type: stacked
225 dimensions:
226 - name: reject
227 - name: soft_reject
228 - name: rewrite_subject
229 - name: add_header
230 - name: greylist
231 - name: custom
232 - name: discard
233 - name: quarantine
234 - name: no_action
235 - name: rspamd.scans
236 description: Scanned messages
237 unit: messages/s
238 chart_type: line
239 dimensions:
240 - name: scanned
241 - name: rspamd.learns
242 description: Learned messages
243 unit: messages/s
244 chart_type: line
245 dimensions:
246 - name: learned
247 - name: rspamd.connections
248 description: Connections
249 unit: connections/s
250 chart_type: line
251 dimensions:
252 - name: connections
253 - name: rspamd.control_connections
254 description: Control connections
255 unit: connections/s
256 chart_type: line
257 dimensions:
258 - name: control_connections