blob: a8ab16b4910e725bf149a7265beaecc8d59e7125 (
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
plugin_name: go.d.plugin
modules:
- meta:
id: collector-go.d.plugin-rspamd
plugin_name: go.d.plugin
module_name: rspamd
monitored_instance:
name: Rspamd
link: https://rspamd.com/
categories:
- data-collection.security-systems
icon_filename: globe.svg
related_resources:
integrations:
list:
- plugin_name: go.d.plugin
module_name: httpcheck
- plugin_name: apps.plugin
module_name: apps
alternative_monitored_instances: []
info_provided_to_referring_integrations:
description: ""
keywords:
- spam
- rspamd
- email
most_popular: false
overview:
data_collection:
metrics_description: |
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.).
method_description: |
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.
default_behavior:
auto_detection:
description: |
By default, it detects Rspamd instances running on localhost that are listening on port 11334.
limits:
description: ""
performance_impact:
description: ""
additional_permissions:
description: ""
multi_instance: true
supported_platforms:
include: []
exclude: []
setup:
prerequisites:
list: []
configuration:
file:
name: go.d/rspamd.conf
options:
description: |
The following options can be defined globally: update_every, autodetection_retry.
folding:
title: Config options
enabled: true
list:
- name: update_every
description: Data collection frequency.
default_value: 1
required: false
- name: autodetection_retry
description: Recheck interval in seconds. Zero means no recheck will be scheduled.
default_value: 0
required: false
- name: url
description: Server URL.
default_value: http://127.0.0.1:11334
required: true
- name: timeout
description: HTTP request timeout.
default_value: 1
required: false
- name: username
description: Username for basic HTTP authentication.
default_value: ""
required: false
- name: password
description: Password for basic HTTP authentication.
default_value: ""
required: false
- name: proxy_url
description: Proxy URL.
default_value: ""
required: false
- name: proxy_username
description: Username for proxy basic HTTP authentication.
default_value: ""
required: false
- name: proxy_password
description: Password for proxy basic HTTP authentication.
default_value: ""
required: false
- name: method
description: HTTP request method.
default_value: GET
required: false
- name: body
description: HTTP request body.
default_value: ""
required: false
- name: headers
description: HTTP request headers.
default_value: ""
required: false
- name: not_follow_redirects
description: Redirect handling policy. Controls whether the client follows redirects.
default_value: false
required: false
- name: tls_skip_verify
description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
default_value: false
required: false
- name: tls_ca
description: Certification authority that the client uses when verifying the server's certificates.
default_value: ""
required: false
- name: tls_cert
description: Client TLS certificate.
default_value: ""
required: false
- name: tls_key
description: Client TLS key.
default_value: ""
required: false
examples:
folding:
title: Config
enabled: true
list:
- name: Basic
description: A basic example configuration.
folding:
enabled: false
config: |
jobs:
- name: local
url: http://127.0.0.1:11334
- name: HTTP authentication
description: Basic HTTP authentication.
config: |
jobs:
- name: local
url: http://127.0.0.1:11334
username: username
password: password
- name: Multi-instance
description: |
> **Note**: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
config: |
jobs:
- name: local
url: http://127.0.0.1:11334
- name: remote
url: http://192.0.2.1:11334
troubleshooting:
problems:
list: []
alerts: []
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: These metrics refer to the entire monitored application.
labels: []
metrics:
- name: rspamd.classifications
description: Classifications
unit: messages/s
chart_type: stacked
dimensions:
- name: ham
- name: spam
- name: rspamd.actions
description: Actions
unit: messages/s
chart_type: stacked
dimensions:
- name: reject
- name: soft_reject
- name: rewrite_subject
- name: add_header
- name: greylist
- name: custom
- name: discard
- name: quarantine
- name: no_action
- name: rspamd.scans
description: Scanned messages
unit: messages/s
chart_type: line
dimensions:
- name: scanned
- name: rspamd.learns
description: Learned messages
unit: messages/s
chart_type: line
dimensions:
- name: learned
- name: rspamd.connections
description: Connections
unit: connections/s
chart_type: line
dimensions:
- name: connections
- name: rspamd.control_connections
description: Control connections
unit: connections/s
chart_type: line
dimensions:
- name: control_connections
|
