Regenerate integrations.js (#17683)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
May 16, 2024 at 16:37 UTC
cef269400b9e689727f8190f40c22d1c21c84a8f
5 files changed
+307
integrations/integrations.js
+48
@@ -15798,6 +15798,54 @@ export const integrations = [
15798
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/redis/metadata.yaml",
15799
"related_resources": ""
15800
},
15801
+ {
15802
+ "meta": {
15803
+ "id": "collector-go.d.plugin-rspamd",
15804
+ "plugin_name": "go.d.plugin",
15805
+ "module_name": "rspamd",
15806
+ "monitored_instance": {
15807
+ "name": "Rspamd",
15808
+ "link": "https://rspamd.com/",
15809
+ "categories": [
15810
+ "data-collection.security-systems"
15811
+ ],
15812
+ "icon_filename": "globe.svg"
15813
+ },
15814
+ "related_resources": {
15815
+ "integrations": {
15816
+ "list": [
15817
+ {
15818
+ "plugin_name": "go.d.plugin",
15819
+ "module_name": "httpcheck"
15820
+ },
15821
+ {
15822
+ "plugin_name": "apps.plugin",
15823
+ "module_name": "apps"
15824
+ }
15825
+ ]
15826
+ }
15827
+ },
15828
+ "alternative_monitored_instances": [],
15829
+ "info_provided_to_referring_integrations": {
15830
+ "description": ""
15831
+ },
15832
+ "keywords": [
15833
+ "spam",
15834
+ "rspamd",
15835
+ "email"
15836
+ ],
15837
+ "most_popular": false
15838
+ },
15839
+ "overview": "# Rspamd\n\nPlugin: go.d.plugin\nModule: rspamd\n\n## Overview\n\nThis 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.).\n\n\nIt retrieves statistics from Rspamd's [built-in web server](https://rspamd.com/doc/workers/controller.html) by making HTTP requests to the `/stat` endpoint.\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, it detects Rspamd instances running on localhost that are listening on port 11334.\n\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
15840
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/rspamd.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/rspamd.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n{% details summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 1 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| url | Server URL. | http://127.0.0.1:11334 | yes |\n| timeout | HTTP request timeout. | 1 | no |\n| username | Username for basic HTTP authentication. | | no |\n| password | Password for basic HTTP authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTP authentication. | | no |\n| proxy_password | Password for proxy basic HTTP authentication. | | no |\n| method | HTTP request method. | GET | no |\n| body | HTTP request body. | | no |\n| headers | HTTP request headers. | | no |\n| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |\n| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |\n| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |\n| tls_cert | Client TLS certificate. | | no |\n| tls_key | Client TLS key. | | no |\n\n{% /details %}\n#### Examples\n\n##### Basic\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:11334\n\n```\n##### HTTP authentication\n\nBasic HTTP authentication.\n\n{% details summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:11334\n username: username\n password: password\n\n```\n{% /details %}\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nCollecting metrics from local and remote instances.\n\n\n{% details summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:11334\n\n - name: remote\n url: http://192.0.2.1:11334\n\n```\n{% /details %}\n",
15841
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `rspamd` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m rspamd\n ```\n\n",
15842
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
15843
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per Rspamd instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| rspamd.classifications | ham, spam | messages/s |\n| rspamd.actions | reject, soft_reject, rewrite_subject, add_header, greylist, custom, discard, quarantine, no_action | messages/s |\n| rspamd.scans | scanned | messages/s |\n| rspamd.learns | learned | messages/s |\n| rspamd.connections | connections | connections/s |\n| rspamd.control_connections | control_connections | connections/s |\n\n",
15844
+ "integration_type": "collector",
15845
+ "id": "go.d.plugin-rspamd-Rspamd",
15846
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/rspamd/metadata.yaml",
15847
+ "related_resources": ""
15848
+ },
15849
{
15850
"meta": {
15851
"id": "collector-go.d.plugin-scaleio",
integrations/integrations.json
+48
@@ -15796,6 +15796,54 @@
15796
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/redis/metadata.yaml",
15797
"related_resources": ""
15798
},
15799
+ {
15800
+ "meta": {
15801
+ "id": "collector-go.d.plugin-rspamd",
15802
+ "plugin_name": "go.d.plugin",
15803
+ "module_name": "rspamd",
15804
+ "monitored_instance": {
15805
+ "name": "Rspamd",
15806
+ "link": "https://rspamd.com/",
15807
+ "categories": [
15808
+ "data-collection.security-systems"
15809
+ ],
15810
+ "icon_filename": "globe.svg"
15811
+ },
15812
+ "related_resources": {
15813
+ "integrations": {
15814
+ "list": [
15815
+ {
15816
+ "plugin_name": "go.d.plugin",
15817
+ "module_name": "httpcheck"
15818
+ },
15819
+ {
15820
+ "plugin_name": "apps.plugin",
15821
+ "module_name": "apps"
15822
+ }
15823
+ ]
15824
+ }
15825
+ },
15826
+ "alternative_monitored_instances": [],
15827
+ "info_provided_to_referring_integrations": {
15828
+ "description": ""
15829
+ },
15830
+ "keywords": [
15831
+ "spam",
15832
+ "rspamd",
15833
+ "email"
15834
+ ],
15835
+ "most_popular": false
15836
+ },
15837
+ "overview": "# Rspamd\n\nPlugin: go.d.plugin\nModule: rspamd\n\n## Overview\n\nThis 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.).\n\n\nIt retrieves statistics from Rspamd's [built-in web server](https://rspamd.com/doc/workers/controller.html) by making HTTP requests to the `/stat` endpoint.\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, it detects Rspamd instances running on localhost that are listening on port 11334.\n\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
15838
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/rspamd.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/rspamd.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 1 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| url | Server URL. | http://127.0.0.1:11334 | yes |\n| timeout | HTTP request timeout. | 1 | no |\n| username | Username for basic HTTP authentication. | | no |\n| password | Password for basic HTTP authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTP authentication. | | no |\n| proxy_password | Password for proxy basic HTTP authentication. | | no |\n| method | HTTP request method. | GET | no |\n| body | HTTP request body. | | no |\n| headers | HTTP request headers. | | no |\n| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |\n| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |\n| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |\n| tls_cert | Client TLS certificate. | | no |\n| tls_key | Client TLS key. | | no |\n\n#### Examples\n\n##### Basic\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:11334\n\n```\n##### HTTP authentication\n\nBasic HTTP authentication.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:11334\n username: username\n password: password\n\n```\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nCollecting metrics from local and remote instances.\n\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:11334\n\n - name: remote\n url: http://192.0.2.1:11334\n\n```\n",
15839
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `rspamd` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m rspamd\n ```\n\n",
15840
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
15841
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per Rspamd instance\n\nThese metrics refer to the entire monitored application.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| rspamd.classifications | ham, spam | messages/s |\n| rspamd.actions | reject, soft_reject, rewrite_subject, add_header, greylist, custom, discard, quarantine, no_action | messages/s |\n| rspamd.scans | scanned | messages/s |\n| rspamd.learns | learned | messages/s |\n| rspamd.connections | connections | connections/s |\n| rspamd.control_connections | control_connections | connections/s |\n\n",
15842
+ "integration_type": "collector",
15843
+ "id": "go.d.plugin-rspamd-Rspamd",
15844
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/rspamd/metadata.yaml",
15845
+ "related_resources": ""
15846
+ },
15847
{
15848
"meta": {
15849
"id": "collector-go.d.plugin-scaleio",
src/collectors/COLLECTORS.md
+2
@@ -965,6 +965,8 @@ If you don't see the app/service you'd like to monitor in this list:
965
966
- [OpenVAS](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/openvas.md)
967
968
+- [Rspamd](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/rspamd/integrations/rspamd.md)
969
+
970
- [SSL Certificate](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/ssl_certificate.md)
971
972
- [Suricata](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/suricata.md)
src/go/collectors/go.d.plugin/modules/rspamd/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/rspamd.md
\ No newline at end of file
src/go/collectors/go.d.plugin/modules/rspamd/integrations/rspamd.md
new
+208
@@ -0,0 +1,208 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/rspamd/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/rspamd/metadata.yaml"
4
+sidebar_label: "Rspamd"
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/Security Systems"
7
+most_popular: False
8
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
+endmeta-->
10
+
11
+# Rspamd
12
+
13
+
14
+<img src="https://netdata.cloud/img/globe.svg" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: rspamd
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+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.).
25
+
26
+
27
+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.
28
+
29
+
30
+This collector is supported on all platforms.
31
+
32
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
33
+
34
+
35
+### Default Behavior
36
+
37
+#### Auto-Detection
38
+
39
+By default, it detects Rspamd instances running on localhost that are listening on port 11334.
40
+
41
+
42
+#### Limits
43
+
44
+The default configuration for this integration does not impose any limits on data collection.
45
+
46
+#### Performance Impact
47
+
48
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
49
+
50
+
51
+## Metrics
52
+
53
+Metrics grouped by *scope*.
54
+
55
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
56
+
57
+
58
+
59
+### Per Rspamd instance
60
+
61
+These metrics refer to the entire monitored application.
62
+
63
+This scope has no labels.
64
+
65
+Metrics:
66
+
67
+| Metric | Dimensions | Unit |
68
+|:------|:----------|:----|
69
+| rspamd.classifications | ham, spam | messages/s |
70
+| rspamd.actions | reject, soft_reject, rewrite_subject, add_header, greylist, custom, discard, quarantine, no_action | messages/s |
71
+| rspamd.scans | scanned | messages/s |
72
+| rspamd.learns | learned | messages/s |
73
+| rspamd.connections | connections | connections/s |
74
+| rspamd.control_connections | control_connections | connections/s |
75
+
76
+
77
+
78
+## Alerts
79
+
80
+There are no alerts configured by default for this integration.
81
+
82
+
83
+## Setup
84
+
85
+### Prerequisites
86
+
87
+No action required.
88
+
89
+### Configuration
90
+
91
+#### File
92
+
93
+The configuration file name for this integration is `go.d/rspamd.conf`.
94
+
95
+
96
+You can edit the configuration file using the `edit-config` script from the
97
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
98
+
99
+```bash
100
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
101
+sudo ./edit-config go.d/rspamd.conf
102
+```
103
+#### Options
104
+
105
+The following options can be defined globally: update_every, autodetection_retry.
106
+
107
+
108
+<details><summary>Config options</summary>
109
+
110
+| Name | Description | Default | Required |
111
+|:----|:-----------|:-------|:--------:|
112
+| update_every | Data collection frequency. | 1 | no |
113
+| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
114
+| url | Server URL. | http://127.0.0.1:11334 | yes |
115
+| timeout | HTTP request timeout. | 1 | no |
116
+| username | Username for basic HTTP authentication. | | no |
117
+| password | Password for basic HTTP authentication. | | no |
118
+| proxy_url | Proxy URL. | | no |
119
+| proxy_username | Username for proxy basic HTTP authentication. | | no |
120
+| proxy_password | Password for proxy basic HTTP authentication. | | no |
121
+| method | HTTP request method. | GET | no |
122
+| body | HTTP request body. | | no |
123
+| headers | HTTP request headers. | | no |
124
+| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |
125
+| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
126
+| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |
127
+| tls_cert | Client TLS certificate. | | no |
128
+| tls_key | Client TLS key. | | no |
129
+
130
+</details>
131
+
132
+#### Examples
133
+
134
+##### Basic
135
+
136
+A basic example configuration.
137
+
138
+```yaml
139
+jobs:
140
+ - name: local
141
+ url: http://127.0.0.1:11334
142
+
143
+```
144
+##### HTTP authentication
145
+
146
+Basic HTTP authentication.
147
+
148
+<details><summary>Config</summary>
149
+
150
+```yaml
151
+jobs:
152
+ - name: local
153
+ url: http://127.0.0.1:11334
154
+ username: username
155
+ password: password
156
+
157
+```
158
+</details>
159
+
160
+##### Multi-instance
161
+
162
+> **Note**: When you define multiple jobs, their names must be unique.
163
+
164
+Collecting metrics from local and remote instances.
165
+
166
+
167
+<details><summary>Config</summary>
168
+
169
+```yaml
170
+jobs:
171
+ - name: local
172
+ url: http://127.0.0.1:11334
173
+
174
+ - name: remote
175
+ url: http://192.0.2.1:11334
176
+
177
+```
178
+</details>
179
+
180
+
181
+
182
+## Troubleshooting
183
+
184
+### Debug Mode
185
+
186
+To troubleshoot issues with the `rspamd` collector, run the `go.d.plugin` with the debug option enabled. The output
187
+should give you clues as to why the collector isn't working.
188
+
189
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
190
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
191
+
192
+ ```bash
193
+ cd /usr/libexec/netdata/plugins.d/
194
+ ```
195
+
196
+- Switch to the `netdata` user.
197
+
198
+ ```bash
199
+ sudo -u netdata -s
200
+ ```
201
+
202
+- Run the `go.d.plugin` to debug the collector:
203
+
204
+ ```bash
205
+ ./go.d.plugin -d -m rspamd
206
+ ```
207
+
208
+