Regenerate integrations.js (#18030)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Jun 27, 2024 at 14:48 UTC
5e2eb85d4ffa7f8f54eb0cdc8ebd6a7b475e0af3
5 files changed
+247
-75
integrations/integrations.js
+37
-37
@@ -5652,6 +5652,43 @@ export const integrations = [
5652
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/portcheck/metadata.yaml",
5653
"related_resources": ""
5654
},
5655
+ {
5656
+ "meta": {
5657
+ "plugin_name": "go.d.plugin",
5658
+ "module_name": "postfix",
5659
+ "monitored_instance": {
5660
+ "name": "Postfix",
5661
+ "link": "https://www.postfix.org/",
5662
+ "categories": [
5663
+ "data-collection.mail-servers"
5664
+ ],
5665
+ "icon_filename": "postfix.svg"
5666
+ },
5667
+ "related_resources": {
5668
+ "integrations": {
5669
+ "list": []
5670
+ }
5671
+ },
5672
+ "info_provided_to_referring_integrations": {
5673
+ "description": ""
5674
+ },
5675
+ "keywords": [
5676
+ "postfix",
5677
+ "mail",
5678
+ "mail server"
5679
+ ],
5680
+ "most_popular": false
5681
+ },
5682
+ "overview": "# Postfix\n\nPlugin: go.d.plugin\nModule: postfix\n\n## Overview\n\nThis collector retrieves statistics about the Postfix mail queue using the [postqueue](https://www.postfix.org/postqueue.1.html) command-line tool.\n\n\nIt periodically executes the `postqueue -p` command. The collection interval is set to 10 seconds by default, but this can be configurable.\n\n\nThis collector is supported on all platforms.\n\nThis collector only supports collecting metrics from a single instance of this integration.\n\nPostfix has internal access controls for the mail queue. By default, all users can view the queue. If your system has stricter controls, grant the `netdata` user access by adding it to `authorized_mailq_users` in the `/etc/postfix/main.cf `file. For more details, refer to the `authorized_mailq_users` setting in the [Postfix documentation](https://www.postfix.org/postconf.5.html).\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector executes `postqueue -p` to get Postfix queue statistics.\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",
5683
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThere is no configuration file.\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| binary_path | Path to the `postqueue` binary. If an absolute path is provided, the collector will use it directly; otherwise, it will search for the binary in directories specified in the PATH environment variable. | /usr/sbin/postqueue | yes |\n| timeout | Timeout for executing the binary, specified in seconds. | 2 | no |\n\n{% /details %}\n#### Examples\nThere are no configuration examples.\n\n",
5684
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `postfix` 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 postfix\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `postfix` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **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.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep postfix\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep postfix /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep postfix\n```\n\n",
5685
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
5686
+ "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 Postfix instance\n\nThese metrics refer to the entire monitored application.\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| postfix.qemails | emails | emails |\n| postfix.qsize | size | KiB |\n\n",
5687
+ "integration_type": "collector",
5688
+ "id": "go.d.plugin-postfix-Postfix",
5689
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/postfix/metadata.yaml",
5690
+ "related_resources": ""
5691
+ },
5692
{
5693
"meta": {
5694
"id": "collector-go.d.plugin-postgres",
@@ -19056,43 +19093,6 @@ export const integrations = [
19093
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/pandas/metadata.yaml",
19094
"related_resources": ""
19095
},
19059
- {
19060
- "meta": {
19061
- "plugin_name": "python.d.plugin",
19062
- "module_name": "postfix",
19063
- "monitored_instance": {
19064
- "name": "Postfix",
19065
- "link": "https://www.postfix.org/",
19066
- "categories": [
19067
- "data-collection.mail-servers"
19068
- ],
19069
- "icon_filename": "postfix.svg"
19070
- },
19071
- "related_resources": {
19072
- "integrations": {
19073
- "list": []
19074
- }
19075
- },
19076
- "info_provided_to_referring_integrations": {
19077
- "description": ""
19078
- },
19079
- "keywords": [
19080
- "postfix",
19081
- "mail",
19082
- "mail server"
19083
- ],
19084
- "most_popular": false
19085
- },
19086
- "overview": "# Postfix\n\nPlugin: python.d.plugin\nModule: postfix\n\n## Overview\n\nKeep an eye on Postfix metrics for efficient mail server operations. \nImprove your mail server performance with Netdata's real-time metrics and built-in alerts.\n\n\nMonitors MTA email queue statistics using [postqueue](http://www.postfix.org/postqueue.1.html) tool.\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\nPostfix has internal access controls that limit activities on the mail queue. By default, all users are allowed to view the queue. If your system is configured with stricter access controls, you need to grant the `netdata` user access to view the mail queue. In order to do it, add `netdata` to `authorized_mailq_users` in the `/etc/postfix/main.cf` file.\nSee the `authorized_mailq_users` setting in the [Postfix documentation](https://www.postfix.org/postconf.5.html) for more details.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector executes `postqueue -p` to get Postfix queue statistics.\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",
19087
- "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThere is no configuration file.\n#### Options\n\nThere are 2 sections:\n\n* Global variables\n* One or more JOBS that can define multiple different instances to monitor.\n\nThe following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.\n\nAdditionally, the following collapsed table contains all the options that can be configured inside a JOB definition.\n\nEvery configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Sets the default data collection frequency. | 1 | no |\n| priority | Controls the order of charts at the netdata dashboard. | 60000 | no |\n| autodetection_retry | Sets the job re-check interval in seconds. | 0 | no |\n| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no |\n| name | Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. | | no |\n\n{% /details %}\n#### Examples\nThere are no configuration examples.\n\n",
19088
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `postfix` collector, run the `python.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 `python.d.plugin` to debug the collector:\n\n ```bash\n ./python.d.plugin postfix debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `postfix` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **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.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep postfix\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep postfix /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep postfix\n```\n\n",
19089
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19090
- "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 Postfix instance\n\nThese metrics refer to the entire monitored application.\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| postfix.qemails | emails | emails |\n| postfix.qsize | size | KiB |\n\n",
19091
- "integration_type": "collector",
19092
- "id": "python.d.plugin-postfix-Postfix",
19093
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/postfix/metadata.yaml",
19094
- "related_resources": ""
19095
- },
19096
{
19097
"meta": {
19098
"plugin_name": "python.d.plugin",
integrations/integrations.json
+37
-37
@@ -5650,6 +5650,43 @@
5650
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/portcheck/metadata.yaml",
5651
"related_resources": ""
5652
},
5653
+ {
5654
+ "meta": {
5655
+ "plugin_name": "go.d.plugin",
5656
+ "module_name": "postfix",
5657
+ "monitored_instance": {
5658
+ "name": "Postfix",
5659
+ "link": "https://www.postfix.org/",
5660
+ "categories": [
5661
+ "data-collection.mail-servers"
5662
+ ],
5663
+ "icon_filename": "postfix.svg"
5664
+ },
5665
+ "related_resources": {
5666
+ "integrations": {
5667
+ "list": []
5668
+ }
5669
+ },
5670
+ "info_provided_to_referring_integrations": {
5671
+ "description": ""
5672
+ },
5673
+ "keywords": [
5674
+ "postfix",
5675
+ "mail",
5676
+ "mail server"
5677
+ ],
5678
+ "most_popular": false
5679
+ },
5680
+ "overview": "# Postfix\n\nPlugin: go.d.plugin\nModule: postfix\n\n## Overview\n\nThis collector retrieves statistics about the Postfix mail queue using the [postqueue](https://www.postfix.org/postqueue.1.html) command-line tool.\n\n\nIt periodically executes the `postqueue -p` command. The collection interval is set to 10 seconds by default, but this can be configurable.\n\n\nThis collector is supported on all platforms.\n\nThis collector only supports collecting metrics from a single instance of this integration.\n\nPostfix has internal access controls for the mail queue. By default, all users can view the queue. If your system has stricter controls, grant the `netdata` user access by adding it to `authorized_mailq_users` in the `/etc/postfix/main.cf `file. For more details, refer to the `authorized_mailq_users` setting in the [Postfix documentation](https://www.postfix.org/postconf.5.html).\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector executes `postqueue -p` to get Postfix queue statistics.\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",
5681
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThere is no configuration file.\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| binary_path | Path to the `postqueue` binary. If an absolute path is provided, the collector will use it directly; otherwise, it will search for the binary in directories specified in the PATH environment variable. | /usr/sbin/postqueue | yes |\n| timeout | Timeout for executing the binary, specified in seconds. | 2 | no |\n\n#### Examples\nThere are no configuration examples.\n\n",
5682
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `postfix` 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 postfix\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `postfix` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **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.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep postfix\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep postfix /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep postfix\n```\n\n",
5683
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
5684
+ "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 Postfix instance\n\nThese metrics refer to the entire monitored application.\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| postfix.qemails | emails | emails |\n| postfix.qsize | size | KiB |\n\n",
5685
+ "integration_type": "collector",
5686
+ "id": "go.d.plugin-postfix-Postfix",
5687
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/postfix/metadata.yaml",
5688
+ "related_resources": ""
5689
+ },
5690
{
5691
"meta": {
5692
"id": "collector-go.d.plugin-postgres",
@@ -19054,43 +19091,6 @@
19091
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/pandas/metadata.yaml",
19092
"related_resources": ""
19093
},
19057
- {
19058
- "meta": {
19059
- "plugin_name": "python.d.plugin",
19060
- "module_name": "postfix",
19061
- "monitored_instance": {
19062
- "name": "Postfix",
19063
- "link": "https://www.postfix.org/",
19064
- "categories": [
19065
- "data-collection.mail-servers"
19066
- ],
19067
- "icon_filename": "postfix.svg"
19068
- },
19069
- "related_resources": {
19070
- "integrations": {
19071
- "list": []
19072
- }
19073
- },
19074
- "info_provided_to_referring_integrations": {
19075
- "description": ""
19076
- },
19077
- "keywords": [
19078
- "postfix",
19079
- "mail",
19080
- "mail server"
19081
- ],
19082
- "most_popular": false
19083
- },
19084
- "overview": "# Postfix\n\nPlugin: python.d.plugin\nModule: postfix\n\n## Overview\n\nKeep an eye on Postfix metrics for efficient mail server operations. \nImprove your mail server performance with Netdata's real-time metrics and built-in alerts.\n\n\nMonitors MTA email queue statistics using [postqueue](http://www.postfix.org/postqueue.1.html) tool.\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\nPostfix has internal access controls that limit activities on the mail queue. By default, all users are allowed to view the queue. If your system is configured with stricter access controls, you need to grant the `netdata` user access to view the mail queue. In order to do it, add `netdata` to `authorized_mailq_users` in the `/etc/postfix/main.cf` file.\nSee the `authorized_mailq_users` setting in the [Postfix documentation](https://www.postfix.org/postconf.5.html) for more details.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector executes `postqueue -p` to get Postfix queue statistics.\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",
19085
- "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThere is no configuration file.\n#### Options\n\nThere are 2 sections:\n\n* Global variables\n* One or more JOBS that can define multiple different instances to monitor.\n\nThe following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.\n\nAdditionally, the following collapsed table contains all the options that can be configured inside a JOB definition.\n\nEvery configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Sets the default data collection frequency. | 1 | no |\n| priority | Controls the order of charts at the netdata dashboard. | 60000 | no |\n| autodetection_retry | Sets the job re-check interval in seconds. | 0 | no |\n| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no |\n| name | Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. | | no |\n\n#### Examples\nThere are no configuration examples.\n\n",
19086
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `postfix` collector, run the `python.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 `python.d.plugin` to debug the collector:\n\n ```bash\n ./python.d.plugin postfix debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `postfix` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **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.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep postfix\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep postfix /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep postfix\n```\n\n",
19087
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19088
- "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 Postfix instance\n\nThese metrics refer to the entire monitored application.\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| postfix.qemails | emails | emails |\n| postfix.qsize | size | KiB |\n\n",
19089
- "integration_type": "collector",
19090
- "id": "python.d.plugin-postfix-Postfix",
19091
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/postfix/metadata.yaml",
19092
- "related_resources": ""
19093
- },
19094
{
19095
"meta": {
19096
"plugin_name": "python.d.plugin",
src/collectors/COLLECTORS.md
+1
-1
@@ -753,7 +753,7 @@ If you don't see the app/service you'd like to monitor in this list:
753
754
- [Maildir](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/maildir.md)
755
756
-- [Postfix](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/postfix/integrations/postfix.md)
756
+- [Postfix](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/postfix/integrations/postfix.md)
757
758
### Media Services
759
src/go/collectors/go.d.plugin/modules/postfix/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/postfix.md
\ No newline at end of file
src/go/collectors/go.d.plugin/modules/postfix/integrations/postfix.md
new
+171
@@ -0,0 +1,171 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/postfix/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/postfix/metadata.yaml"
4
+sidebar_label: "Postfix"
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/Mail Servers"
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
+# Postfix
12
+
13
+
14
+<img src="https://netdata.cloud/img/postfix.svg" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: postfix
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector retrieves statistics about the Postfix mail queue using the [postqueue](https://www.postfix.org/postqueue.1.html) command-line tool.
25
+
26
+
27
+It periodically executes the `postqueue -p` command. The collection interval is set to 10 seconds by default, but this can be configurable.
28
+
29
+
30
+This collector is supported on all platforms.
31
+
32
+This collector only supports collecting metrics from a single instance of this integration.
33
+
34
+Postfix has internal access controls for the mail queue. By default, all users can view the queue. If your system has stricter controls, grant the `netdata` user access by adding it to `authorized_mailq_users` in the `/etc/postfix/main.cf `file. For more details, refer to the `authorized_mailq_users` setting in the [Postfix documentation](https://www.postfix.org/postconf.5.html).
35
+
36
+
37
+### Default Behavior
38
+
39
+#### Auto-Detection
40
+
41
+The collector executes `postqueue -p` to get Postfix queue statistics.
42
+
43
+#### Limits
44
+
45
+The default configuration for this integration does not impose any limits on data collection.
46
+
47
+#### Performance Impact
48
+
49
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
50
+
51
+
52
+## Metrics
53
+
54
+Metrics grouped by *scope*.
55
+
56
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
57
+
58
+
59
+
60
+### Per Postfix instance
61
+
62
+These metrics refer to the entire monitored application.
63
+
64
+
65
+This scope has no labels.
66
+
67
+Metrics:
68
+
69
+| Metric | Dimensions | Unit |
70
+|:------|:----------|:----|
71
+| postfix.qemails | emails | emails |
72
+| postfix.qsize | size | KiB |
73
+
74
+
75
+
76
+## Alerts
77
+
78
+There are no alerts configured by default for this integration.
79
+
80
+
81
+## Setup
82
+
83
+### Prerequisites
84
+
85
+No action required.
86
+
87
+### Configuration
88
+
89
+#### File
90
+
91
+There is no configuration file.
92
+#### Options
93
+
94
+The following options can be defined globally: update_every.
95
+
96
+
97
+<details open><summary>Config options</summary>
98
+
99
+| Name | Description | Default | Required |
100
+|:----|:-----------|:-------|:--------:|
101
+| update_every | Data collection frequency. | 10 | no |
102
+| binary_path | Path to the `postqueue` binary. If an absolute path is provided, the collector will use it directly; otherwise, it will search for the binary in directories specified in the PATH environment variable. | /usr/sbin/postqueue | yes |
103
+| timeout | Timeout for executing the binary, specified in seconds. | 2 | no |
104
+
105
+</details>
106
+
107
+#### Examples
108
+There are no configuration examples.
109
+
110
+
111
+
112
+## Troubleshooting
113
+
114
+### Debug Mode
115
+
116
+To troubleshoot issues with the `postfix` collector, run the `go.d.plugin` with the debug option enabled. The output
117
+should give you clues as to why the collector isn't working.
118
+
119
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
120
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
121
+
122
+ ```bash
123
+ cd /usr/libexec/netdata/plugins.d/
124
+ ```
125
+
126
+- Switch to the `netdata` user.
127
+
128
+ ```bash
129
+ sudo -u netdata -s
130
+ ```
131
+
132
+- Run the `go.d.plugin` to debug the collector:
133
+
134
+ ```bash
135
+ ./go.d.plugin -d -m postfix
136
+ ```
137
+
138
+### Getting Logs
139
+
140
+If you're encountering problems with the `postfix` collector, follow these steps to retrieve logs and identify potential issues:
141
+
142
+- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
143
+- **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.
144
+
145
+#### System with systemd
146
+
147
+Use the following command to view logs generated since the last Netdata service restart:
148
+
149
+```bash
150
+journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep postfix
151
+```
152
+
153
+#### System without systemd
154
+
155
+Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
156
+
157
+```bash
158
+grep postfix /var/log/netdata/collector.log
159
+```
160
+
161
+**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
162
+
163
+#### Docker Container
164
+
165
+If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
166
+
167
+```bash
168
+docker logs netdata 2>&1 | grep postfix
169
+```
170
+
171
+