Regenerate integrations.js (#18508)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Sep 10, 2024 at 07:46 UTC
657090cda87c67630e72f69440d3a1476e16f98f
5 files changed
+311
-81
integrations/integrations.js
+40
-40
@@ -17012,6 +17012,46 @@ export const integrations = [
17012
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/uwsgi/metadata.yaml",
17013
"related_resources": ""
17014
},
17015
+ {
17016
+ "meta": {
17017
+ "plugin_name": "go.d.plugin",
17018
+ "module_name": "varnish",
17019
+ "monitored_instance": {
17020
+ "name": "Varnish",
17021
+ "link": "https://varnish-cache.org/",
17022
+ "categories": [
17023
+ "data-collection.web-servers-and-web-proxies"
17024
+ ],
17025
+ "icon_filename": "varnish.svg"
17026
+ },
17027
+ "related_resources": {
17028
+ "integrations": {
17029
+ "list": []
17030
+ }
17031
+ },
17032
+ "info_provided_to_referring_integrations": {
17033
+ "description": ""
17034
+ },
17035
+ "keywords": [
17036
+ "varnish",
17037
+ "varnishstat",
17038
+ "varnishd",
17039
+ "cache",
17040
+ "web server",
17041
+ "web cache"
17042
+ ],
17043
+ "most_popular": false
17044
+ },
17045
+ "overview": "# Varnish\n\nPlugin: go.d.plugin\nModule: varnish\n\n## Overview\n\nThis collector monitors Varnish instances, supporting both the open-source Varnish-Cache and the commercial Varnish-Plus.\n\nIt tracks key performance metrics, along with detailed statistics for Backends (VBE) and Storages (SMF, SMA, MSE).\n\nIt relies on the [`varnishstat`](https://varnish-cache.org/docs/trunk/reference/varnishstat.html) CLI tool but avoids directly executing the binary.\nInstead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment.\nThis approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.\n\n\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\nThis integration doesn't support auto-detection.\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",
17046
+ "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/varnish.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/varnish.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| timeout | Timeout for executing the binary, specified in seconds. | 2 | no |\n| instance_name | Specifies the name of the Varnish instance to collect metrics from. This corresponds to the `-n` argument used with the [varnishstat](https://varnish-cache.org/docs/trunk/reference/varnishstat.html) command. | | no |\n\n{% /details %}\n#### Examples\n\n##### Custom update_every\n\nAllows you to override the default data collection interval.\n\n```yaml\njobs:\n - name: varnish\n update_every: 5\n\n```\n",
17047
+ "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 `varnish` 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 varnish\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `varnish` 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 varnish\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 varnish /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 varnish\n```\n\n",
17048
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
17049
+ "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 Varnish 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| varnish.client_session_connections | accepted, dropped | connections/s |\n| varnish.client_requests | received | requests/s |\n| varnish.cache_hit_ratio_total | hit, miss, hitpass, hitmiss | percent |\n| varnish.cache_hit_ratio_delta | hit, miss, hitpass, hitmiss | percent |\n| varnish.cache_expired_objects | expired | objects/s |\n| varnish.cache_lru_activity | nuked, moved | objects/s |\n| varnish.threads | threads | threads |\n| varnish.thread_management_activity | created, failed, destroyed, limited | threads/s |\n| varnish.thread_queue_len | queue_length | threads |\n| varnish.backends_requests | sent | requests/s |\n| varnish.esi_parsing_issues | errors, warnings | issues/s |\n| varnish.mgmt_process_uptime | uptime | seconds |\n| varnish.child_process_uptime | uptime | seconds |\n\n### Per Backend\n\nThese metrics refer to the Backend (VBE).\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| varnish.backend_data_transfer | req_header, req_body, resp_header, resp_body | bytes/s |\n\n### Per Storage\n\nThese metrics refer to the Storage (SMA, SMF, MSE).\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| varnish.storage_space_usage | free, used | bytes |\n| varnish.storage_allocated_objects | allocated | objects |\n\n",
17050
+ "integration_type": "collector",
17051
+ "id": "go.d.plugin-varnish-Varnish",
17052
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/varnish/metadata.yaml",
17053
+ "related_resources": ""
17054
+ },
17055
{
17056
"meta": {
17057
"id": "collector-go.d.plugin-vcsa",
@@ -19294,46 +19334,6 @@ export const integrations = [
19334
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/spigotmc/metadata.yaml",
19335
"related_resources": ""
19336
},
19297
- {
19298
- "meta": {
19299
- "plugin_name": "python.d.plugin",
19300
- "module_name": "varnish",
19301
- "monitored_instance": {
19302
- "name": "Varnish",
19303
- "link": "https://varnish-cache.org/",
19304
- "categories": [
19305
- "data-collection.web-servers-and-web-proxies"
19306
- ],
19307
- "icon_filename": "varnish.svg"
19308
- },
19309
- "related_resources": {
19310
- "integrations": {
19311
- "list": []
19312
- }
19313
- },
19314
- "info_provided_to_referring_integrations": {
19315
- "description": ""
19316
- },
19317
- "keywords": [
19318
- "varnish",
19319
- "varnishstat",
19320
- "varnishd",
19321
- "cache",
19322
- "web server",
19323
- "web cache"
19324
- ],
19325
- "most_popular": false
19326
- },
19327
- "overview": "# Varnish\n\nPlugin: python.d.plugin\nModule: varnish\n\n## Overview\n\nThis collector monitors Varnish metrics about HTTP accelerator global, Backends (VBE) and Storages (SMF, SMA, MSE) statistics.\n\nNote that both, Varnish-Cache (free and open source) and Varnish-Plus (Commercial/Enterprise version), are supported.\n\n\nIt uses the `varnishstat` tool in order to collect the metrics.\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`netdata` user must be a member of the `varnish` group.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, if the permissions are satisfied, the `varnishstat` tool will be executed on the host.\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",
19328
- "setup": "## Setup\n\n### Prerequisites\n\n#### Provide the necessary permissions\n\nIn order for the collector to work, you need to add the `netdata` user to the `varnish` user group, so that it can execute the `varnishstat` tool:\n\n```\nusermod -aG varnish netdata\n```\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/varnish.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/varnish.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| instance_name | the name of the varnishd instance to get logs from. If not specified, the local host name is used. | | yes |\n| update_every | Sets the default data collection frequency. | 10 | no |\n| priority | Controls the order of charts at the netdata dashboard. | 60000 | no |\n| autodetection_retry | Sets the job re-check interval in seconds. | 0 | no |\n| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no |\n| name | Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. | | no |\n\n{% /details %}\n#### Examples\n\n##### Basic\n\nAn example configuration.\n\n```yaml\njob_name:\n instance_name: '<name-of-varnishd-instance>'\n\n```\n",
19329
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n\nTo troubleshoot issues with the `varnish` 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 varnish debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `varnish` 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 varnish\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 varnish /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 varnish\n```\n\n",
19330
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19331
- "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 Varnish 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| varnish.session_connection | accepted, dropped | connections/s |\n| varnish.client_requests | received | requests/s |\n| varnish.all_time_hit_rate | hit, miss, hitpass | percentage |\n| varnish.current_poll_hit_rate | hit, miss, hitpass | percentage |\n| varnish.cached_objects_expired | objects | expired/s |\n| varnish.cached_objects_nuked | objects | nuked/s |\n| varnish.threads_total | None | number |\n| varnish.threads_statistics | created, failed, limited | threads/s |\n| varnish.threads_queue_len | in queue | requests |\n| varnish.backend_connections | successful, unhealthy, reused, closed, recycled, failed | connections/s |\n| varnish.backend_requests | sent | requests/s |\n| varnish.esi_statistics | errors, warnings | problems/s |\n| varnish.memory_usage | free, allocated | MiB |\n| varnish.uptime | uptime | seconds |\n\n### Per Backend\n\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| varnish.backend | header, body | kilobits/s |\n\n### Per Storage\n\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| varnish.storage_usage | free, allocated | KiB |\n| varnish.storage_alloc_objs | allocated | objects |\n\n",
19332
- "integration_type": "collector",
19333
- "id": "python.d.plugin-varnish-Varnish",
19334
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/varnish/metadata.yaml",
19335
- "related_resources": ""
19336
- },
19337
{
19338
"meta": {
19339
"plugin_name": "python.d.plugin",
integrations/integrations.json
+40
-40
@@ -17010,6 +17010,46 @@
17010
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/uwsgi/metadata.yaml",
17011
"related_resources": ""
17012
},
17013
+ {
17014
+ "meta": {
17015
+ "plugin_name": "go.d.plugin",
17016
+ "module_name": "varnish",
17017
+ "monitored_instance": {
17018
+ "name": "Varnish",
17019
+ "link": "https://varnish-cache.org/",
17020
+ "categories": [
17021
+ "data-collection.web-servers-and-web-proxies"
17022
+ ],
17023
+ "icon_filename": "varnish.svg"
17024
+ },
17025
+ "related_resources": {
17026
+ "integrations": {
17027
+ "list": []
17028
+ }
17029
+ },
17030
+ "info_provided_to_referring_integrations": {
17031
+ "description": ""
17032
+ },
17033
+ "keywords": [
17034
+ "varnish",
17035
+ "varnishstat",
17036
+ "varnishd",
17037
+ "cache",
17038
+ "web server",
17039
+ "web cache"
17040
+ ],
17041
+ "most_popular": false
17042
+ },
17043
+ "overview": "# Varnish\n\nPlugin: go.d.plugin\nModule: varnish\n\n## Overview\n\nThis collector monitors Varnish instances, supporting both the open-source Varnish-Cache and the commercial Varnish-Plus.\n\nIt tracks key performance metrics, along with detailed statistics for Backends (VBE) and Storages (SMF, SMA, MSE).\n\nIt relies on the [`varnishstat`](https://varnish-cache.org/docs/trunk/reference/varnishstat.html) CLI tool but avoids directly executing the binary.\nInstead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment.\nThis approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.\n\n\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\nThis integration doesn't support auto-detection.\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",
17044
+ "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/varnish.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/varnish.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| timeout | Timeout for executing the binary, specified in seconds. | 2 | no |\n| instance_name | Specifies the name of the Varnish instance to collect metrics from. This corresponds to the `-n` argument used with the [varnishstat](https://varnish-cache.org/docs/trunk/reference/varnishstat.html) command. | | no |\n\n#### Examples\n\n##### Custom update_every\n\nAllows you to override the default data collection interval.\n\n```yaml\njobs:\n - name: varnish\n update_every: 5\n\n```\n",
17045
+ "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 `varnish` 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 varnish\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `varnish` 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 varnish\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 varnish /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 varnish\n```\n\n",
17046
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
17047
+ "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 Varnish 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| varnish.client_session_connections | accepted, dropped | connections/s |\n| varnish.client_requests | received | requests/s |\n| varnish.cache_hit_ratio_total | hit, miss, hitpass, hitmiss | percent |\n| varnish.cache_hit_ratio_delta | hit, miss, hitpass, hitmiss | percent |\n| varnish.cache_expired_objects | expired | objects/s |\n| varnish.cache_lru_activity | nuked, moved | objects/s |\n| varnish.threads | threads | threads |\n| varnish.thread_management_activity | created, failed, destroyed, limited | threads/s |\n| varnish.thread_queue_len | queue_length | threads |\n| varnish.backends_requests | sent | requests/s |\n| varnish.esi_parsing_issues | errors, warnings | issues/s |\n| varnish.mgmt_process_uptime | uptime | seconds |\n| varnish.child_process_uptime | uptime | seconds |\n\n### Per Backend\n\nThese metrics refer to the Backend (VBE).\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| varnish.backend_data_transfer | req_header, req_body, resp_header, resp_body | bytes/s |\n\n### Per Storage\n\nThese metrics refer to the Storage (SMA, SMF, MSE).\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| varnish.storage_space_usage | free, used | bytes |\n| varnish.storage_allocated_objects | allocated | objects |\n\n",
17048
+ "integration_type": "collector",
17049
+ "id": "go.d.plugin-varnish-Varnish",
17050
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/varnish/metadata.yaml",
17051
+ "related_resources": ""
17052
+ },
17053
{
17054
"meta": {
17055
"id": "collector-go.d.plugin-vcsa",
@@ -19292,46 +19332,6 @@
19332
"edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/spigotmc/metadata.yaml",
19333
"related_resources": ""
19334
},
19295
- {
19296
- "meta": {
19297
- "plugin_name": "python.d.plugin",
19298
- "module_name": "varnish",
19299
- "monitored_instance": {
19300
- "name": "Varnish",
19301
- "link": "https://varnish-cache.org/",
19302
- "categories": [
19303
- "data-collection.web-servers-and-web-proxies"
19304
- ],
19305
- "icon_filename": "varnish.svg"
19306
- },
19307
- "related_resources": {
19308
- "integrations": {
19309
- "list": []
19310
- }
19311
- },
19312
- "info_provided_to_referring_integrations": {
19313
- "description": ""
19314
- },
19315
- "keywords": [
19316
- "varnish",
19317
- "varnishstat",
19318
- "varnishd",
19319
- "cache",
19320
- "web server",
19321
- "web cache"
19322
- ],
19323
- "most_popular": false
19324
- },
19325
- "overview": "# Varnish\n\nPlugin: python.d.plugin\nModule: varnish\n\n## Overview\n\nThis collector monitors Varnish metrics about HTTP accelerator global, Backends (VBE) and Storages (SMF, SMA, MSE) statistics.\n\nNote that both, Varnish-Cache (free and open source) and Varnish-Plus (Commercial/Enterprise version), are supported.\n\n\nIt uses the `varnishstat` tool in order to collect the metrics.\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`netdata` user must be a member of the `varnish` group.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nBy default, if the permissions are satisfied, the `varnishstat` tool will be executed on the host.\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",
19326
- "setup": "## Setup\n\n### Prerequisites\n\n#### Provide the necessary permissions\n\nIn order for the collector to work, you need to add the `netdata` user to the `varnish` user group, so that it can execute the `varnishstat` tool:\n\n```\nusermod -aG varnish netdata\n```\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `python.d/varnish.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/varnish.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| instance_name | the name of the varnishd instance to get logs from. If not specified, the local host name is used. | | yes |\n| update_every | Sets the default data collection frequency. | 10 | no |\n| priority | Controls the order of charts at the netdata dashboard. | 60000 | no |\n| autodetection_retry | Sets the job re-check interval in seconds. | 0 | no |\n| penalty | Indicates whether to apply penalty to update_every in case of failures. | yes | no |\n| name | Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. | | no |\n\n#### Examples\n\n##### Basic\n\nAn example configuration.\n\n```yaml\njob_name:\n instance_name: '<name-of-varnishd-instance>'\n\n```\n",
19327
- "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n\nTo troubleshoot issues with the `varnish` 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 varnish debug trace\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `varnish` 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 varnish\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 varnish /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 varnish\n```\n\n",
19328
- "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
19329
- "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 Varnish 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| varnish.session_connection | accepted, dropped | connections/s |\n| varnish.client_requests | received | requests/s |\n| varnish.all_time_hit_rate | hit, miss, hitpass | percentage |\n| varnish.current_poll_hit_rate | hit, miss, hitpass | percentage |\n| varnish.cached_objects_expired | objects | expired/s |\n| varnish.cached_objects_nuked | objects | nuked/s |\n| varnish.threads_total | None | number |\n| varnish.threads_statistics | created, failed, limited | threads/s |\n| varnish.threads_queue_len | in queue | requests |\n| varnish.backend_connections | successful, unhealthy, reused, closed, recycled, failed | connections/s |\n| varnish.backend_requests | sent | requests/s |\n| varnish.esi_statistics | errors, warnings | problems/s |\n| varnish.memory_usage | free, allocated | MiB |\n| varnish.uptime | uptime | seconds |\n\n### Per Backend\n\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| varnish.backend | header, body | kilobits/s |\n\n### Per Storage\n\n\n\nThis scope has no labels.\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| varnish.storage_usage | free, allocated | KiB |\n| varnish.storage_alloc_objs | allocated | objects |\n\n",
19330
- "integration_type": "collector",
19331
- "id": "python.d.plugin-varnish-Varnish",
19332
- "edit_link": "https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/varnish/metadata.yaml",
19333
- "related_resources": ""
19334
- },
19335
{
19336
"meta": {
19337
"plugin_name": "python.d.plugin",
src/collectors/COLLECTORS.md
+1
-1
@@ -1147,7 +1147,7 @@ If you don't see the app/service you'd like to monitor in this list:
1147
1148
- [Traefik](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/traefik/integrations/traefik.md)
1149
1150
-- [Varnish](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/varnish/integrations/varnish.md)
1150
+- [Varnish](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/varnish/integrations/varnish.md)
1151
1152
- [Web server log files](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/weblog/integrations/web_server_log_files.md)
1153
src/go/plugin/go.d/modules/varnish/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/varnish.md
\ No newline at end of file
src/go/plugin/go.d/modules/varnish/integrations/varnish.md
new
+229
@@ -0,0 +1,229 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/varnish/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/varnish/metadata.yaml"
4
+sidebar_label: "Varnish"
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
+# Varnish
12
+
13
+
14
+<img src="https://netdata.cloud/img/varnish.svg" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: varnish
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors Varnish instances, supporting both the open-source Varnish-Cache and the commercial Varnish-Plus.
25
+
26
+It tracks key performance metrics, along with detailed statistics for Backends (VBE) and Storages (SMF, SMA, MSE).
27
+
28
+It relies on the [`varnishstat`](https://varnish-cache.org/docs/trunk/reference/varnishstat.html) CLI tool but avoids directly executing the binary.
29
+Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment.
30
+This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.
31
+
32
+
33
+
34
+
35
+This collector is supported on all platforms.
36
+
37
+This collector only supports collecting metrics from a single instance of this integration.
38
+
39
+
40
+### Default Behavior
41
+
42
+#### Auto-Detection
43
+
44
+This integration doesn't support auto-detection.
45
+
46
+#### Limits
47
+
48
+The default configuration for this integration does not impose any limits on data collection.
49
+
50
+#### Performance Impact
51
+
52
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
53
+
54
+
55
+## Metrics
56
+
57
+Metrics grouped by *scope*.
58
+
59
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
60
+
61
+
62
+
63
+### Per Varnish instance
64
+
65
+These metrics refer to the entire monitored application.
66
+
67
+This scope has no labels.
68
+
69
+Metrics:
70
+
71
+| Metric | Dimensions | Unit |
72
+|:------|:----------|:----|
73
+| varnish.client_session_connections | accepted, dropped | connections/s |
74
+| varnish.client_requests | received | requests/s |
75
+| varnish.cache_hit_ratio_total | hit, miss, hitpass, hitmiss | percent |
76
+| varnish.cache_hit_ratio_delta | hit, miss, hitpass, hitmiss | percent |
77
+| varnish.cache_expired_objects | expired | objects/s |
78
+| varnish.cache_lru_activity | nuked, moved | objects/s |
79
+| varnish.threads | threads | threads |
80
+| varnish.thread_management_activity | created, failed, destroyed, limited | threads/s |
81
+| varnish.thread_queue_len | queue_length | threads |
82
+| varnish.backends_requests | sent | requests/s |
83
+| varnish.esi_parsing_issues | errors, warnings | issues/s |
84
+| varnish.mgmt_process_uptime | uptime | seconds |
85
+| varnish.child_process_uptime | uptime | seconds |
86
+
87
+### Per Backend
88
+
89
+These metrics refer to the Backend (VBE).
90
+
91
+This scope has no labels.
92
+
93
+Metrics:
94
+
95
+| Metric | Dimensions | Unit |
96
+|:------|:----------|:----|
97
+| varnish.backend_data_transfer | req_header, req_body, resp_header, resp_body | bytes/s |
98
+
99
+### Per Storage
100
+
101
+These metrics refer to the Storage (SMA, SMF, MSE).
102
+
103
+This scope has no labels.
104
+
105
+Metrics:
106
+
107
+| Metric | Dimensions | Unit |
108
+|:------|:----------|:----|
109
+| varnish.storage_space_usage | free, used | bytes |
110
+| varnish.storage_allocated_objects | allocated | objects |
111
+
112
+
113
+
114
+## Alerts
115
+
116
+There are no alerts configured by default for this integration.
117
+
118
+
119
+## Setup
120
+
121
+### Prerequisites
122
+
123
+No action required.
124
+
125
+### Configuration
126
+
127
+#### File
128
+
129
+The configuration file name for this integration is `go.d/varnish.conf`.
130
+
131
+
132
+You can edit the configuration file using the `edit-config` script from the
133
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
134
+
135
+```bash
136
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
137
+sudo ./edit-config go.d/varnish.conf
138
+```
139
+#### Options
140
+
141
+The following options can be defined globally: update_every.
142
+
143
+
144
+<details open><summary>Config options</summary>
145
+
146
+| Name | Description | Default | Required |
147
+|:----|:-----------|:-------|:--------:|
148
+| update_every | Data collection frequency. | 10 | no |
149
+| timeout | Timeout for executing the binary, specified in seconds. | 2 | no |
150
+| instance_name | Specifies the name of the Varnish instance to collect metrics from. This corresponds to the `-n` argument used with the [varnishstat](https://varnish-cache.org/docs/trunk/reference/varnishstat.html) command. | | no |
151
+
152
+</details>
153
+
154
+#### Examples
155
+
156
+##### Custom update_every
157
+
158
+Allows you to override the default data collection interval.
159
+
160
+```yaml
161
+jobs:
162
+ - name: varnish
163
+ update_every: 5
164
+
165
+```
166
+
167
+
168
+## Troubleshooting
169
+
170
+### Debug Mode
171
+
172
+**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
173
+
174
+To troubleshoot issues with the `varnish` collector, run the `go.d.plugin` with the debug option enabled. The output
175
+should give you clues as to why the collector isn't working.
176
+
177
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
178
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
179
+
180
+ ```bash
181
+ cd /usr/libexec/netdata/plugins.d/
182
+ ```
183
+
184
+- Switch to the `netdata` user.
185
+
186
+ ```bash
187
+ sudo -u netdata -s
188
+ ```
189
+
190
+- Run the `go.d.plugin` to debug the collector:
191
+
192
+ ```bash
193
+ ./go.d.plugin -d -m varnish
194
+ ```
195
+
196
+### Getting Logs
197
+
198
+If you're encountering problems with the `varnish` collector, follow these steps to retrieve logs and identify potential issues:
199
+
200
+- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
201
+- **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.
202
+
203
+#### System with systemd
204
+
205
+Use the following command to view logs generated since the last Netdata service restart:
206
+
207
+```bash
208
+journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep varnish
209
+```
210
+
211
+#### System without systemd
212
+
213
+Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
214
+
215
+```bash
216
+grep varnish /var/log/netdata/collector.log
217
+```
218
+
219
+**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
220
+
221
+#### Docker Container
222
+
223
+If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
224
+
225
+```bash
226
+docker logs netdata 2>&1 | grep varnish
227
+```
228
+
229
+