@cryptotaxi247 / netdata-1 / commits / 40c624503

Regenerate integrations.js (#18282)

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

Netdata bot committed Aug 8, 2024 at 16:11 UTC 40c624503ebfee3e3c6b0758a25f86abab8bc8a4
5 files changed +303 -75
integrations/integrations.js
+38 -37
@@ -16299,6 +16299,44 @@ export const integrations = [
16299 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/snmp/metadata.yaml",
16300 "related_resources": ""
16301 },
16302 + {
16303 + "meta": {
16304 + "id": "collector-go.d.plugin-squid",
16305 + "plugin_name": "go.d.plugin",
16306 + "module_name": "squid",
16307 + "monitored_instance": {
16308 + "name": "Squid",
16309 + "link": "https://www.squid-cache.org/",
16310 + "categories": [
16311 + "data-collection.web-servers-and-web-proxies"
16312 + ],
16313 + "icon_filename": "squid.png"
16314 + },
16315 + "related_resources": {
16316 + "integrations": {
16317 + "list": []
16318 + }
16319 + },
16320 + "info_provided_to_referring_integrations": {
16321 + "description": ""
16322 + },
16323 + "keywords": [
16324 + "squid",
16325 + "web delivery",
16326 + "squid caching proxy"
16327 + ],
16328 + "most_popular": false
16329 + },
16330 + "overview": "# Squid\n\nPlugin: go.d.plugin\nModule: squid\n\n## Overview\n\nThis collector monitors statistics about the Squid Clients and Servers, like bandwidth and requests.\n\n\nIt collects metrics from the `squid-internal-mgr/counters` endpoint.\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, it detects Squid instances running on localhost that are listening on port 3128.\nOn startup, it tries to collect metrics from:\n\n- https://127.0.0.1:3128\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",
16331 + "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/squid.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/squid.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:3128 | 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. | POST | 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:3128\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:3128\n\n - name: remote\n url: http://192.0.2.1:3128\n\n```\n{% /details %}\n",
16332 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `squid` 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 squid\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `squid` 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 squid\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 squid /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 squid\n```\n\n",
16333 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
16334 + "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 Squid instance\n\nThese metrics refer to each monitored Squid instance.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| squid.clients_net | in, out, hits | kilobits/s |\n| squid.clients_requests | requests, hits, errors | requests/s |\n| squid.servers_net | in, out | kilobits/s |\n| squid.servers_requests | requests, errors | requests/s |\n\n",
16335 + "integration_type": "collector",
16336 + "id": "go.d.plugin-squid-Squid",
16337 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/squid/metadata.yaml",
16338 + "related_resources": ""
16339 + },
16340 {
16341 "meta": {
16342 "id": "collector-go.d.plugin-squidlog",
@@ -19359,43 +19397,6 @@ export const integrations = [
19397 "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/spigotmc/metadata.yaml",
19398 "related_resources": ""
19399 },
19362 - {
19363 - "meta": {
19364 - "plugin_name": "python.d.plugin",
19365 - "module_name": "squid",
19366 - "monitored_instance": {
19367 - "name": "Squid",
19368 - "link": "http://www.squid-cache.org/",
19369 - "categories": [
19370 - "data-collection.web-servers-and-web-proxies"
19371 - ],
19372 - "icon_filename": "squid.png"
19373 - },
19374 - "related_resources": {
19375 - "integrations": {
19376 - "list": []
19377 - }
19378 - },
19379 - "info_provided_to_referring_integrations": {
19380 - "description": ""
19381 - },
19382 - "keywords": [
19383 - "squid",
19384 - "web delivery",
19385 - "squid caching proxy"
19386 - ],
19387 - "most_popular": false
19388 - },
19389 - "overview": "# Squid\n\nPlugin: python.d.plugin\nModule: squid\n\n## Overview\n\nThis collector monitors statistics about the Squid Clients and Servers, like bandwidth and requests.\n\n\nIt collects metrics from the endpoint where Squid exposes its `counters` data.\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, this collector will try to autodetect where Squid presents its `counters` data, by trying various configurations.\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",
19390 - "setup": "## Setup\n\n### Prerequisites\n\n#### Configure Squid's Cache Manager\n\nTake a look at [Squid's official documentation](https://wiki.squid-cache.org/Features/CacheManager/Index#controlling-access-to-the-cache-manager) on how to configure access to the Cache Manager.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/squid.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/squid.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. | 1 | 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. | local | no |\n| host | The host to connect to. | | yes |\n| port | The port to connect to. | | yes |\n| request | The URL to request from Squid. | | yes |\n\n{% /details %}\n#### Examples\n\n##### Basic\n\nA basic configuration example.\n\n```yaml\nexample_job_name:\n name: 'local'\n host: 'localhost'\n port: 3128\n request: 'cache_object://localhost:3128/counters'\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\nlocal_job:\n name: 'local'\n host: '127.0.0.1'\n port: 3128\n request: 'cache_object://127.0.0.1:3128/counters'\n\nremote_job:\n name: 'remote'\n host: '192.0.2.1'\n port: 3128\n request: 'cache_object://192.0.2.1:3128/counters'\n\n```\n{% /details %}\n",
19391 - "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `squid` 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 squid debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `squid` 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 squid\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 squid /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 squid\n```\n\n",
19392 - "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19393 - "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 Squid instance\n\nThese metrics refer to each monitored Squid instance.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| squid.clients_net | in, out, hits | kilobits/s |\n| squid.clients_requests | requests, hits, errors | requests/s |\n| squid.servers_net | in, out | kilobits/s |\n| squid.servers_requests | requests, errors | requests/s |\n\n",
19394 - "integration_type": "collector",
19395 - "id": "python.d.plugin-squid-Squid",
19396 - "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/squid/metadata.yaml",
19397 - "related_resources": ""
19398 - },
19400 {
19401 "meta": {
19402 "plugin_name": "python.d.plugin",
integrations/integrations.json
+38 -37
@@ -16297,6 +16297,44 @@
16297 "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/snmp/metadata.yaml",
16298 "related_resources": ""
16299 },
16300 + {
16301 + "meta": {
16302 + "id": "collector-go.d.plugin-squid",
16303 + "plugin_name": "go.d.plugin",
16304 + "module_name": "squid",
16305 + "monitored_instance": {
16306 + "name": "Squid",
16307 + "link": "https://www.squid-cache.org/",
16308 + "categories": [
16309 + "data-collection.web-servers-and-web-proxies"
16310 + ],
16311 + "icon_filename": "squid.png"
16312 + },
16313 + "related_resources": {
16314 + "integrations": {
16315 + "list": []
16316 + }
16317 + },
16318 + "info_provided_to_referring_integrations": {
16319 + "description": ""
16320 + },
16321 + "keywords": [
16322 + "squid",
16323 + "web delivery",
16324 + "squid caching proxy"
16325 + ],
16326 + "most_popular": false
16327 + },
16328 + "overview": "# Squid\n\nPlugin: go.d.plugin\nModule: squid\n\n## Overview\n\nThis collector monitors statistics about the Squid Clients and Servers, like bandwidth and requests.\n\n\nIt collects metrics from the `squid-internal-mgr/counters` endpoint.\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, it detects Squid instances running on localhost that are listening on port 3128.\nOn startup, it tries to collect metrics from:\n\n- https://127.0.0.1:3128\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",
16329 + "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/squid.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/squid.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:3128 | 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. | POST | 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:3128\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:3128\n\n - name: remote\n url: http://192.0.2.1:3128\n\n```\n",
16330 + "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `squid` 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 squid\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `squid` 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 squid\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 squid /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 squid\n```\n\n",
16331 + "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
16332 + "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 Squid instance\n\nThese metrics refer to each monitored Squid instance.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| squid.clients_net | in, out, hits | kilobits/s |\n| squid.clients_requests | requests, hits, errors | requests/s |\n| squid.servers_net | in, out | kilobits/s |\n| squid.servers_requests | requests, errors | requests/s |\n\n",
16333 + "integration_type": "collector",
16334 + "id": "go.d.plugin-squid-Squid",
16335 + "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/squid/metadata.yaml",
16336 + "related_resources": ""
16337 + },
16338 {
16339 "meta": {
16340 "id": "collector-go.d.plugin-squidlog",
@@ -19357,43 +19395,6 @@
19395 "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/spigotmc/metadata.yaml",
19396 "related_resources": ""
19397 },
19360 - {
19361 - "meta": {
19362 - "plugin_name": "python.d.plugin",
19363 - "module_name": "squid",
19364 - "monitored_instance": {
19365 - "name": "Squid",
19366 - "link": "http://www.squid-cache.org/",
19367 - "categories": [
19368 - "data-collection.web-servers-and-web-proxies"
19369 - ],
19370 - "icon_filename": "squid.png"
19371 - },
19372 - "related_resources": {
19373 - "integrations": {
19374 - "list": []
19375 - }
19376 - },
19377 - "info_provided_to_referring_integrations": {
19378 - "description": ""
19379 - },
19380 - "keywords": [
19381 - "squid",
19382 - "web delivery",
19383 - "squid caching proxy"
19384 - ],
19385 - "most_popular": false
19386 - },
19387 - "overview": "# Squid\n\nPlugin: python.d.plugin\nModule: squid\n\n## Overview\n\nThis collector monitors statistics about the Squid Clients and Servers, like bandwidth and requests.\n\n\nIt collects metrics from the endpoint where Squid exposes its `counters` data.\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, this collector will try to autodetect where Squid presents its `counters` data, by trying various configurations.\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",
19388 - "setup": "## Setup\n\n### Prerequisites\n\n#### Configure Squid's Cache Manager\n\nTake a look at [Squid's official documentation](https://wiki.squid-cache.org/Features/CacheManager/Index#controlling-access-to-the-cache-manager) on how to configure access to the Cache Manager.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/squid.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/squid.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. | 1 | 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. | local | no |\n| host | The host to connect to. | | yes |\n| port | The port to connect to. | | yes |\n| request | The URL to request from Squid. | | yes |\n\n#### Examples\n\n##### Basic\n\nA basic configuration example.\n\n```yaml\nexample_job_name:\n name: 'local'\n host: 'localhost'\n port: 3128\n request: 'cache_object://localhost:3128/counters'\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_job:\n name: 'local'\n host: '127.0.0.1'\n port: 3128\n request: 'cache_object://127.0.0.1:3128/counters'\n\nremote_job:\n name: 'remote'\n host: '192.0.2.1'\n port: 3128\n request: 'cache_object://192.0.2.1:3128/counters'\n\n```\n",
19389 - "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `squid` 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 squid debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `squid` 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 squid\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 squid /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 squid\n```\n\n",
19390 - "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19391 - "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 Squid instance\n\nThese metrics refer to each monitored Squid instance.\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| squid.clients_net | in, out, hits | kilobits/s |\n| squid.clients_requests | requests, hits, errors | requests/s |\n| squid.servers_net | in, out | kilobits/s |\n| squid.servers_requests | requests, errors | requests/s |\n\n",
19392 - "integration_type": "collector",
19393 - "id": "python.d.plugin-squid-Squid",
19394 - "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/squid/metadata.yaml",
19395 - "related_resources": ""
19396 - },
19398 {
19399 "meta": {
19400 "plugin_name": "python.d.plugin",
src/collectors/COLLECTORS.md
+1 -1
@@ -1151,7 +1151,7 @@ If you don't see the app/service you'd like to monitor in this list:
1151
1152 - [Squid log files](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/squidlog/integrations/squid_log_files.md)
1153
1154 -- [Squid](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/squid/integrations/squid.md)
1154 +- [Squid](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/squid/integrations/squid.md)
1155
1156 - [Tengine](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/tengine/integrations/tengine.md)
1157
src/go/plugin/go.d/modules/squid/README.md new
+1
@@ -0,0 +1 @@
1 +integrations/squid.md
\ No newline at end of file
src/go/plugin/go.d/modules/squid/integrations/squid.md new
+225
@@ -0,0 +1,225 @@
1 +<!--startmeta
2 +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/squid/README.md"
3 +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/squid/metadata.yaml"
4 +sidebar_label: "Squid"
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 +# Squid
12 +
13 +
14 +<img src="https://netdata.cloud/img/squid.png" width="150"/>
15 +
16 +
17 +Plugin: go.d.plugin
18 +Module: squid
19 +
20 +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21 +
22 +## Overview
23 +
24 +This collector monitors statistics about the Squid Clients and Servers, like bandwidth and requests.
25 +
26 +
27 +It collects metrics from the `squid-internal-mgr/counters` endpoint.
28 +
29 +This collector is supported on all platforms.
30 +
31 +This collector supports collecting metrics from multiple instances of this integration, including remote instances.
32 +
33 +
34 +### Default Behavior
35 +
36 +#### Auto-Detection
37 +
38 +By default, it detects Squid instances running on localhost that are listening on port 3128.
39 +On startup, it tries to collect metrics from:
40 +
41 +- https://127.0.0.1:3128
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 Squid instance
62 +
63 +These metrics refer to each monitored Squid instance.
64 +
65 +This scope has no labels.
66 +
67 +Metrics:
68 +
69 +| Metric | Dimensions | Unit |
70 +|:------|:----------|:----|
71 +| squid.clients_net | in, out, hits | kilobits/s |
72 +| squid.clients_requests | requests, hits, errors | requests/s |
73 +| squid.servers_net | in, out | kilobits/s |
74 +| squid.servers_requests | requests, errors | requests/s |
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 +No action required.
88 +
89 +### Configuration
90 +
91 +#### File
92 +
93 +The configuration file name for this integration is `go.d/squid.conf`.
94 +
95 +
96 +You can edit the configuration file using the `edit-config` script from the
97 +Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
98 +
99 +```bash
100 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
101 +sudo ./edit-config go.d/squid.conf
102 +```
103 +#### Options
104 +
105 +The following options can be defined globally: update_every, autodetection_retry.
106 +
107 +
108 +<details open><summary>Config options</summary>
109 +
110 +| Name | Description | Default | Required |
111 +|:----|:-----------|:-------|:--------:|
112 +| update_every | Data collection frequency. | 1 | no |
113 +| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
114 +| url | Server URL. | http://127.0.0.1:3128 | yes |
115 +| timeout | HTTP request timeout. | 1 | no |
116 +| username | Username for basic HTTP authentication. | | no |
117 +| password | Password for basic HTTP authentication. | | no |
118 +| proxy_url | Proxy URL. | | no |
119 +| proxy_username | Username for proxy basic HTTP authentication. | | no |
120 +| proxy_password | Password for proxy basic HTTP authentication. | | no |
121 +| method | HTTP request method. | POST | no |
122 +| body | HTTP request body. | | no |
123 +| headers | HTTP request headers. | | no |
124 +| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |
125 +| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
126 +| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |
127 +| tls_cert | Client TLS certificate. | | no |
128 +| tls_key | Client TLS key. | | no |
129 +
130 +</details>
131 +
132 +#### Examples
133 +
134 +##### Basic
135 +
136 +A basic example configuration.
137 +
138 +```yaml
139 +jobs:
140 + - name: local
141 + url: http://127.0.0.1:3128
142 +
143 +```
144 +##### Multi-instance
145 +
146 +> **Note**: When you define multiple jobs, their names must be unique.
147 +
148 +Collecting metrics from local and remote instances.
149 +
150 +
151 +<details open><summary>Config</summary>
152 +
153 +```yaml
154 +jobs:
155 + - name: local
156 + url: http://127.0.0.1:3128
157 +
158 + - name: remote
159 + url: http://192.0.2.1:3128
160 +
161 +```
162 +</details>
163 +
164 +
165 +
166 +## Troubleshooting
167 +
168 +### Debug Mode
169 +
170 +To troubleshoot issues with the `squid` collector, run the `go.d.plugin` with the debug option enabled. The output
171 +should give you clues as to why the collector isn't working.
172 +
173 +- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
174 + your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
175 +
176 + ```bash
177 + cd /usr/libexec/netdata/plugins.d/
178 + ```
179 +
180 +- Switch to the `netdata` user.
181 +
182 + ```bash
183 + sudo -u netdata -s
184 + ```
185 +
186 +- Run the `go.d.plugin` to debug the collector:
187 +
188 + ```bash
189 + ./go.d.plugin -d -m squid
190 + ```
191 +
192 +### Getting Logs
193 +
194 +If you're encountering problems with the `squid` collector, follow these steps to retrieve logs and identify potential issues:
195 +
196 +- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
197 +- **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.
198 +
199 +#### System with systemd
200 +
201 +Use the following command to view logs generated since the last Netdata service restart:
202 +
203 +```bash
204 +journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep squid
205 +```
206 +
207 +#### System without systemd
208 +
209 +Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
210 +
211 +```bash
212 +grep squid /var/log/netdata/collector.log
213 +```
214 +
215 +**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
216 +
217 +#### Docker Container
218 +
219 +If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
220 +
221 +```bash
222 +docker logs netdata 2>&1 | grep squid
223 +```
224 +
225 +