Regenerate integrations.js (#18328)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Aug 13, 2024 at 13:22 UTC
a781b36a1f617d6d882c4f1891224bb8bc065c73
5 files changed
+324
-75
integrations/integrations.js
+38
-37
@@ -16823,6 +16823,44 @@ export const integrations = [
16823
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/upsd/metadata.yaml",
16824
"related_resources": ""
16825
},
16826
+ {
16827
+ "meta": {
16828
+ "id": "collector-go.d.plugin-uwsgi",
16829
+ "plugin_name": "go.d.plugin",
16830
+ "module_name": "uwsgi",
16831
+ "monitored_instance": {
16832
+ "name": "uWSGI",
16833
+ "link": "https://uwsgi-docs.readthedocs.io/en/latest/",
16834
+ "categories": [
16835
+ "data-collection.web-servers-and-web-proxies"
16836
+ ],
16837
+ "icon_filename": "uwsgi.svg"
16838
+ },
16839
+ "related_resources": {
16840
+ "integrations": {
16841
+ "list": []
16842
+ }
16843
+ },
16844
+ "info_provided_to_referring_integrations": {
16845
+ "description": ""
16846
+ },
16847
+ "keywords": [
16848
+ "application server",
16849
+ "python",
16850
+ "web applications"
16851
+ ],
16852
+ "most_popular": false
16853
+ },
16854
+ "overview": "# uWSGI\n\nPlugin: go.d.plugin\nModule: uwsgi\n\n## Overview\n\nMonitors UWSGI worker health and performance by collecting metrics like requests, transmitted data, exceptions, and harakiris.\n\n\nIt fetches [Stats Server](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html) statistics over TCP.\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nAutomatically discovers and collects UWSGI statistics from the following default locations:\n\n- localhost:1717\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",
16855
+ "setup": "## Setup\n\n### Prerequisites\n\n#### Enable the uWSGI Stats Server\n\nSee [Stats Server](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html) for details.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/uwsgi.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/uwsgi.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 UWSGI [Stats Server](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html) listens for connections. | 127.0.0.1:1717 | yes |\n| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no |\n\n{% /details %}\n#### Examples\n\n##### Basic\n\nA basic example configuration.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n address: 127.0.0.1:1717\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:1717\n\n - name: remote\n address: 203.0.113.0:1717\n\n```\n{% /details %}\n",
16856
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `uwsgi` 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 uwsgi\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `uwsgi` 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 uwsgi\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 uwsgi /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 uwsgi\n```\n\n",
16857
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
16858
+ "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 uWSGI 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| uwsgi.transmitted_data | tx | bytes/s |\n| uwsgi.requests | requests | requests/s |\n| uwsgi.harakiris | harakiris | harakiris/s |\n| uwsgi.respawns | respawns | respawns/s |\n\n### Per worker\n\nThese metrics refer to the Worker process.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| worker_id | Worker ID. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| uwsgi.worker_transmitted_data | tx | bytes/s |\n| uwsgi.worker_requests | requests | requests/s |\n| uwsgi.worker_delta_requests | delta_requests | requests/s |\n| uwsgi.worker_average_request_time | avg | milliseconds |\n| uwsgi.worker_harakiris | harakiris | harakiris/s |\n| uwsgi.worker_exceptions | exceptions | exceptions/s |\n| uwsgi.worker_status | idle, busy, cheap, pause, sig | status |\n| uwsgi.worker_request_handling_status | accepting, not_accepting | status |\n| uwsgi.worker_respawns | respawns | respawns/s |\n| uwsgi.worker_memory_rss | rss | bytes |\n| uwsgi.worker_memory_vsz | vsz | bytes |\n\n",
16859
+ "integration_type": "collector",
16860
+ "id": "go.d.plugin-uwsgi-uWSGI",
16861
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/uwsgi/metadata.yaml",
16862
+ "related_resources": ""
16863
+ },
16864
{
16865
"meta": {
16866
"id": "collector-go.d.plugin-vcsa",
@@ -19401,43 +19439,6 @@ export const integrations = [
19439
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/tor/metadata.yaml",
19440
"related_resources": ""
19441
},
19404
- {
19405
- "meta": {
19406
- "plugin_name": "python.d.plugin",
19407
- "module_name": "uwsgi",
19408
- "monitored_instance": {
19409
- "name": "uWSGI",
19410
- "link": "https://github.com/unbit/uwsgi/tree/2.0.21",
19411
- "categories": [
19412
- "data-collection.web-servers-and-web-proxies"
19413
- ],
19414
- "icon_filename": "uwsgi.svg"
19415
- },
19416
- "related_resources": {
19417
- "integrations": {
19418
- "list": []
19419
- }
19420
- },
19421
- "info_provided_to_referring_integrations": {
19422
- "description": ""
19423
- },
19424
- "keywords": [
19425
- "application server",
19426
- "python",
19427
- "web applications"
19428
- ],
19429
- "most_popular": false
19430
- },
19431
- "overview": "# uWSGI\n\nPlugin: python.d.plugin\nModule: uwsgi\n\n## Overview\n\nThis collector monitors uWSGI metrics about requests, workers, memory and more.\n\nIt collects every metric exposed from the stats server of uWSGI, either from the `stats.socket` or from the web server's TCP/IP socket.\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\nThis collector will auto-detect uWSGI instances deployed on the local host, running on port 1717, or exposing stats on socket `tmp/stats.socket`.\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",
19432
- "setup": "## Setup\n\n### Prerequisites\n\n#### Enable the uWSGI Stats server\n\nMake sure that you uWSGI exposes it's metrics via a Stats server.\n\nSource: https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/uwsgi.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/uwsgi.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 | The JOB's name as it will appear at the dashboard (by default is the job_name) | job_name | no |\n| socket | The 'path/to/uwsgistats.sock' | no | no |\n| host | The host to connect to | no | no |\n| port | The port to connect to | no | no |\n\n{% /details %}\n#### Examples\n\n##### Basic (default out-of-the-box)\n\nA basic example configuration, one job will run at a time. Autodetect mechanism uses it by default. As all JOBs have the same name, only one can run at a time.\n\n{% details open=true summary=\"Config\" %}\n```yaml\nsocket:\n name : 'local'\n socket : '/tmp/stats.socket'\n\nlocalhost:\n name : 'local'\n host : 'localhost'\n port : 1717\n\nlocalipv4:\n name : 'local'\n host : '127.0.0.1'\n port : 1717\n\nlocalipv6:\n name : 'local'\n host : '::1'\n port : 1717\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\nlocal:\n name : 'local'\n host : 'localhost'\n port : 1717\n\nremote:\n name : 'remote'\n host : '192.0.2.1'\n port : 1717\n\n```\n{% /details %}\n",
19433
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `uwsgi` 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 uwsgi debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `uwsgi` 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 uwsgi\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 uwsgi /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 uwsgi\n```\n\n",
19434
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19435
- "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 uWSGI 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| uwsgi.requests | a dimension per worker | requests/s |\n| uwsgi.tx | a dimension per worker | KiB/s |\n| uwsgi.avg_rt | a dimension per worker | milliseconds |\n| uwsgi.memory_rss | a dimension per worker | MiB |\n| uwsgi.memory_vsz | a dimension per worker | MiB |\n| uwsgi.exceptions | exceptions | exceptions |\n| uwsgi.harakiris | harakiris | harakiris |\n| uwsgi.respawns | respawns | respawns |\n\n",
19436
- "integration_type": "collector",
19437
- "id": "python.d.plugin-uwsgi-uWSGI",
19438
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/uwsgi/metadata.yaml",
19439
- "related_resources": ""
19440
- },
19442
{
19443
"meta": {
19444
"plugin_name": "python.d.plugin",
integrations/integrations.json
+38
-37
@@ -16821,6 +16821,44 @@
16821
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/upsd/metadata.yaml",
16822
"related_resources": ""
16823
},
16824
+ {
16825
+ "meta": {
16826
+ "id": "collector-go.d.plugin-uwsgi",
16827
+ "plugin_name": "go.d.plugin",
16828
+ "module_name": "uwsgi",
16829
+ "monitored_instance": {
16830
+ "name": "uWSGI",
16831
+ "link": "https://uwsgi-docs.readthedocs.io/en/latest/",
16832
+ "categories": [
16833
+ "data-collection.web-servers-and-web-proxies"
16834
+ ],
16835
+ "icon_filename": "uwsgi.svg"
16836
+ },
16837
+ "related_resources": {
16838
+ "integrations": {
16839
+ "list": []
16840
+ }
16841
+ },
16842
+ "info_provided_to_referring_integrations": {
16843
+ "description": ""
16844
+ },
16845
+ "keywords": [
16846
+ "application server",
16847
+ "python",
16848
+ "web applications"
16849
+ ],
16850
+ "most_popular": false
16851
+ },
16852
+ "overview": "# uWSGI\n\nPlugin: go.d.plugin\nModule: uwsgi\n\n## Overview\n\nMonitors UWSGI worker health and performance by collecting metrics like requests, transmitted data, exceptions, and harakiris.\n\n\nIt fetches [Stats Server](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html) statistics over TCP.\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nAutomatically discovers and collects UWSGI statistics from the following default locations:\n\n- localhost:1717\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",
16853
+ "setup": "## Setup\n\n### Prerequisites\n\n#### Enable the uWSGI Stats Server\n\nSee [Stats Server](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html) for details.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/uwsgi.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/uwsgi.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 UWSGI [Stats Server](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html) listens for connections. | 127.0.0.1:1717 | yes |\n| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | 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:1717\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:1717\n\n - name: remote\n address: 203.0.113.0:1717\n\n```\n",
16854
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `uwsgi` 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 uwsgi\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `uwsgi` 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 uwsgi\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 uwsgi /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 uwsgi\n```\n\n",
16855
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
16856
+ "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 uWSGI 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| uwsgi.transmitted_data | tx | bytes/s |\n| uwsgi.requests | requests | requests/s |\n| uwsgi.harakiris | harakiris | harakiris/s |\n| uwsgi.respawns | respawns | respawns/s |\n\n### Per worker\n\nThese metrics refer to the Worker process.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| worker_id | Worker ID. |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| uwsgi.worker_transmitted_data | tx | bytes/s |\n| uwsgi.worker_requests | requests | requests/s |\n| uwsgi.worker_delta_requests | delta_requests | requests/s |\n| uwsgi.worker_average_request_time | avg | milliseconds |\n| uwsgi.worker_harakiris | harakiris | harakiris/s |\n| uwsgi.worker_exceptions | exceptions | exceptions/s |\n| uwsgi.worker_status | idle, busy, cheap, pause, sig | status |\n| uwsgi.worker_request_handling_status | accepting, not_accepting | status |\n| uwsgi.worker_respawns | respawns | respawns/s |\n| uwsgi.worker_memory_rss | rss | bytes |\n| uwsgi.worker_memory_vsz | vsz | bytes |\n\n",
16857
+ "integration_type": "collector",
16858
+ "id": "go.d.plugin-uwsgi-uWSGI",
16859
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/uwsgi/metadata.yaml",
16860
+ "related_resources": ""
16861
+ },
16862
{
16863
"meta": {
16864
"id": "collector-go.d.plugin-vcsa",
@@ -19399,43 +19437,6 @@
19437
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/tor/metadata.yaml",
19438
"related_resources": ""
19439
},
19402
- {
19403
- "meta": {
19404
- "plugin_name": "python.d.plugin",
19405
- "module_name": "uwsgi",
19406
- "monitored_instance": {
19407
- "name": "uWSGI",
19408
- "link": "https://github.com/unbit/uwsgi/tree/2.0.21",
19409
- "categories": [
19410
- "data-collection.web-servers-and-web-proxies"
19411
- ],
19412
- "icon_filename": "uwsgi.svg"
19413
- },
19414
- "related_resources": {
19415
- "integrations": {
19416
- "list": []
19417
- }
19418
- },
19419
- "info_provided_to_referring_integrations": {
19420
- "description": ""
19421
- },
19422
- "keywords": [
19423
- "application server",
19424
- "python",
19425
- "web applications"
19426
- ],
19427
- "most_popular": false
19428
- },
19429
- "overview": "# uWSGI\n\nPlugin: python.d.plugin\nModule: uwsgi\n\n## Overview\n\nThis collector monitors uWSGI metrics about requests, workers, memory and more.\n\nIt collects every metric exposed from the stats server of uWSGI, either from the `stats.socket` or from the web server's TCP/IP socket.\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\nThis collector will auto-detect uWSGI instances deployed on the local host, running on port 1717, or exposing stats on socket `tmp/stats.socket`.\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",
19430
- "setup": "## Setup\n\n### Prerequisites\n\n#### Enable the uWSGI Stats server\n\nMake sure that you uWSGI exposes it's metrics via a Stats server.\n\nSource: https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/uwsgi.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/uwsgi.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 | The JOB's name as it will appear at the dashboard (by default is the job_name) | job_name | no |\n| socket | The 'path/to/uwsgistats.sock' | no | no |\n| host | The host to connect to | no | no |\n| port | The port to connect to | no | no |\n\n#### Examples\n\n##### Basic (default out-of-the-box)\n\nA basic example configuration, one job will run at a time. Autodetect mechanism uses it by default. As all JOBs have the same name, only one can run at a time.\n\n```yaml\nsocket:\n name : 'local'\n socket : '/tmp/stats.socket'\n\nlocalhost:\n name : 'local'\n host : 'localhost'\n port : 1717\n\nlocalipv4:\n name : 'local'\n host : '127.0.0.1'\n port : 1717\n\nlocalipv6:\n name : 'local'\n host : '::1'\n port : 1717\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\nlocal:\n name : 'local'\n host : 'localhost'\n port : 1717\n\nremote:\n name : 'remote'\n host : '192.0.2.1'\n port : 1717\n\n```\n",
19431
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `uwsgi` 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 uwsgi debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `uwsgi` 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 uwsgi\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 uwsgi /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 uwsgi\n```\n\n",
19432
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19433
- "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 uWSGI 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| uwsgi.requests | a dimension per worker | requests/s |\n| uwsgi.tx | a dimension per worker | KiB/s |\n| uwsgi.avg_rt | a dimension per worker | milliseconds |\n| uwsgi.memory_rss | a dimension per worker | MiB |\n| uwsgi.memory_vsz | a dimension per worker | MiB |\n| uwsgi.exceptions | exceptions | exceptions |\n| uwsgi.harakiris | harakiris | harakiris |\n| uwsgi.respawns | respawns | respawns |\n\n",
19434
- "integration_type": "collector",
19435
- "id": "python.d.plugin-uwsgi-uWSGI",
19436
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/uwsgi/metadata.yaml",
19437
- "related_resources": ""
19438
- },
19440
{
19441
"meta": {
19442
"plugin_name": "python.d.plugin",
src/collectors/COLLECTORS.md
+1
-1
@@ -1161,7 +1161,7 @@ If you don't see the app/service you'd like to monitor in this list:
1161
1162
- [Web server log files](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/weblog/integrations/web_server_log_files.md)
1163
1164
-- [uWSGI](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/uwsgi/integrations/uwsgi.md)
1164
+- [uWSGI](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/uwsgi/integrations/uwsgi.md)
1165
1166
### Windows Systems
1167
src/go/plugin/go.d/modules/uwsgi/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/uwsgi.md
\ No newline at end of file
src/go/plugin/go.d/modules/uwsgi/integrations/uwsgi.md
new
+246
@@ -0,0 +1,246 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/uwsgi/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/uwsgi/metadata.yaml"
4
+sidebar_label: "uWSGI"
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
+# uWSGI
12
+
13
+
14
+<img src="https://netdata.cloud/img/uwsgi.svg" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: uwsgi
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+Monitors UWSGI worker health and performance by collecting metrics like requests, transmitted data, exceptions, and harakiris.
25
+
26
+
27
+It fetches [Stats Server](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html) statistics over TCP.
28
+
29
+
30
+This collector is supported on all platforms.
31
+
32
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
33
+
34
+
35
+### Default Behavior
36
+
37
+#### Auto-Detection
38
+
39
+Automatically discovers and collects UWSGI statistics from the following default locations:
40
+
41
+- localhost:1717
42
+
43
+
44
+#### Limits
45
+
46
+The default configuration for this integration does not impose any limits on data collection.
47
+
48
+#### Performance Impact
49
+
50
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
51
+
52
+
53
+## Metrics
54
+
55
+Metrics grouped by *scope*.
56
+
57
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
58
+
59
+
60
+
61
+### Per uWSGI instance
62
+
63
+These metrics refer to the entire monitored application.
64
+
65
+This scope has no labels.
66
+
67
+Metrics:
68
+
69
+| Metric | Dimensions | Unit |
70
+|:------|:----------|:----|
71
+| uwsgi.transmitted_data | tx | bytes/s |
72
+| uwsgi.requests | requests | requests/s |
73
+| uwsgi.harakiris | harakiris | harakiris/s |
74
+| uwsgi.respawns | respawns | respawns/s |
75
+
76
+### Per worker
77
+
78
+These metrics refer to the Worker process.
79
+
80
+Labels:
81
+
82
+| Label | Description |
83
+|:-----------|:----------------|
84
+| worker_id | Worker ID. |
85
+
86
+Metrics:
87
+
88
+| Metric | Dimensions | Unit |
89
+|:------|:----------|:----|
90
+| uwsgi.worker_transmitted_data | tx | bytes/s |
91
+| uwsgi.worker_requests | requests | requests/s |
92
+| uwsgi.worker_delta_requests | delta_requests | requests/s |
93
+| uwsgi.worker_average_request_time | avg | milliseconds |
94
+| uwsgi.worker_harakiris | harakiris | harakiris/s |
95
+| uwsgi.worker_exceptions | exceptions | exceptions/s |
96
+| uwsgi.worker_status | idle, busy, cheap, pause, sig | status |
97
+| uwsgi.worker_request_handling_status | accepting, not_accepting | status |
98
+| uwsgi.worker_respawns | respawns | respawns/s |
99
+| uwsgi.worker_memory_rss | rss | bytes |
100
+| uwsgi.worker_memory_vsz | vsz | bytes |
101
+
102
+
103
+
104
+## Alerts
105
+
106
+There are no alerts configured by default for this integration.
107
+
108
+
109
+## Setup
110
+
111
+### Prerequisites
112
+
113
+#### Enable the uWSGI Stats Server
114
+
115
+See [Stats Server](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html) for details.
116
+
117
+
118
+
119
+### Configuration
120
+
121
+#### File
122
+
123
+The configuration file name for this integration is `go.d/uwsgi.conf`.
124
+
125
+
126
+You can edit the configuration file using the `edit-config` script from the
127
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
128
+
129
+```bash
130
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
131
+sudo ./edit-config go.d/uwsgi.conf
132
+```
133
+#### Options
134
+
135
+The following options can be defined globally: update_every, autodetection_retry.
136
+
137
+
138
+<details open><summary>Config options</summary>
139
+
140
+| Name | Description | Default | Required |
141
+|:----|:-----------|:-------|:--------:|
142
+| update_every | Data collection frequency. | 1 | no |
143
+| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
144
+| address | The IP address and port where the UWSGI [Stats Server](https://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html) listens for connections. | 127.0.0.1:1717 | yes |
145
+| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no |
146
+
147
+</details>
148
+
149
+#### Examples
150
+
151
+##### Basic
152
+
153
+A basic example configuration.
154
+
155
+<details open><summary>Config</summary>
156
+
157
+```yaml
158
+jobs:
159
+ - name: local
160
+ address: 127.0.0.1:1717
161
+
162
+```
163
+</details>
164
+
165
+##### Multi-instance
166
+
167
+> **Note**: When you define multiple jobs, their names must be unique.
168
+
169
+Collecting metrics from local and remote instances.
170
+
171
+
172
+<details open><summary>Config</summary>
173
+
174
+```yaml
175
+jobs:
176
+ - name: local
177
+ address: 127.0.0.1:1717
178
+
179
+ - name: remote
180
+ address: 203.0.113.0:1717
181
+
182
+```
183
+</details>
184
+
185
+
186
+
187
+## Troubleshooting
188
+
189
+### Debug Mode
190
+
191
+To troubleshoot issues with the `uwsgi` collector, run the `go.d.plugin` with the debug option enabled. The output
192
+should give you clues as to why the collector isn't working.
193
+
194
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
195
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
196
+
197
+ ```bash
198
+ cd /usr/libexec/netdata/plugins.d/
199
+ ```
200
+
201
+- Switch to the `netdata` user.
202
+
203
+ ```bash
204
+ sudo -u netdata -s
205
+ ```
206
+
207
+- Run the `go.d.plugin` to debug the collector:
208
+
209
+ ```bash
210
+ ./go.d.plugin -d -m uwsgi
211
+ ```
212
+
213
+### Getting Logs
214
+
215
+If you're encountering problems with the `uwsgi` collector, follow these steps to retrieve logs and identify potential issues:
216
+
217
+- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
218
+- **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.
219
+
220
+#### System with systemd
221
+
222
+Use the following command to view logs generated since the last Netdata service restart:
223
+
224
+```bash
225
+journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep uwsgi
226
+```
227
+
228
+#### System without systemd
229
+
230
+Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
231
+
232
+```bash
233
+grep uwsgi /var/log/netdata/collector.log
234
+```
235
+
236
+**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
237
+
238
+#### Docker Container
239
+
240
+If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
241
+
242
+```bash
243
+docker logs netdata 2>&1 | grep uwsgi
244
+```
245
+
246
+