@cryptotaxi247 / netdata-1 / commits / 26914ae6b

Regenerate integrations.js (#18324)

Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>

Netdata bot committed Aug 12, 2024 at 17:02 UTC 26914ae6b2edc6cc25fecd29c04f16d1b8efd4f9

5 files changed +320 -75

integrations/integrations.js

+38 -37

@@ -3960,6 +3960,44 @@ export const integrations = [

3960 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/dockerhub/metadata.yaml",

3961 "related_resources": ""

3962 },

3963 + {

3964 + "meta": {

3965 + "id": "collector-go.d.plugin-dovecot",

3966 + "plugin_name": "go.d.plugin",

3967 + "module_name": "dovecot",

3968 + "monitored_instance": {

3969 + "name": "Dovecot",

3970 + "link": "https://www.dovecot.org/",

3971 + "categories": [

3972 + "data-collection.mail-servers"

3973 + ],

3974 + "icon_filename": "dovecot.svg"

3975 + },

3976 + "related_resources": {

3977 + "integrations": {

3978 + "list": []

3979 + }

3980 + },

3981 + "info_provided_to_referring_integrations": {

3982 + "description": ""

3983 + },

3984 + "keywords": [

3985 + "dovecot",

3986 + "imap",

3987 + "mail"

3988 + ],

3989 + "most_popular": false

3990 + },

3991 + "overview": "# Dovecot\n\nPlugin: go.d.plugin\nModule: dovecot\n\n## Overview\n\nThis collector monitors Dovecot metrics about sessions, logins, commands, page faults and more.\n\n\nIt reads the server's response to the `EXPORT\\tglobal\\n` command.\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\nAutomatically discovers and collects Dovecot statistics from the following default locations:\n\n- localhost:24242\n- unix:///var/run/dovecot/old-stats\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",

3992 + "setup": "## Setup\n\n### Prerequisites\n\n#### Enable old_stats plugin\n\nTo enable `old_stats` plugin, see [Old Statistics](https://doc.dovecot.org/configuration_manual/stats/old_statistics/#old-statistics).\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/dovecot.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/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/dovecot.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n{% details open=true 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| address | The Unix or TCP socket address where the Dovecot [old_stats](https://doc.dovecot.org/configuration_manual/stats/old_statistics/#old-statistics) plugin listens for connections. | 127.0.0.1:24242 | yes |\n| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no |\n\n{% /details %}\n#### Examples\n\n##### Basic (TCP)\n\nA basic example configuration.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n address: 127.0.0.1:24242\n\n```\n{% /details %}\n##### Basic (UNIX)\n\nA basic example configuration using a UNIX socket.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n address: unix:///var/run/dovecot/old-stats\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 open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n address: 127.0.0.1:24242\n\n - name: remote\n address: 203.0.113.0:24242\n\n```\n{% /details %}\n",

3993 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `dovecot` 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 dovecot\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `dovecot` 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 dovecot\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 dovecot /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 dovecot\n```\n\n",

3994 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",

3995 + "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 Dovecot 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| dovecot.session | active | sessions |\n| dovecot.logins | logins | logins |\n| dovecot.auth | ok, failed | attempts/s |\n| dovecot.commands | commands | commands |\n| dovecot.context_switches | voluntary, voluntary | switches/s |\n| dovecot.io | read, write | KiB/s |\n| dovecot.net | read, write | kilobits/s |\n| dovecot.syscalls | read, write | syscalls/s |\n| dovecot.lookup | path, attr | lookups/s |\n| dovecot.cache | hits | hits/s |\n| dovecot.auth_cache | hits, misses | requests/s |\n\n",

3996 + "integration_type": "collector",

3997 + "id": "go.d.plugin-dovecot-Dovecot",

3998 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/dovecot/metadata.yaml",

3999 + "related_resources": ""

4000 + },

4001 {

4002 "meta": {

4003 "id": "collector-go.d.plugin-elasticsearch",

@@ -18957,43 +18995,6 @@ export const integrations = [

18995 "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/changefinder/metadata.yaml",

18996 "related_resources": ""

18997 },

18960 - {

18961 - "meta": {

18962 - "plugin_name": "python.d.plugin",

18963 - "module_name": "dovecot",

18964 - "monitored_instance": {

18965 - "name": "Dovecot",

18966 - "link": "https://www.dovecot.org/",

18967 - "categories": [

18968 - "data-collection.mail-servers"

18969 - ],

18970 - "icon_filename": "dovecot.svg"

18971 - },

18972 - "related_resources": {

18973 - "integrations": {

18974 - "list": []

18975 - }

18976 - },

18977 - "info_provided_to_referring_integrations": {

18978 - "description": ""

18979 - },

18980 - "keywords": [

18981 - "dovecot",

18982 - "imap",

18983 - "mail"

18984 - ],

18985 - "most_popular": false

18986 - },

18987 - "overview": "# Dovecot\n\nPlugin: python.d.plugin\nModule: dovecot\n\n## Overview\n\nThis collector monitors Dovecot metrics about sessions, logins, commands, page faults and more.\n\nIt uses the dovecot socket and executes the `EXPORT global` command to get the statistics.\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\nIf no configuration is given, the collector will attempt to connect to dovecot using unix socket localized in `/var/run/dovecot/stats`\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",

18988 - "setup": "## Setup\n\n### Prerequisites\n\n#### Dovecot configuration\n\nThe Dovecot UNIX socket should have R/W permissions for user netdata, or Dovecot should be configured with a TCP/IP socket.\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/dovecot.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/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 python.d/dovecot.conf\n```\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. | 5 | 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| socket | Use this socket to communicate with Devcot | /var/run/dovecot/stats | no |\n| host | Instead of using a socket, you can point the collector to an ip for devcot statistics. | | no |\n| port | Used in combination with host, configures the port devcot listens to. | | no |\n\n{% /details %}\n#### Examples\n\n##### Local TCP\n\nA basic TCP configuration.\n\n{% details open=true summary=\"Config\" %}\n```yaml\nlocaltcpip:\n name: 'local'\n host: '127.0.0.1'\n port: 24242\n\n```\n{% /details %}\n##### Local socket\n\nA basic local socket configuration\n\n{% details open=true summary=\"Config\" %}\n```yaml\nlocalsocket:\n name: 'local'\n socket: '/var/run/dovecot/stats'\n\n```\n{% /details %}\n",

18989 - "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `dovecot` 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 dovecot debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `dovecot` 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 dovecot\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 dovecot /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 dovecot\n```\n\n",

18990 - "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",

18991 - "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 Dovecot 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| dovecot.sessions | active sessions | number |\n| dovecot.logins | logins | number |\n| dovecot.commands | commands | commands |\n| dovecot.faults | minor, major | faults |\n| dovecot.context_switches | voluntary, involuntary | switches |\n| dovecot.io | read, write | KiB/s |\n| dovecot.net | read, write | kilobits/s |\n| dovecot.syscalls | read, write | syscalls/s |\n| dovecot.lookup | path, attr | number/s |\n| dovecot.cache | hits | hits/s |\n| dovecot.auth | ok, failed | attempts |\n| dovecot.auth_cache | hit, miss | number |\n\n",

18992 - "integration_type": "collector",

18993 - "id": "python.d.plugin-dovecot-Dovecot",

18994 - "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/dovecot/metadata.yaml",

18995 - "related_resources": ""

18996 - },

18998 {

18999 "meta": {

19000 "plugin_name": "python.d.plugin",

integrations/integrations.json

+38 -37

@@ -3958,6 +3958,44 @@

3958 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/dockerhub/metadata.yaml",

3959 "related_resources": ""

3960 },

3961 + {

3962 + "meta": {

3963 + "id": "collector-go.d.plugin-dovecot",

3964 + "plugin_name": "go.d.plugin",

3965 + "module_name": "dovecot",

3966 + "monitored_instance": {

3967 + "name": "Dovecot",

3968 + "link": "https://www.dovecot.org/",

3969 + "categories": [

3970 + "data-collection.mail-servers"

3971 + ],

3972 + "icon_filename": "dovecot.svg"

3973 + },

3974 + "related_resources": {

3975 + "integrations": {

3976 + "list": []

3977 + }

3978 + },

3979 + "info_provided_to_referring_integrations": {

3980 + "description": ""

3981 + },

3982 + "keywords": [

3983 + "dovecot",

3984 + "imap",

3985 + "mail"

3986 + ],

3987 + "most_popular": false

3988 + },

3989 + "overview": "# Dovecot\n\nPlugin: go.d.plugin\nModule: dovecot\n\n## Overview\n\nThis collector monitors Dovecot metrics about sessions, logins, commands, page faults and more.\n\n\nIt reads the server's response to the `EXPORT\\tglobal\\n` command.\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\nAutomatically discovers and collects Dovecot statistics from the following default locations:\n\n- localhost:24242\n- unix:///var/run/dovecot/old-stats\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",

3990 + "setup": "## Setup\n\n### Prerequisites\n\n#### Enable old_stats plugin\n\nTo enable `old_stats` plugin, see [Old Statistics](https://doc.dovecot.org/configuration_manual/stats/old_statistics/#old-statistics).\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/dovecot.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/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/dovecot.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| address | The Unix or TCP socket address where the Dovecot [old_stats](https://doc.dovecot.org/configuration_manual/stats/old_statistics/#old-statistics) plugin listens for connections. | 127.0.0.1:24242 | yes |\n| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no |\n\n#### Examples\n\n##### Basic (TCP)\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n address: 127.0.0.1:24242\n\n```\n##### Basic (UNIX)\n\nA basic example configuration using a UNIX socket.\n\n```yaml\njobs:\n - name: local\n address: unix:///var/run/dovecot/old-stats\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 address: 127.0.0.1:24242\n\n - name: remote\n address: 203.0.113.0:24242\n\n```\n",

3991 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `dovecot` 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 dovecot\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `dovecot` 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 dovecot\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 dovecot /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 dovecot\n```\n\n",

3992 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",

3993 + "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 Dovecot 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| dovecot.session | active | sessions |\n| dovecot.logins | logins | logins |\n| dovecot.auth | ok, failed | attempts/s |\n| dovecot.commands | commands | commands |\n| dovecot.context_switches | voluntary, voluntary | switches/s |\n| dovecot.io | read, write | KiB/s |\n| dovecot.net | read, write | kilobits/s |\n| dovecot.syscalls | read, write | syscalls/s |\n| dovecot.lookup | path, attr | lookups/s |\n| dovecot.cache | hits | hits/s |\n| dovecot.auth_cache | hits, misses | requests/s |\n\n",

3994 + "integration_type": "collector",

3995 + "id": "go.d.plugin-dovecot-Dovecot",

3996 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/dovecot/metadata.yaml",

3997 + "related_resources": ""

3998 + },

3999 {

4000 "meta": {

4001 "id": "collector-go.d.plugin-elasticsearch",

@@ -18955,43 +18993,6 @@

18993 "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/changefinder/metadata.yaml",

18994 "related_resources": ""

18995 },

18958 - {

18959 - "meta": {

18960 - "plugin_name": "python.d.plugin",

18961 - "module_name": "dovecot",

18962 - "monitored_instance": {

18963 - "name": "Dovecot",

18964 - "link": "https://www.dovecot.org/",

18965 - "categories": [

18966 - "data-collection.mail-servers"

18967 - ],

18968 - "icon_filename": "dovecot.svg"

18969 - },

18970 - "related_resources": {

18971 - "integrations": {

18972 - "list": []

18973 - }

18974 - },

18975 - "info_provided_to_referring_integrations": {

18976 - "description": ""

18977 - },

18978 - "keywords": [

18979 - "dovecot",

18980 - "imap",

18981 - "mail"

18982 - ],

18983 - "most_popular": false

18984 - },

18985 - "overview": "# Dovecot\n\nPlugin: python.d.plugin\nModule: dovecot\n\n## Overview\n\nThis collector monitors Dovecot metrics about sessions, logins, commands, page faults and more.\n\nIt uses the dovecot socket and executes the `EXPORT global` command to get the statistics.\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\nIf no configuration is given, the collector will attempt to connect to dovecot using unix socket localized in `/var/run/dovecot/stats`\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",

18986 - "setup": "## Setup\n\n### Prerequisites\n\n#### Dovecot configuration\n\nThe Dovecot UNIX socket should have R/W permissions for user netdata, or Dovecot should be configured with a TCP/IP socket.\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/dovecot.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/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 python.d/dovecot.conf\n```\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. | 5 | 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| socket | Use this socket to communicate with Devcot | /var/run/dovecot/stats | no |\n| host | Instead of using a socket, you can point the collector to an ip for devcot statistics. | | no |\n| port | Used in combination with host, configures the port devcot listens to. | | no |\n\n#### Examples\n\n##### Local TCP\n\nA basic TCP configuration.\n\n```yaml\nlocaltcpip:\n name: 'local'\n host: '127.0.0.1'\n port: 24242\n\n```\n##### Local socket\n\nA basic local socket configuration\n\n```yaml\nlocalsocket:\n name: 'local'\n socket: '/var/run/dovecot/stats'\n\n```\n",

18987 - "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `dovecot` 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 dovecot debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `dovecot` 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 dovecot\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 dovecot /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 dovecot\n```\n\n",

18988 - "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",

18989 - "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 Dovecot 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| dovecot.sessions | active sessions | number |\n| dovecot.logins | logins | number |\n| dovecot.commands | commands | commands |\n| dovecot.faults | minor, major | faults |\n| dovecot.context_switches | voluntary, involuntary | switches |\n| dovecot.io | read, write | KiB/s |\n| dovecot.net | read, write | kilobits/s |\n| dovecot.syscalls | read, write | syscalls/s |\n| dovecot.lookup | path, attr | number/s |\n| dovecot.cache | hits | hits/s |\n| dovecot.auth | ok, failed | attempts |\n| dovecot.auth_cache | hit, miss | number |\n\n",

18990 - "integration_type": "collector",

18991 - "id": "python.d.plugin-dovecot-Dovecot",

18992 - "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/dovecot/metadata.yaml",

18993 - "related_resources": ""

18994 - },

18996 {

18997 "meta": {

18998 "plugin_name": "python.d.plugin",

src/collectors/COLLECTORS.md

+1 -1

@@ -745,7 +745,7 @@ If you don't see the app/service you'd like to monitor in this list:

745

746 - [DMARC](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/dmarc.md)

747

748 -- [Dovecot](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/dovecot/integrations/dovecot.md)

748 +- [Dovecot](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/dovecot/integrations/dovecot.md)

749

750 - [Exim](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/exim/integrations/exim.md)

751

src/go/plugin/go.d/modules/dovecot/README.md new

@@ -0,0 +1 @@

1 +integrations/dovecot.md

\ No newline at end of file

src/go/plugin/go.d/modules/dovecot/integrations/dovecot.md new

+242

@@ -0,0 +1,242 @@

1 +<!--startmeta

2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/dovecot/README.md"

3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/dovecot/metadata.yaml"

4 +sidebar_label: "Dovecot"

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 +# Dovecot

12 +

13 +

14 +<img src="https://netdata.cloud/img/dovecot.svg" width="150"/>

15 +

16 +

17 +Plugin: go.d.plugin

18 +Module: dovecot

19 +

20 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />

21 +

22 +## Overview

23 +

24 +This collector monitors Dovecot metrics about sessions, logins, commands, page faults and more.

25 +

26 +

27 +It reads the server's response to the `EXPORT\tglobal\n` command.

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 +Automatically discovers and collects Dovecot statistics from the following default locations:

40 +

41 +- localhost:24242

42 +- unix:///var/run/dovecot/old-stats

43 +

44 +

45 +#### Limits

46 +

47 +The default configuration for this integration does not impose any limits on data collection.

48 +

49 +#### Performance Impact

50 +

51 +The default configuration for this integration is not expected to impose a significant performance impact on the system.

52 +

53 +

54 +## Metrics

55 +

56 +Metrics grouped by *scope*.

57 +

58 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

59 +

60 +

61 +

62 +### Per Dovecot instance

63 +

64 +These metrics refer to the entire monitored application.

65 +

66 +This scope has no labels.

67 +

68 +Metrics:

69 +

70 +| Metric | Dimensions | Unit |

71 +|:------|:----------|:----|

72 +| dovecot.session | active | sessions |

73 +| dovecot.logins | logins | logins |

74 +| dovecot.auth | ok, failed | attempts/s |

75 +| dovecot.commands | commands | commands |

76 +| dovecot.context_switches | voluntary, voluntary | switches/s |

77 +| dovecot.io | read, write | KiB/s |

78 +| dovecot.net | read, write | kilobits/s |

79 +| dovecot.syscalls | read, write | syscalls/s |

80 +| dovecot.lookup | path, attr | lookups/s |

81 +| dovecot.cache | hits | hits/s |

82 +| dovecot.auth_cache | hits, misses | requests/s |

83 +

84 +

85 +

86 +## Alerts

87 +

88 +There are no alerts configured by default for this integration.

89 +

90 +

91 +## Setup

92 +

93 +### Prerequisites

94 +

95 +#### Enable old_stats plugin

96 +

97 +To enable `old_stats` plugin, see [Old Statistics](https://doc.dovecot.org/configuration_manual/stats/old_statistics/#old-statistics).

98 +

99 +

100 +

101 +### Configuration

102 +

103 +#### File

104 +

105 +The configuration file name for this integration is `go.d/dovecot.conf`.

106 +

107 +

108 +You can edit the configuration file using the `edit-config` script from the

109 +Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).

110 +

111 +```bash

112 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata

113 +sudo ./edit-config go.d/dovecot.conf

114 +```

115 +#### Options

116 +

117 +The following options can be defined globally: update_every, autodetection_retry.

118 +

119 +

120 +<details open><summary>Config options</summary>

121 +

123 +|:----|:-----------|:-------|:--------:|

124 +| update_every | Data collection frequency. | 1 | no |

125 +| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |

126 +| address | The Unix or TCP socket address where the Dovecot [old_stats](https://doc.dovecot.org/configuration_manual/stats/old_statistics/#old-statistics) plugin listens for connections. | 127.0.0.1:24242 | yes |

127 +| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no |

128 +

129 +</details>

130 +

131 +#### Examples

132 +

133 +##### Basic (TCP)

134 +

135 +A basic example configuration.

136 +

137 +<details open><summary>Config</summary>

138 +

139 +```yaml

140 +jobs:

141 + - name: local

142 + address: 127.0.0.1:24242

143 +

144 +```

145 +</details>

146 +

147 +##### Basic (UNIX)

148 +

149 +A basic example configuration using a UNIX socket.

150 +

151 +<details open><summary>Config</summary>

152 +

153 +```yaml

154 +jobs:

155 + - name: local

156 + address: unix:///var/run/dovecot/old-stats

157 +

158 +```

159 +</details>

160 +

161 +##### Multi-instance

162 +

163 +> **Note**: When you define multiple jobs, their names must be unique.

164 +

165 +Collecting metrics from local and remote instances.

166 +

167 +

168 +<details open><summary>Config</summary>

169 +

170 +```yaml

171 +jobs:

172 + - name: local

173 + address: 127.0.0.1:24242

174 +

175 + - name: remote

176 + address: 203.0.113.0:24242

177 +

178 +```

179 +</details>

180 +

181 +

182 +

183 +## Troubleshooting

184 +

185 +### Debug Mode

186 +

187 +To troubleshoot issues with the `dovecot` collector, run the `go.d.plugin` with the debug option enabled. The output

188 +should give you clues as to why the collector isn't working.

189 +

190 +- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on

191 + your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.

192 +

193 + ```bash

194 + cd /usr/libexec/netdata/plugins.d/

195 + ```

196 +

197 +- Switch to the `netdata` user.

198 +

199 + ```bash

200 + sudo -u netdata -s

201 + ```

202 +

203 +- Run the `go.d.plugin` to debug the collector:

204 +

205 + ```bash

206 + ./go.d.plugin -d -m dovecot

207 + ```

208 +

209 +### Getting Logs

210 +

211 +If you're encountering problems with the `dovecot` collector, follow these steps to retrieve logs and identify potential issues:

212 +

213 +- **Run the command** specific to your system (systemd, non-systemd, or Docker container).

214 +- **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.

215 +

216 +#### System with systemd

217 +

218 +Use the following command to view logs generated since the last Netdata service restart:

219 +

220 +```bash

221 +journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep dovecot

222 +```

223 +

224 +#### System without systemd

225 +

226 +Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:

227 +

228 +```bash

229 +grep dovecot /var/log/netdata/collector.log

230 +```

231 +

232 +**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.

233 +

234 +#### Docker Container

235 +

236 +If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

237 +

238 +```bash

239 +docker logs netdata 2>&1 | grep dovecot

240 +```

241 +

242 +