# Rspamd Plugin: go.d.plugin Module: rspamd ## Overview 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.). 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. This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. ### Default Behavior #### Auto-Detection By default, it detects Rspamd instances running on localhost that are listening on port 11334. #### Limits The default configuration for this integration does not impose any limits on data collection. #### Performance Impact The default configuration for this integration is not expected to impose a significant performance impact on the system. ## Metrics Metrics grouped by *scope*. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. ### Per Rspamd instance These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:------|:----------|:----| | rspamd.classifications | ham, spam | messages/s | | rspamd.actions | reject, soft_reject, rewrite_subject, add_header, greylist, custom, discard, quarantine, no_action | messages/s | | rspamd.scans | scanned | messages/s | | rspamd.learns | learned | messages/s | | rspamd.connections | connections | connections/s | | rspamd.control_connections | control_connections | connections/s | ## Alerts There are no alerts configured by default for this integration. ## Setup ### Prerequisites No action required. ### Configuration #### File The configuration file name for this integration is `go.d/rspamd.conf`. You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/rspamd.conf ``` #### Options The following options can be defined globally: update_every, autodetection_retry.
Config options | Name | Description | Default | Required | |:----|:-----------|:-------|:--------:| | update_every | Data collection frequency. | 1 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | url | Server URL. | http://127.0.0.1:11334 | yes | | timeout | HTTP request timeout. | 1 | no | | username | Username for basic HTTP authentication. | | no | | password | Password for basic HTTP authentication. | | no | | proxy_url | Proxy URL. | | no | | proxy_username | Username for proxy basic HTTP authentication. | | no | | proxy_password | Password for proxy basic HTTP authentication. | | no | | method | HTTP request method. | GET | no | | body | HTTP request body. | | no | | headers | HTTP request headers. | | no | | not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no | | tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no | | tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no | | tls_cert | Client TLS certificate. | | no | | tls_key | Client TLS key. | | no |
#### Examples ##### Basic A basic example configuration. ```yaml jobs: - name: local url: http://127.0.0.1:11334 ``` ##### HTTP authentication Basic HTTP authentication.
Config ```yaml jobs: - name: local url: http://127.0.0.1:11334 username: username password: password ```
##### Multi-instance > **Note**: When you define multiple jobs, their names must be unique. Collecting metrics from local and remote instances.
Config ```yaml jobs: - name: local url: http://127.0.0.1:11334 - name: remote url: http://192.0.2.1:11334 ```
## Troubleshooting ### Debug Mode **Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature. To troubleshoot issues with the `rspamd` collector, run the `go.d.plugin` with the debug option enabled. The output should give you clues as to why the collector isn't working. - Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` - Switch to the `netdata` user. ```bash sudo -u netdata -s ``` - Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m rspamd ``` ### Getting Logs If you're encountering problems with the `rspamd` collector, follow these steps to retrieve logs and identify potential issues: - **Run the command** specific to your system (systemd, non-systemd, or Docker container). - **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem. #### System with systemd Use the following command to view logs generated since the last Netdata service restart: ```bash journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep rspamd ``` #### System without systemd Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name: ```bash grep rspamd /var/log/netdata/collector.log ``` **Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues. #### Docker Container If your Netdata runs in a Docker container named "netdata" (replace if different), use this command: ```bash docker logs netdata 2>&1 | grep rspamd ```