-
Notifications
You must be signed in to change notification settings - Fork 6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
80b5019
commit 389c24a
Showing
5 changed files
with
268 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
integrations/exim.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,189 @@ | ||
<!--startmeta | ||
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/exim/README.md" | ||
meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/exim/metadata.yaml" | ||
sidebar_label: "Exim" | ||
learn_status: "Published" | ||
learn_rel_path: "Collecting Metrics/Mail Servers" | ||
most_popular: False | ||
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" | ||
endmeta--> | ||
|
||
# Exim | ||
|
||
|
||
<img src="https://netdata.cloud/img/exim.jpg" width="150"/> | ||
|
||
|
||
Plugin: go.d.plugin | ||
Module: exim | ||
|
||
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> | ||
|
||
## Overview | ||
|
||
This collector monitors Exim mail queue. It relies on the [`exim`](https://www.exim.org/exim-html-3.20/doc/html/spec_5.html) CLI tool but avoids directly executing the binary. Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management. | ||
Executed commands: | ||
- `exim -bpc` | ||
|
||
|
||
|
||
|
||
This collector is supported on all platforms. | ||
|
||
This collector only supports collecting metrics from a single instance of this integration. | ||
|
||
|
||
### Default Behavior | ||
|
||
#### Auto-Detection | ||
|
||
This integration doesn't support auto-detection. | ||
|
||
#### 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 Exim instance | ||
|
||
These metrics refer to the the entire monitored application. | ||
|
||
This scope has no labels. | ||
|
||
Metrics: | ||
|
||
| Metric | Dimensions | Unit | | ||
|:------|:----------|:----| | ||
| exim.qemails | emails | emails | | ||
|
||
|
||
|
||
## 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/exim.conf`. | ||
|
||
|
||
You can edit the configuration file using the `edit-config` script from the | ||
Netdata [config directory](/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/exim.conf | ||
``` | ||
#### Options | ||
|
||
The following options can be defined globally: update_every. | ||
|
||
|
||
<details open><summary>Config options</summary> | ||
|
||
| Name | Description | Default | Required | | ||
|:----|:-----------|:-------|:--------:| | ||
| update_every | Data collection frequency. | 10 | no | | ||
| timeout | exim binary execution timeout. | 2 | no | | ||
|
||
</details> | ||
|
||
#### Examples | ||
|
||
##### Custom update_every | ||
|
||
Allows you to override the default data collection interval. | ||
|
||
<details open><summary>Config</summary> | ||
|
||
```yaml | ||
jobs: | ||
- name: exim | ||
update_every: 5 # Collect logical volume statistics every 5 seconds | ||
|
||
``` | ||
</details> | ||
|
||
|
||
|
||
## Troubleshooting | ||
|
||
### Debug Mode | ||
|
||
To troubleshoot issues with the `exim` 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 exim | ||
``` | ||
|
||
### Getting Logs | ||
|
||
If you're encountering problems with the `exim` 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 exim | ||
``` | ||
|
||
#### 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 exim /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 exim | ||
``` | ||
|
||
|