@cryptotaxi247 / netdata-1 / commits / a76d52b9c

Regenerate integrations.js (#18558)

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

Netdata bot committed Sep 14, 2024 at 18:32 UTC a76d52b9c012d80e0760ba5f41786e4f41a6cc24

6 files changed +350 -3

integrations/integrations.js

+42 -1

@@ -5463,6 +5463,47 @@ export const integrations = [

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

5464 "related_resources": ""

5465 },

5466 + {

5467 + "meta": {

5468 + "id": "collector-go.d.plugin-nginxunit",

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

5470 + "module_name": "nginxunit",

5471 + "monitored_instance": {

5472 + "name": "NGINX Unit",

5473 + "link": "https://unit.nginx.org/",

5474 + "categories": [

5475 + "data-collection.web-servers-and-web-proxies"

5476 + ],

5477 + "icon_filename": "nginx.svg"

5478 + },

5479 + "related_resources": {

5480 + "integrations": {

5481 + "list": []

5482 + }

5483 + },

5484 + "alternative_monitored_instances": [],

5485 + "info_provided_to_referring_integrations": {

5486 + "description": ""

5487 + },

5488 + "keywords": [

5489 + "nginx",

5490 + "unit",

5491 + "web",

5492 + "appserver",

5493 + "http"

5494 + ],

5495 + "most_popular": false

5496 + },

5497 + "overview": "# NGINX Unit\n\nPlugin: go.d.plugin\nModule: nginxunit\n\n## Overview\n\nThis collector monitors the activity and performance of NGINX Unit servers, and collects metrics such as the number of connections, their status, and client requests.\n\n\nIt sends HTTP requests to the NGINX Unit [Status API](https://unit.nginx.org/statusapi/).\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\nThe collector can automatically detect NGINX Unit instances running on:\n\n- localhost that are listening on port 8000\n- within Docker containers\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",

5498 + "setup": "## Setup\n\n### Prerequisites\n\n#### Enable HTTP Control API\n\nSee [Control API](https://unit.nginx.org/controlapi/#configuration-api) documentation.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/nginxunit.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/nginxunit.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| url | The URL of the NGINX Unit HTTP Control API. | http://127.0.0.1:8000 | yes |\n| timeout | HTTP request timeout. | 1 | no |\n| username | Username for basic HTTP authentication. | | no |\n| password | Password for basic HTTP authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTP authentication. | | no |\n| proxy_password | Password for proxy basic HTTP authentication. | | no |\n| method | HTTP request method. | GET | no |\n| body | HTTP request body. | | no |\n| headers | HTTP request headers. | | no |\n| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |\n| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |\n| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |\n| tls_cert | Client TLS certificate. | | no |\n| tls_key | Client TLS key. | | no |\n\n{% /details %}\n#### Examples\n\n##### Basic\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8000\n\n```\n##### HTTP authentication\n\nBasic HTTP authentication.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1::8000\n username: username\n password: password\n\n```\n{% /details %}\n##### HTTPS with self-signed certificate\n\nNGINX Unit with enabled HTTPS and self-signed certificate.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8000\n tls_skip_verify: yes\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 url: http://127.0.0.1:8000\n\n - name: remote\n url: http://192.0.2.1:8000\n\n```\n{% /details %}\n",

5499 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `nginxunit` 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 nginxunit\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `nginxunit` 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 nginxunit\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 nginxunit /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 nginxunit\n```\n\n",

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

5501 + "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 NGINX Unit 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| nginxunit.requests_rate | requests | requests/s |\n| nginxunit.connections_rate | accepted, closed | connections/s |\n| nginxunit.connections_current | active, idle | connections |\n\n",

5502 + "integration_type": "collector",

5503 + "id": "go.d.plugin-nginxunit-NGINX_Unit",

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

5505 + "related_resources": ""

5506 + },

5507 {

5508 "meta": {

5509 "id": "collector-go.d.plugin-nginxvts",

@@ -16928,7 +16969,7 @@ export const integrations = [

16969 ],

16970 "most_popular": false

16971 },

16931 - "overview": "# Typesense\n\nPlugin: go.d.plugin\nModule: typesense\n\n## Overview\n\nThis collector monitors the overall health status and performance of your Typesense servers.\nIt gathers detailed metrics, including the total number of requests processed, the breakdown of different request types, and the average latency experienced by each request.\n\n\nIt gathers metrics by periodically issuing HTTP GET requests to the Typesense server:\n\n- [/health](https://typesense.org/docs/27.0/api/cluster-operations.html#health) endpoint to check server health.\n- [/stats.json](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats) endpoint to collect data on requests and latency.\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\nThe collector can automatically detect Typesense instances running on:\n\n- localhost that are listening on port 8108\n- within Docker containers\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",

16972 + "overview": "# Typesense\n\nPlugin: go.d.plugin\nModule: typesense\n\n## Overview\n\nThis collector monitors the overall health status and performance of your Typesense servers.\nIt gathers detailed metrics, including the total number of requests processed, the breakdown of different request types, and the average latency experienced by each request.\n\n\nIt gathers metrics by periodically issuing HTTP GET requests to the Typesense server:\n\n- [/health](https://typesense.org/docs/27.0/api/cluster-operations.html#health) endpoint to check server health.\n- [/stats.json](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats) endpoint to collect data on requests and latency.\n\n\nThis collector is supported on all platforms.\n\nThis collector only supports collecting metrics from a single instance of this integration.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector can automatically detect Typesense instances running on:\n\n- localhost that are listening on port 8108\n- within Docker containers\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",

16973 "setup": "## Setup\n\n### Prerequisites\n\n#### API Key Configuration\n\nWhile optional, configuring an [API key](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys) is highly recommended to enable the collector to gather [stats metrics](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats), including request counts and latency.\nWithout an API key, the collector will only collect health status information.\n\n> If you're running Typesense with the API key provided as a command-line parameter (e.g., `--api-key=XYZ`), Netdata can automatically detect and use this key for queries.\n> In this case, no additional configuration is required.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/typesense.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/typesense.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| url | Server URL. | http://127.0.0.1:8108 | yes |\n| timeout | HTTP request timeout. | 1 | no |\n| api_key | The Typesense [API Key](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys) (`X-TYPESENSE-API-KEY`). | | no |\n| username | Username for basic HTTP authentication. | | no |\n| password | Password for basic HTTP authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTP authentication. | | no |\n| proxy_password | Password for proxy basic HTTP authentication. | | no |\n| method | HTTP request method. | GET | no |\n| body | HTTP request body. | | no |\n| headers | HTTP request headers. | | no |\n| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |\n| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |\n| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |\n| tls_cert | Client TLS certificate. | | no |\n| tls_key | Client TLS key. | | no |\n\n{% /details %}\n#### Examples\n\n##### Basic\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8108\n api_key: XYZ\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{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8108\n api_key: XYZ\n\n - name: remote\n url: http://192.0.2.1:8108\n api_key: XYZ\n\n```\n{% /details %}\n",

16974 "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `typesense` 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 typesense\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `typesense` 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 typesense\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 typesense /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 typesense\n```\n\n",

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

integrations/integrations.json

+42 -1

@@ -5461,6 +5461,47 @@

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

5462 "related_resources": ""

5463 },

5464 + {

5465 + "meta": {

5466 + "id": "collector-go.d.plugin-nginxunit",

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

5468 + "module_name": "nginxunit",

5469 + "monitored_instance": {

5470 + "name": "NGINX Unit",

5471 + "link": "https://unit.nginx.org/",

5472 + "categories": [

5473 + "data-collection.web-servers-and-web-proxies"

5474 + ],

5475 + "icon_filename": "nginx.svg"

5476 + },

5477 + "related_resources": {

5478 + "integrations": {

5479 + "list": []

5480 + }

5481 + },

5482 + "alternative_monitored_instances": [],

5483 + "info_provided_to_referring_integrations": {

5484 + "description": ""

5485 + },

5486 + "keywords": [

5487 + "nginx",

5488 + "unit",

5489 + "web",

5490 + "appserver",

5491 + "http"

5492 + ],

5493 + "most_popular": false

5494 + },

5495 + "overview": "# NGINX Unit\n\nPlugin: go.d.plugin\nModule: nginxunit\n\n## Overview\n\nThis collector monitors the activity and performance of NGINX Unit servers, and collects metrics such as the number of connections, their status, and client requests.\n\n\nIt sends HTTP requests to the NGINX Unit [Status API](https://unit.nginx.org/statusapi/).\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\nThe collector can automatically detect NGINX Unit instances running on:\n\n- localhost that are listening on port 8000\n- within Docker containers\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",

5496 + "setup": "## Setup\n\n### Prerequisites\n\n#### Enable HTTP Control API\n\nSee [Control API](https://unit.nginx.org/controlapi/#configuration-api) documentation.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/nginxunit.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/nginxunit.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| url | The URL of the NGINX Unit HTTP Control API. | http://127.0.0.1:8000 | yes |\n| timeout | HTTP request timeout. | 1 | no |\n| username | Username for basic HTTP authentication. | | no |\n| password | Password for basic HTTP authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTP authentication. | | no |\n| proxy_password | Password for proxy basic HTTP authentication. | | no |\n| method | HTTP request method. | GET | no |\n| body | HTTP request body. | | no |\n| headers | HTTP request headers. | | no |\n| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |\n| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |\n| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |\n| tls_cert | Client TLS certificate. | | no |\n| tls_key | Client TLS key. | | no |\n\n#### Examples\n\n##### Basic\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8000\n\n```\n##### HTTP authentication\n\nBasic HTTP authentication.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1::8000\n username: username\n password: password\n\n```\n##### HTTPS with self-signed certificate\n\nNGINX Unit with enabled HTTPS and self-signed certificate.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8000\n tls_skip_verify: yes\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 url: http://127.0.0.1:8000\n\n - name: remote\n url: http://192.0.2.1:8000\n\n```\n",

5497 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `nginxunit` 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 nginxunit\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `nginxunit` 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 nginxunit\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 nginxunit /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 nginxunit\n```\n\n",

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

5499 + "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 NGINX Unit 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| nginxunit.requests_rate | requests | requests/s |\n| nginxunit.connections_rate | accepted, closed | connections/s |\n| nginxunit.connections_current | active, idle | connections |\n\n",

5500 + "integration_type": "collector",

5501 + "id": "go.d.plugin-nginxunit-NGINX_Unit",

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

5503 + "related_resources": ""

5504 + },

5505 {

5506 "meta": {

5507 "id": "collector-go.d.plugin-nginxvts",

@@ -16926,7 +16967,7 @@

16967 ],

16968 "most_popular": false

16969 },

16929 - "overview": "# Typesense\n\nPlugin: go.d.plugin\nModule: typesense\n\n## Overview\n\nThis collector monitors the overall health status and performance of your Typesense servers.\nIt gathers detailed metrics, including the total number of requests processed, the breakdown of different request types, and the average latency experienced by each request.\n\n\nIt gathers metrics by periodically issuing HTTP GET requests to the Typesense server:\n\n- [/health](https://typesense.org/docs/27.0/api/cluster-operations.html#health) endpoint to check server health.\n- [/stats.json](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats) endpoint to collect data on requests and latency.\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\nThe collector can automatically detect Typesense instances running on:\n\n- localhost that are listening on port 8108\n- within Docker containers\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",

16970 + "overview": "# Typesense\n\nPlugin: go.d.plugin\nModule: typesense\n\n## Overview\n\nThis collector monitors the overall health status and performance of your Typesense servers.\nIt gathers detailed metrics, including the total number of requests processed, the breakdown of different request types, and the average latency experienced by each request.\n\n\nIt gathers metrics by periodically issuing HTTP GET requests to the Typesense server:\n\n- [/health](https://typesense.org/docs/27.0/api/cluster-operations.html#health) endpoint to check server health.\n- [/stats.json](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats) endpoint to collect data on requests and latency.\n\n\nThis collector is supported on all platforms.\n\nThis collector only supports collecting metrics from a single instance of this integration.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThe collector can automatically detect Typesense instances running on:\n\n- localhost that are listening on port 8108\n- within Docker containers\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",

16971 "setup": "## Setup\n\n### Prerequisites\n\n#### API Key Configuration\n\nWhile optional, configuring an [API key](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys) is highly recommended to enable the collector to gather [stats metrics](https://typesense.org/docs/27.0/api/cluster-operations.html#api-stats), including request counts and latency.\nWithout an API key, the collector will only collect health status information.\n\n> If you're running Typesense with the API key provided as a command-line parameter (e.g., `--api-key=XYZ`), Netdata can automatically detect and use this key for queries.\n> In this case, no additional configuration is required.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/typesense.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/typesense.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| url | Server URL. | http://127.0.0.1:8108 | yes |\n| timeout | HTTP request timeout. | 1 | no |\n| api_key | The Typesense [API Key](https://typesense.org/docs/0.20.0/api/api-keys.html#api-keys) (`X-TYPESENSE-API-KEY`). | | no |\n| username | Username for basic HTTP authentication. | | no |\n| password | Password for basic HTTP authentication. | | no |\n| proxy_url | Proxy URL. | | no |\n| proxy_username | Username for proxy basic HTTP authentication. | | no |\n| proxy_password | Password for proxy basic HTTP authentication. | | no |\n| method | HTTP request method. | GET | no |\n| body | HTTP request body. | | no |\n| headers | HTTP request headers. | | no |\n| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |\n| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |\n| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |\n| tls_cert | Client TLS certificate. | | no |\n| tls_key | Client TLS key. | | no |\n\n#### Examples\n\n##### Basic\n\nA basic example configuration.\n\n```yaml\njobs:\n - name: local\n url: http://127.0.0.1:8108\n api_key: XYZ\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 url: http://127.0.0.1:8108\n api_key: XYZ\n\n - name: remote\n url: http://192.0.2.1:8108\n api_key: XYZ\n\n```\n",

16972 "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `typesense` 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 typesense\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `typesense` 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 typesense\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 typesense /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 typesense\n```\n\n",

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

src/collectors/COLLECTORS.md

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

1133

1134 - [NGINX Plus](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/nginxplus/integrations/nginx_plus.md)

1135

1136 +- [NGINX Unit](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/nginxunit/integrations/nginx_unit.md)

1137 +

1138 - [NGINX VTS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/nginxvts/integrations/nginx_vts.md)

1139

1140 - [NGINX](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/nginx/integrations/nginx.md)

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

@@ -0,0 +1 @@

1 +integrations/nginx_unit.md

\ No newline at end of file

src/go/plugin/go.d/modules/nginxunit/integrations/nginx_unit.md new

+262

@@ -0,0 +1,262 @@

1 +<!--startmeta

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

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

4 +sidebar_label: "NGINX Unit"

5 +learn_status: "Published"

6 +learn_rel_path: "Collecting Metrics/Web Servers and Web Proxies"

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 +# NGINX Unit

12 +

13 +

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

15 +

16 +

17 +Plugin: go.d.plugin

18 +Module: nginxunit

19 +

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

21 +

22 +## Overview

23 +

24 +This collector monitors the activity and performance of NGINX Unit servers, and collects metrics such as the number of connections, their status, and client requests.

25 +

26 +

27 +It sends HTTP requests to the NGINX Unit [Status API](https://unit.nginx.org/statusapi/).

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 +The collector can automatically detect NGINX Unit instances running on:

40 +

41 +- localhost that are listening on port 8000

42 +- within Docker containers

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 NGINX Unit 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 +| nginxunit.requests_rate | requests | requests/s |

73 +| nginxunit.connections_rate | accepted, closed | connections/s |

74 +| nginxunit.connections_current | active, idle | connections |

75 +

76 +

77 +

78 +## Alerts

79 +

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

81 +

82 +

83 +## Setup

84 +

85 +### Prerequisites

86 +

87 +#### Enable HTTP Control API

88 +

89 +See [Control API](https://unit.nginx.org/controlapi/#configuration-api) documentation.

90 +

91 +

92 +

93 +### Configuration

94 +

95 +#### File

96 +

97 +The configuration file name for this integration is `go.d/nginxunit.conf`.

98 +

99 +

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

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

102 +

103 +```bash

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

105 +sudo ./edit-config go.d/nginxunit.conf

106 +```

107 +#### Options

108 +

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

110 +

111 +

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

113 +

115 +|:----|:-----------|:-------|:--------:|

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

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

118 +| url | The URL of the NGINX Unit HTTP Control API. | http://127.0.0.1:8000 | yes |

119 +| timeout | HTTP request timeout. | 1 | no |

120 +| username | Username for basic HTTP authentication. | | no |

121 +| password | Password for basic HTTP authentication. | | no |

122 +| proxy_url | Proxy URL. | | no |

123 +| proxy_username | Username for proxy basic HTTP authentication. | | no |

124 +| proxy_password | Password for proxy basic HTTP authentication. | | no |

125 +| method | HTTP request method. | GET | no |

126 +| body | HTTP request body. | | no |

127 +| headers | HTTP request headers. | | no |

128 +| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |

129 +| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |

130 +| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |

131 +| tls_cert | Client TLS certificate. | | no |

132 +| tls_key | Client TLS key. | | no |

133 +

134 +</details>

135 +

136 +#### Examples

137 +

138 +##### Basic

139 +

140 +A basic example configuration.

141 +

142 +```yaml

143 +jobs:

144 + - name: local

145 + url: http://127.0.0.1:8000

146 +

147 +```

148 +##### HTTP authentication

149 +

150 +Basic HTTP authentication.

151 +

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

153 +

154 +```yaml

155 +jobs:

156 + - name: local

157 + url: http://127.0.0.1::8000

158 + username: username

159 + password: password

160 +

161 +```

162 +</details>

163 +

164 +##### HTTPS with self-signed certificate

165 +

166 +NGINX Unit with enabled HTTPS and self-signed certificate.

167 +

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

169 +

170 +```yaml

171 +jobs:

172 + - name: local

173 + url: http://127.0.0.1:8000

174 + tls_skip_verify: yes

175 +

176 +```

177 +</details>

178 +

179 +##### Multi-instance

180 +

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

182 +

183 +Collecting metrics from local and remote instances.

184 +

185 +

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

187 +

188 +```yaml

189 +jobs:

190 + - name: local

191 + url: http://127.0.0.1:8000

192 +

193 + - name: remote

194 + url: http://192.0.2.1:8000

195 +

196 +```

197 +</details>

198 +

199 +

200 +

201 +## Troubleshooting

202 +

203 +### Debug Mode

204 +

205 +**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

206 +

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

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

209 +

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

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

212 +

213 + ```bash

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

215 + ```

216 +

217 +- Switch to the `netdata` user.

218 +

219 + ```bash

220 + sudo -u netdata -s

221 + ```

222 +

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

224 +

225 + ```bash

226 + ./go.d.plugin -d -m nginxunit

227 + ```

228 +

229 +### Getting Logs

230 +

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

232 +

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

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

235 +

236 +#### System with systemd

237 +

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

239 +

240 +```bash

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

242 +```

243 +

244 +#### System without systemd

245 +

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

247 +

248 +```bash

249 +grep nginxunit /var/log/netdata/collector.log

250 +```

251 +

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

253 +

254 +#### Docker Container

255 +

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

257 +

258 +```bash

259 +docker logs netdata 2>&1 | grep nginxunit

260 +```

261 +

262 +

src/go/plugin/go.d/modules/typesense/integrations/typesense.md

+1 -1

@@ -33,7 +33,7 @@ It gathers metrics by periodically issuing HTTP GET requests to the Typesense se

34 This collector is supported on all platforms.

36 -This collector supports collecting metrics from multiple instances of this integration, including remote instances.

36 +This collector only supports collecting metrics from a single instance of this integration.

39 ### Default Behavior