summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/varnish
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/varnish')
-rw-r--r--collectors/python.d.plugin/varnish/README.md26
-rw-r--r--collectors/python.d.plugin/varnish/metrics.csv18
2 files changed, 41 insertions, 3 deletions
diff --git a/collectors/python.d.plugin/varnish/README.md b/collectors/python.d.plugin/varnish/README.md
index ebcc00c51..d30a9fb1d 100644
--- a/collectors/python.d.plugin/varnish/README.md
+++ b/collectors/python.d.plugin/varnish/README.md
@@ -4,10 +4,10 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/pyth
sidebar_label: "Varnish Cache"
learn_status: "Published"
learn_topic_type: "References"
-learn_rel_path: "References/Collectors references/Webapps"
+learn_rel_path: "Integrations/Monitor/Webapps"
-->
-# Varnish Cache monitoring with Netdata
+# Varnish Cache collector
Provides HTTP accelerator global, Backends (VBE) and Storages (SMF, SMA, MSE) statistics using `varnishstat` tool.
@@ -63,6 +63,26 @@ instance_name: 'name'
The name of the `varnishd` instance to get logs from. If not specified, the host name is used.
----
+
+### Troubleshooting
+
+To troubleshoot issues with the `varnish` module, run the `python.d.plugin` with the debug option enabled. The
+output will give you the output of the data collection job or error messages on why the collector isn't working.
+
+First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's
+not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the
+plugin's directory, switch to the `netdata` user.
+
+```bash
+cd /usr/libexec/netdata/plugins.d/
+sudo su -s /bin/bash netdata
+```
+
+Now you can manually run the `varnish` module in debug mode:
+
+```bash
+./python.d.plugin varnish debug trace
+```
+
diff --git a/collectors/python.d.plugin/varnish/metrics.csv b/collectors/python.d.plugin/varnish/metrics.csv
new file mode 100644
index 000000000..bafb9fd17
--- /dev/null
+++ b/collectors/python.d.plugin/varnish/metrics.csv
@@ -0,0 +1,18 @@
+metric,scope,dimensions,unit,description,chart_type,labels,plugin,module
+varnish.session_connection,,"accepted, dropped",connections/s,Connections Statistics,line,,python.d.plugin,varnish
+varnish.client_requests,,received,requests/s,Client Requests,line,,python.d.plugin,varnish
+varnish.all_time_hit_rate,,"hit, miss, hitpass",percentage,All History Hit Rate Ratio,stacked,,python.d.plugin,varnish
+varnish.current_poll_hit_rate,,"hit, miss, hitpass",percentage,Current Poll Hit Rate Ratio,stacked,,python.d.plugin,varnish
+varnish.cached_objects_expired,,objects,expired/s,Expired Objects,line,,python.d.plugin,varnish
+varnish.cached_objects_nuked,,objects,nuked/s,Least Recently Used Nuked Objects,line,,python.d.plugin,varnish
+varnish.threads_total,,None,number,Number Of Threads In All Pools,line,,python.d.plugin,varnish
+varnish.threads_statistics,,"created, failed, limited",threads/s,Threads Statistics,line,,python.d.plugin,varnish
+varnish.threads_queue_len,,in queue,requests,Current Queue Length,line,,python.d.plugin,varnish
+varnish.backend_connections,,"successful, unhealthy, reused, closed, recycled, failed",connections/s,Backend Connections Statistics,line,,python.d.plugin,varnish
+varnish.backend_requests,,sent,requests/s,Requests To The Backend,line,,python.d.plugin,varnish
+varnish.esi_statistics,,"errors, warnings",problems/s,ESI Statistics,line,,python.d.plugin,varnish
+varnish.memory_usage,,"free, allocated",MiB,Memory Usage,stacked,,python.d.plugin,varnish
+varnish.uptime,,uptime,seconds,Uptime,line,,python.d.plugin,varnish
+varnish.backend,Backend,"header, body",kilobits/s,Backend {backend_name},area,,python.d.plugin,varnish
+varnish.storage_usage,Storage,"free, allocated",KiB,Storage {storage_name} Usage,stacked,,python.d.plugin,varnish
+varnish.storage_alloc_objs,Storage,allocated,objects,Storage {storage_name} Allocated Objects,line,,python.d.plugin,varnish