@cryptotaxi247 / netdata-1 / commits / f6b17c45d

Regenerate integrations.js (#18280)

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

Netdata bot committed Aug 8, 2024 at 14:55 UTC f6b17c45d9faaef30a16574c9d5ce83b26dba211
5 files changed +333 -75
integrations/integrations.js
+38 -37
@@ -16059,6 +16059,44 @@ export const integrations = [
16059 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/redis/metadata.yaml",
16060 "related_resources": ""
16061 },
16062 + {
16063 + "meta": {
16064 + "id": "collector-go.d.plugin-rethinkdb",
16065 + "plugin_name": "go.d.plugin",
16066 + "module_name": "rethinkdb",
16067 + "monitored_instance": {
16068 + "name": "RethinkDB",
16069 + "link": "https://rethinkdb.com",
16070 + "categories": [
16071 + "data-collection.database-servers"
16072 + ],
16073 + "icon_filename": "rethinkdb.png"
16074 + },
16075 + "related_resources": {
16076 + "integrations": {
16077 + "list": []
16078 + }
16079 + },
16080 + "info_provided_to_referring_integrations": {
16081 + "description": ""
16082 + },
16083 + "keywords": [
16084 + "rethinkdb",
16085 + "database",
16086 + "db"
16087 + ],
16088 + "most_popular": false
16089 + },
16090 + "overview": "# RethinkDB\n\nPlugin: go.d.plugin\nModule: rethinkdb\n\n## Overview\n\nIt collects cluster-wide metrics such as server status, client connections, active clients, query rate, and document read/write rates.\nFor each server, it offers similar metrics.\n\n\nThe data is gathered by querying the stats table in RethinkDB, which stores real-time statistics related to the cluster and its individual servers.\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\nIf no configuration is given, collector will attempt to connect to RethinkDB instance on `127.0.0.1:28015` address.\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",
16091 + "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/rethinkdb.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/rethinkdb.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 RethinkDB service listens for connections. | 127.0.0.1:28015 | yes |\n| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no |\n| username | Username used for authentication. | | no |\n| password | Password used 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:28015\n\n```\n{% /details %}\n##### With authentication\n\nAn example configuration with authentication.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n address: 127.0.0.1:28015\n username: name\n password: pass\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:28015\n\n - name: remote\n address: 203.0.113.0:28015\n\n```\n{% /details %}\n",
16092 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `rethinkdb` 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 rethinkdb\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `rethinkdb` 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 rethinkdb\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 rethinkdb /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 rethinkdb\n```\n\n",
16093 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
16094 + "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 RethinkDB 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| rethinkdb.cluster_servers_stats_request | success, timeout | servers |\n| rethinkdb.cluster_client_connections | connections | connections |\n| rethinkdb.cluster_active_clients | active | clients |\n| rethinkdb.cluster_queries | queries | queries/s |\n| rethinkdb.cluster_documents | read, written | documents/s |\n\n### Per server\n\nThese metrics refer to the server (cluster member).\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| server_uuid | Server UUID. |\n| server_name | Server name. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| rethinkdb.server_stats_request_status | success, timeout | status |\n| rethinkdb.server_client_connections | connections | connections |\n| rethinkdb.server_active_clients | active | clients |\n| rethinkdb.server_queries | queries | queries/s |\n| rethinkdb.server_documents | read, written | documents/s |\n\n",
16095 + "integration_type": "collector",
16096 + "id": "go.d.plugin-rethinkdb-RethinkDB",
16097 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/rethinkdb/metadata.yaml",
16098 + "related_resources": ""
16099 + },
16100 {
16101 "meta": {
16102 "id": "collector-go.d.plugin-rspamd",
@@ -19175,43 +19213,6 @@ export const integrations = [
19213 "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/pandas/metadata.yaml",
19214 "related_resources": ""
19215 },
19178 - {
19179 - "meta": {
19180 - "plugin_name": "python.d.plugin",
19181 - "module_name": "rethinkdbs",
19182 - "monitored_instance": {
19183 - "name": "RethinkDB",
19184 - "link": "https://rethinkdb.com/",
19185 - "categories": [
19186 - "data-collection.database-servers"
19187 - ],
19188 - "icon_filename": "rethinkdb.png"
19189 - },
19190 - "related_resources": {
19191 - "integrations": {
19192 - "list": []
19193 - }
19194 - },
19195 - "info_provided_to_referring_integrations": {
19196 - "description": ""
19197 - },
19198 - "keywords": [
19199 - "rethinkdb",
19200 - "database",
19201 - "db"
19202 - ],
19203 - "most_popular": false
19204 - },
19205 - "overview": "# RethinkDB\n\nPlugin: python.d.plugin\nModule: rethinkdbs\n\n## Overview\n\nThis collector monitors metrics about RethinkDB clusters and database servers.\n\nIt uses the `rethinkdb` python module to connect to a RethinkDB server instance and gather 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\nWhen no configuration file is found, the collector tries to connect to 127.0.0.1:28015.\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",
19206 - "setup": "## Setup\n\n### Prerequisites\n\n#### Required python module\n\nThe collector requires the `rethinkdb` python module to be installed.\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/rethinkdbs.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/rethinkdbs.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| host | Hostname or ip of the RethinkDB server. | localhost | no |\n| port | Port to connect to the RethinkDB server. | 28015 | no |\n| user | The username to use to connect to the RethinkDB server. | admin | no |\n| password | The password to use to connect to the RethinkDB server. | | no |\n| timeout | Set a connect timeout to the RethinkDB server. | 2 | no |\n\n{% /details %}\n#### Examples\n\n##### Local RethinkDB server\n\nAn example of a configuration for a local RethinkDB server\n\n```yaml\nlocalhost:\n name: 'local'\n host: '127.0.0.1'\n port: 28015\n user: \"user\"\n password: \"pass\"\n\n```\n",
19207 - "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `rethinkdbs` 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 rethinkdbs debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `rethinkdbs` 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 rethinkdbs\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 rethinkdbs /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 rethinkdbs\n```\n\n",
19208 - "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19209 - "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 RethinkDB 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| rethinkdb.cluster_connected_servers | connected, missing | servers |\n| rethinkdb.cluster_clients_active | active | clients |\n| rethinkdb.cluster_queries | queries | queries/s |\n| rethinkdb.cluster_documents | reads, writes | documents/s |\n\n### Per database server\n\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| rethinkdb.client_connections | connections | connections |\n| rethinkdb.clients_active | active | clients |\n| rethinkdb.queries | queries | queries/s |\n| rethinkdb.documents | reads, writes | documents/s |\n\n",
19210 - "integration_type": "collector",
19211 - "id": "python.d.plugin-rethinkdbs-RethinkDB",
19212 - "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/rethinkdbs/metadata.yaml",
19213 - "related_resources": ""
19214 - },
19216 {
19217 "meta": {
19218 "plugin_name": "python.d.plugin",
integrations/integrations.json
+38 -37
@@ -16057,6 +16057,44 @@
16057 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/redis/metadata.yaml",
16058 "related_resources": ""
16059 },
16060 + {
16061 + "meta": {
16062 + "id": "collector-go.d.plugin-rethinkdb",
16063 + "plugin_name": "go.d.plugin",
16064 + "module_name": "rethinkdb",
16065 + "monitored_instance": {
16066 + "name": "RethinkDB",
16067 + "link": "https://rethinkdb.com",
16068 + "categories": [
16069 + "data-collection.database-servers"
16070 + ],
16071 + "icon_filename": "rethinkdb.png"
16072 + },
16073 + "related_resources": {
16074 + "integrations": {
16075 + "list": []
16076 + }
16077 + },
16078 + "info_provided_to_referring_integrations": {
16079 + "description": ""
16080 + },
16081 + "keywords": [
16082 + "rethinkdb",
16083 + "database",
16084 + "db"
16085 + ],
16086 + "most_popular": false
16087 + },
16088 + "overview": "# RethinkDB\n\nPlugin: go.d.plugin\nModule: rethinkdb\n\n## Overview\n\nIt collects cluster-wide metrics such as server status, client connections, active clients, query rate, and document read/write rates.\nFor each server, it offers similar metrics.\n\n\nThe data is gathered by querying the stats table in RethinkDB, which stores real-time statistics related to the cluster and its individual servers.\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\nIf no configuration is given, collector will attempt to connect to RethinkDB instance on `127.0.0.1:28015` address.\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",
16089 + "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/rethinkdb.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/rethinkdb.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 RethinkDB service listens for connections. | 127.0.0.1:28015 | yes |\n| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no |\n| username | Username used for authentication. | | no |\n| password | Password used 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:28015\n\n```\n##### With authentication\n\nAn example configuration with authentication.\n\n```yaml\njobs:\n - name: local\n address: 127.0.0.1:28015\n username: name\n password: pass\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:28015\n\n - name: remote\n address: 203.0.113.0:28015\n\n```\n",
16090 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `rethinkdb` 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 rethinkdb\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `rethinkdb` 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 rethinkdb\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 rethinkdb /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 rethinkdb\n```\n\n",
16091 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
16092 + "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 RethinkDB 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| rethinkdb.cluster_servers_stats_request | success, timeout | servers |\n| rethinkdb.cluster_client_connections | connections | connections |\n| rethinkdb.cluster_active_clients | active | clients |\n| rethinkdb.cluster_queries | queries | queries/s |\n| rethinkdb.cluster_documents | read, written | documents/s |\n\n### Per server\n\nThese metrics refer to the server (cluster member).\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| server_uuid | Server UUID. |\n| server_name | Server name. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| rethinkdb.server_stats_request_status | success, timeout | status |\n| rethinkdb.server_client_connections | connections | connections |\n| rethinkdb.server_active_clients | active | clients |\n| rethinkdb.server_queries | queries | queries/s |\n| rethinkdb.server_documents | read, written | documents/s |\n\n",
16093 + "integration_type": "collector",
16094 + "id": "go.d.plugin-rethinkdb-RethinkDB",
16095 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/rethinkdb/metadata.yaml",
16096 + "related_resources": ""
16097 + },
16098 {
16099 "meta": {
16100 "id": "collector-go.d.plugin-rspamd",
@@ -19173,43 +19211,6 @@
19211 "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/pandas/metadata.yaml",
19212 "related_resources": ""
19213 },
19176 - {
19177 - "meta": {
19178 - "plugin_name": "python.d.plugin",
19179 - "module_name": "rethinkdbs",
19180 - "monitored_instance": {
19181 - "name": "RethinkDB",
19182 - "link": "https://rethinkdb.com/",
19183 - "categories": [
19184 - "data-collection.database-servers"
19185 - ],
19186 - "icon_filename": "rethinkdb.png"
19187 - },
19188 - "related_resources": {
19189 - "integrations": {
19190 - "list": []
19191 - }
19192 - },
19193 - "info_provided_to_referring_integrations": {
19194 - "description": ""
19195 - },
19196 - "keywords": [
19197 - "rethinkdb",
19198 - "database",
19199 - "db"
19200 - ],
19201 - "most_popular": false
19202 - },
19203 - "overview": "# RethinkDB\n\nPlugin: python.d.plugin\nModule: rethinkdbs\n\n## Overview\n\nThis collector monitors metrics about RethinkDB clusters and database servers.\n\nIt uses the `rethinkdb` python module to connect to a RethinkDB server instance and gather 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\nWhen no configuration file is found, the collector tries to connect to 127.0.0.1:28015.\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",
19204 - "setup": "## Setup\n\n### Prerequisites\n\n#### Required python module\n\nThe collector requires the `rethinkdb` python module to be installed.\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/rethinkdbs.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/rethinkdbs.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| host | Hostname or ip of the RethinkDB server. | localhost | no |\n| port | Port to connect to the RethinkDB server. | 28015 | no |\n| user | The username to use to connect to the RethinkDB server. | admin | no |\n| password | The password to use to connect to the RethinkDB server. | | no |\n| timeout | Set a connect timeout to the RethinkDB server. | 2 | no |\n\n#### Examples\n\n##### Local RethinkDB server\n\nAn example of a configuration for a local RethinkDB server\n\n```yaml\nlocalhost:\n name: 'local'\n host: '127.0.0.1'\n port: 28015\n user: \"user\"\n password: \"pass\"\n\n```\n",
19205 - "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `rethinkdbs` 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 rethinkdbs debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `rethinkdbs` 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 rethinkdbs\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 rethinkdbs /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 rethinkdbs\n```\n\n",
19206 - "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19207 - "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 RethinkDB 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| rethinkdb.cluster_connected_servers | connected, missing | servers |\n| rethinkdb.cluster_clients_active | active | clients |\n| rethinkdb.cluster_queries | queries | queries/s |\n| rethinkdb.cluster_documents | reads, writes | documents/s |\n\n### Per database server\n\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| rethinkdb.client_connections | connections | connections |\n| rethinkdb.clients_active | active | clients |\n| rethinkdb.queries | queries | queries/s |\n| rethinkdb.documents | reads, writes | documents/s |\n\n",
19208 - "integration_type": "collector",
19209 - "id": "python.d.plugin-rethinkdbs-RethinkDB",
19210 - "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/rethinkdbs/metadata.yaml",
19211 - "related_resources": ""
19212 - },
19214 {
19215 "meta": {
19216 "plugin_name": "python.d.plugin",
src/collectors/COLLECTORS.md
+1 -1
@@ -267,7 +267,7 @@ If you don't see the app/service you'd like to monitor in this list:
267
268 - [Redis](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/redis/integrations/redis.md)
269
270 -- [RethinkDB](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/rethinkdbs/integrations/rethinkdb.md)
270 +- [RethinkDB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/rethinkdb/integrations/rethinkdb.md)
271
272 - [RiakKV](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/riakkv/integrations/riakkv.md)
273
src/go/plugin/go.d/modules/rethinkdb/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/rethinkdb.md
\ No newline at end of file
src/go/plugin/go.d/modules/rethinkdb/integrations/rethinkdb.md new
+255
@@ -0,0 +1,255 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/rethinkdb/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/rethinkdb/metadata.yaml"
4 +sidebar_label: "RethinkDB"
5 +learn_status: "Published"
6 +learn_rel_path: "Collecting Metrics/Databases"
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 +# RethinkDB
12 +
13 +
14 +<img src="https://netdata.cloud/img/rethinkdb.png" width="150"/>
15 +
16 +
17 +Plugin: go.d.plugin
18 +Module: rethinkdb
19 +
20 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21 +
22 +## Overview
23 +
24 +It collects cluster-wide metrics such as server status, client connections, active clients, query rate, and document read/write rates.
25 +For each server, it offers similar metrics.
26 +
27 +
28 +The data is gathered by querying the stats table in RethinkDB, which stores real-time statistics related to the cluster and its individual servers.
29 +
30 +
31 +This collector is supported on all platforms.
32 +
33 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
34 +
35 +
36 +### Default Behavior
37 +
38 +#### Auto-Detection
39 +
40 +If no configuration is given, collector will attempt to connect to RethinkDB instance on `127.0.0.1:28015` address.
41 +
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 RethinkDB instance
61 +
62 +These metrics refer to the entire monitored application.
63 +
64 +This scope has no labels.
65 +
66 +Metrics:
67 +
68 +| Metric | Dimensions | Unit |
69 +|:------|:----------|:----|
70 +| rethinkdb.cluster_servers_stats_request | success, timeout | servers |
71 +| rethinkdb.cluster_client_connections | connections | connections |
72 +| rethinkdb.cluster_active_clients | active | clients |
73 +| rethinkdb.cluster_queries | queries | queries/s |
74 +| rethinkdb.cluster_documents | read, written | documents/s |
75 +
76 +### Per server
77 +
78 +These metrics refer to the server (cluster member).
79 +
80 +Labels:
81 +
82 +| Label | Description |
83 +|:-----------|:----------------|
84 +| server_uuid | Server UUID. |
85 +| server_name | Server name. |
86 +
87 +Metrics:
88 +
89 +| Metric | Dimensions | Unit |
90 +|:------|:----------|:----|
91 +| rethinkdb.server_stats_request_status | success, timeout | status |
92 +| rethinkdb.server_client_connections | connections | connections |
93 +| rethinkdb.server_active_clients | active | clients |
94 +| rethinkdb.server_queries | queries | queries/s |
95 +| rethinkdb.server_documents | read, written | documents/s |
96 +
97 +
98 +
99 +## Alerts
100 +
101 +There are no alerts configured by default for this integration.
102 +
103 +
104 +## Setup
105 +
106 +### Prerequisites
107 +
108 +No action required.
109 +
110 +### Configuration
111 +
112 +#### File
113 +
114 +The configuration file name for this integration is `go.d/rethinkdb.conf`.
115 +
116 +
117 +You can edit the configuration file using the `edit-config` script from the
118 +Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
119 +
120 +```bash
121 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
122 +sudo ./edit-config go.d/rethinkdb.conf
123 +```
124 +#### Options
125 +
126 +The following options can be defined globally: update_every, autodetection_retry.
127 +
128 +
129 +<details open><summary>Config options</summary>
130 +
131 +| Name | Description | Default | Required |
132 +|:----|:-----------|:-------|:--------:|
133 +| update_every | Data collection frequency. | 1 | no |
134 +| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
135 +| address | The IP address and port where the RethinkDB service listens for connections. | 127.0.0.1:28015 | yes |
136 +| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no |
137 +| username | Username used for authentication. | | no |
138 +| password | Password used for authentication. | | no |
139 +
140 +</details>
141 +
142 +#### Examples
143 +
144 +##### Basic
145 +
146 +A basic example configuration.
147 +
148 +<details open><summary>Config</summary>
149 +
150 +```yaml
151 +jobs:
152 + - name: local
153 + address: 127.0.0.1:28015
154 +
155 +```
156 +</details>
157 +
158 +##### With authentication
159 +
160 +An example configuration with authentication.
161 +
162 +<details open><summary>Config</summary>
163 +
164 +```yaml
165 +jobs:
166 + - name: local
167 + address: 127.0.0.1:28015
168 + username: name
169 + password: pass
170 +
171 +```
172 +</details>
173 +
174 +##### Multi-instance
175 +
176 +> **Note**: When you define multiple jobs, their names must be unique.
177 +
178 +Collecting metrics from local and remote instances.
179 +
180 +
181 +<details open><summary>Config</summary>
182 +
183 +```yaml
184 +jobs:
185 + - name: local
186 + address: 127.0.0.1:28015
187 +
188 + - name: remote
189 + address: 203.0.113.0:28015
190 +
191 +```
192 +</details>
193 +
194 +
195 +
196 +## Troubleshooting
197 +
198 +### Debug Mode
199 +
200 +To troubleshoot issues with the `rethinkdb` collector, run the `go.d.plugin` with the debug option enabled. The output
201 +should give you clues as to why the collector isn't working.
202 +
203 +- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
204 + your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
205 +
206 + ```bash
207 + cd /usr/libexec/netdata/plugins.d/
208 + ```
209 +
210 +- Switch to the `netdata` user.
211 +
212 + ```bash
213 + sudo -u netdata -s
214 + ```
215 +
216 +- Run the `go.d.plugin` to debug the collector:
217 +
218 + ```bash
219 + ./go.d.plugin -d -m rethinkdb
220 + ```
221 +
222 +### Getting Logs
223 +
224 +If you're encountering problems with the `rethinkdb` collector, follow these steps to retrieve logs and identify potential issues:
225 +
226 +- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
227 +- **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.
228 +
229 +#### System with systemd
230 +
231 +Use the following command to view logs generated since the last Netdata service restart:
232 +
233 +```bash
234 +journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep rethinkdb
235 +```
236 +
237 +#### System without systemd
238 +
239 +Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
240 +
241 +```bash
242 +grep rethinkdb /var/log/netdata/collector.log
243 +```
244 +
245 +**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
246 +
247 +#### Docker Container
248 +
249 +If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
250 +
251 +```bash
252 +docker logs netdata 2>&1 | grep rethinkdb
253 +```
254 +
255 +