@cryptotaxi247 / netdata-1 / commits / b2ce8814b

Regenerate integrations.js (#18363)

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

Netdata bot committed Aug 18, 2024 at 16:28 UTC b2ce8814b4fef08dec806f8b3648c4663247b2cc

5 files changed +301 -75

integrations/integrations.js

+38 -37

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

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

16791 "related_resources": ""

16792 },

16793 + {

16794 + "meta": {

16795 + "id": "collector-go.d.plugin-tor",

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

16797 + "module_name": "tor",

16798 + "monitored_instance": {

16799 + "name": "Tor",

16800 + "link": "https://www.torproject.org/",

16801 + "categories": [

16802 + "data-collection.vpns"

16803 + ],

16804 + "icon_filename": "tor.svg"

16805 + },

16806 + "related_resources": {

16807 + "integrations": {

16808 + "list": []

16809 + }

16810 + },

16811 + "info_provided_to_referring_integrations": {

16812 + "description": ""

16813 + },

16814 + "keywords": [

16815 + "tor",

16816 + "traffic",

16817 + "vpn"

16818 + ],

16819 + "most_popular": false

16820 + },

16821 + "overview": "# Tor\n\nPlugin: go.d.plugin\nModule: tor\n\n## Overview\n\nTracks Tor's download and upload traffic, as well as its uptime.\n\n\nIt reads the server's response to the [GETINFO](https://spec.torproject.org/control-spec/commands.html#getinfo) 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\nBy default, it detects Tor instances running on localhost that are listening on port 9051.\nOn startup, it tries to collect metrics from:\n\n- 127.0.0.1:9051\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",

16822 + "setup": "## Setup\n\n### Prerequisites\n\n#### Enable Control Port\n\nEnable `ControlPort` in `/etc/tor/torrc`.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/tor.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/tor.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 IP address and port where the Tor's Control Port listens for connections. | 127.0.0.1:9051 | yes |\n| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no |\n| password | Password for authentication. | | no |\n\n{% /details %}\n#### Examples\n\n##### Basic\n\nA basic example configuration.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n address: 127.0.0.1:9051\n password: somePassword\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:9051\n password: somePassword\n\n - name: remote\n address: 203.0.113.0:9051\n password: somePassword\n\n```\n{% /details %}\n",

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

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

16825 + "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 Tor 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| tor.traffic | read, write | KiB/s |\n| tor.uptime | uptime | seconds |\n\n",

16826 + "integration_type": "collector",

16827 + "id": "go.d.plugin-tor-Tor",

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

16829 + "related_resources": ""

16830 + },

16831 {

16832 "meta": {

16833 "id": "collector-go.d.plugin-traefik",

@@ -19370,43 +19408,6 @@ export const integrations = [

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

19409 "related_resources": ""

19410 },

19373 - {

19374 - "meta": {

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

19376 - "module_name": "tor",

19377 - "monitored_instance": {

19378 - "name": "Tor",

19379 - "link": "https://www.torproject.org/",

19380 - "categories": [

19381 - "data-collection.vpns"

19382 - ],

19383 - "icon_filename": "tor.svg"

19384 - },

19385 - "related_resources": {

19386 - "integrations": {

19387 - "list": []

19388 - }

19389 - },

19390 - "info_provided_to_referring_integrations": {

19391 - "description": ""

19392 - },

19393 - "keywords": [

19394 - "tor",

19395 - "traffic",

19396 - "vpn"

19397 - ],

19398 - "most_popular": false

19399 - },

19400 - "overview": "# Tor\n\nPlugin: python.d.plugin\nModule: tor\n\n## Overview\n\nThis collector monitors Tor bandwidth traffic .\n\nIt connects to the Tor control port to collect traffic 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 provided the collector will try to connect to 127.0.0.1:9051 to detect a running tor instance.\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",

19401 - "setup": "## Setup\n\n### Prerequisites\n\n#### Required python module\n\nThe `stem` python library needs to be installed.\n\n\n#### Required Tor configuration\n\nAdd to /etc/tor/torrc:\n\nControlPort 9051\n\nFor more options please read the manual.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/tor.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/tor.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| control_addr | Tor control IP address | 127.0.0.1 | no |\n| control_port | Tor control port. Can be either a tcp port, or a path to a socket file. | 9051 | no |\n| password | Tor control password | | no |\n\n{% /details %}\n#### Examples\n\n##### Local TCP\n\nA basic TCP configuration. `local_addr` is ommited and will default to `127.0.0.1`\n\n{% details open=true summary=\"Config\" %}\n```yaml\nlocal_tcp:\n name: 'local'\n control_port: 9051\n password: <password> # if required\n\n```\n{% /details %}\n##### Local socket\n\nA basic local socket configuration\n\n{% details open=true summary=\"Config\" %}\n```yaml\nlocal_socket:\n name: 'local'\n control_port: '/var/run/tor/control'\n password: <password> # if required\n\n```\n{% /details %}\n",

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

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

19404 - "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 Tor 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| tor.traffic | read, write | KiB/s |\n\n",

19405 - "integration_type": "collector",

19406 - "id": "python.d.plugin-tor-Tor",

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

19408 - "related_resources": ""

19409 - },

19411 {

19412 "meta": {

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

integrations/integrations.json

+38 -37

@@ -16788,6 +16788,44 @@

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

16789 "related_resources": ""

16790 },

16791 + {

16792 + "meta": {

16793 + "id": "collector-go.d.plugin-tor",

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

16795 + "module_name": "tor",

16796 + "monitored_instance": {

16797 + "name": "Tor",

16798 + "link": "https://www.torproject.org/",

16799 + "categories": [

16800 + "data-collection.vpns"

16801 + ],

16802 + "icon_filename": "tor.svg"

16803 + },

16804 + "related_resources": {

16805 + "integrations": {

16806 + "list": []

16807 + }

16808 + },

16809 + "info_provided_to_referring_integrations": {

16810 + "description": ""

16811 + },

16812 + "keywords": [

16813 + "tor",

16814 + "traffic",

16815 + "vpn"

16816 + ],

16817 + "most_popular": false

16818 + },

16819 + "overview": "# Tor\n\nPlugin: go.d.plugin\nModule: tor\n\n## Overview\n\nTracks Tor's download and upload traffic, as well as its uptime.\n\n\nIt reads the server's response to the [GETINFO](https://spec.torproject.org/control-spec/commands.html#getinfo) 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\nBy default, it detects Tor instances running on localhost that are listening on port 9051.\nOn startup, it tries to collect metrics from:\n\n- 127.0.0.1:9051\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",

16820 + "setup": "## Setup\n\n### Prerequisites\n\n#### Enable Control Port\n\nEnable `ControlPort` in `/etc/tor/torrc`.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/tor.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/tor.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 IP address and port where the Tor's Control Port listens for connections. | 127.0.0.1:9051 | yes |\n| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no |\n| password | Password for authentication. | | no |\n\n#### Examples\n\n##### Basic\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n address: 127.0.0.1:9051\n password: somePassword\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:9051\n password: somePassword\n\n - name: remote\n address: 203.0.113.0:9051\n password: somePassword\n\n```\n",

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

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

16823 + "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 Tor 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| tor.traffic | read, write | KiB/s |\n| tor.uptime | uptime | seconds |\n\n",

16824 + "integration_type": "collector",

16825 + "id": "go.d.plugin-tor-Tor",

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

16827 + "related_resources": ""

16828 + },

16829 {

16830 "meta": {

16831 "id": "collector-go.d.plugin-traefik",

@@ -19368,43 +19406,6 @@

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

19407 "related_resources": ""

19408 },

19371 - {

19372 - "meta": {

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

19374 - "module_name": "tor",

19375 - "monitored_instance": {

19376 - "name": "Tor",

19377 - "link": "https://www.torproject.org/",

19378 - "categories": [

19379 - "data-collection.vpns"

19380 - ],

19381 - "icon_filename": "tor.svg"

19382 - },

19383 - "related_resources": {

19384 - "integrations": {

19385 - "list": []

19386 - }

19387 - },

19388 - "info_provided_to_referring_integrations": {

19389 - "description": ""

19390 - },

19391 - "keywords": [

19392 - "tor",

19393 - "traffic",

19394 - "vpn"

19395 - ],

19396 - "most_popular": false

19397 - },

19398 - "overview": "# Tor\n\nPlugin: python.d.plugin\nModule: tor\n\n## Overview\n\nThis collector monitors Tor bandwidth traffic .\n\nIt connects to the Tor control port to collect traffic 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 provided the collector will try to connect to 127.0.0.1:9051 to detect a running tor instance.\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",

19399 - "setup": "## Setup\n\n### Prerequisites\n\n#### Required python module\n\nThe `stem` python library needs to be installed.\n\n\n#### Required Tor configuration\n\nAdd to /etc/tor/torrc:\n\nControlPort 9051\n\nFor more options please read the manual.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/tor.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/tor.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| control_addr | Tor control IP address | 127.0.0.1 | no |\n| control_port | Tor control port. Can be either a tcp port, or a path to a socket file. | 9051 | no |\n| password | Tor control password | | no |\n\n#### Examples\n\n##### Local TCP\n\nA basic TCP configuration. `local_addr` is ommited and will default to `127.0.0.1`\n\n```yaml\nlocal_tcp:\n name: 'local'\n control_port: 9051\n password: <password> # if required\n\n```\n##### Local socket\n\nA basic local socket configuration\n\n```yaml\nlocal_socket:\n name: 'local'\n control_port: '/var/run/tor/control'\n password: <password> # if required\n\n```\n",

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

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

19402 - "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 Tor 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| tor.traffic | read, write | KiB/s |\n\n",

19403 - "integration_type": "collector",

19404 - "id": "python.d.plugin-tor-Tor",

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

19406 - "related_resources": ""

19407 - },

19409 {

19410 "meta": {

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

src/collectors/COLLECTORS.md

+1 -1

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

1107

1108 - [Speedify CLI](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/speedify_cli.md)

1109

1110 -- [Tor](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/tor/integrations/tor.md)

1110 +- [Tor](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/tor/integrations/tor.md)

1111

1112 - [WireGuard](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/wireguard/integrations/wireguard.md)

1113

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

@@ -0,0 +1 @@

1 +integrations/tor.md

\ No newline at end of file

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

+223

@@ -0,0 +1,223 @@

1 +<!--startmeta

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

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

4 +sidebar_label: "Tor"

5 +learn_status: "Published"

6 +learn_rel_path: "Collecting Metrics/VPNs"

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

12 +

13 +

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

15 +

16 +

17 +Plugin: go.d.plugin

18 +Module: tor

19 +

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

21 +

22 +## Overview

23 +

24 +Tracks Tor's download and upload traffic, as well as its uptime.

25 +

26 +

27 +It reads the server's response to the [GETINFO](https://spec.torproject.org/control-spec/commands.html#getinfo) 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 +By default, it detects Tor instances running on localhost that are listening on port 9051.

40 +On startup, it tries to collect metrics from:

41 +

42 +- 127.0.0.1:9051

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 Tor 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 +| tor.traffic | read, write | KiB/s |

73 +| tor.uptime | uptime | seconds |

74 +

75 +

76 +

77 +## Alerts

78 +

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

80 +

81 +

82 +## Setup

83 +

84 +### Prerequisites

85 +

86 +#### Enable Control Port

87 +

88 +Enable `ControlPort` in `/etc/tor/torrc`.

89 +

90 +

91 +

92 +### Configuration

93 +

94 +#### File

95 +

96 +The configuration file name for this integration is `go.d/tor.conf`.

97 +

98 +

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

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

101 +

102 +```bash

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

104 +sudo ./edit-config go.d/tor.conf

105 +```

106 +#### Options

107 +

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

109 +

110 +

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

112 +

114 +|:----|:-----------|:-------|:--------:|

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

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

117 +| address | The IP address and port where the Tor's Control Port listens for connections. | 127.0.0.1:9051 | yes |

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

119 +| password | Password for authentication. | | no |

120 +

121 +</details>

122 +

123 +#### Examples

124 +

125 +##### Basic

126 +

127 +A basic example configuration.

128 +

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

130 +

131 +```yaml

132 +jobs:

133 + - name: local

134 + address: 127.0.0.1:9051

135 + password: somePassword

136 +

137 +```

138 +</details>

139 +

140 +##### Multi-instance

141 +

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

143 +

144 +Collecting metrics from local and remote instances.

145 +

146 +

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

148 +

149 +```yaml

150 +jobs:

151 + - name: local

152 + address: 127.0.0.1:9051

153 + password: somePassword

154 +

155 + - name: remote

156 + address: 203.0.113.0:9051

157 + password: somePassword

158 +

159 +```

160 +</details>

161 +

162 +

163 +

164 +## Troubleshooting

165 +

166 +### Debug Mode

167 +

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

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

170 +

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

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

173 +

174 + ```bash

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

176 + ```

177 +

178 +- Switch to the `netdata` user.

179 +

180 + ```bash

181 + sudo -u netdata -s

182 + ```

183 +

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

185 +

186 + ```bash

187 + ./go.d.plugin -d -m tor

188 + ```

189 +

190 +### Getting Logs

191 +

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

193 +

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

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

196 +

197 +#### System with systemd

198 +

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

200 +

201 +```bash

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

203 +```

204 +

205 +#### System without systemd

206 +

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

208 +

209 +```bash

210 +grep tor /var/log/netdata/collector.log

211 +```

212 +

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

214 +

215 +#### Docker Container

216 +

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

218 +

219 +```bash

220 +docker logs netdata 2>&1 | grep tor

221 +```

222 +

223 +