summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/traefik
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/traefik')
-rw-r--r--collectors/python.d.plugin/traefik/README.md26
-rw-r--r--collectors/python.d.plugin/traefik/metrics.csv9
2 files changed, 32 insertions, 3 deletions
diff --git a/collectors/python.d.plugin/traefik/README.md b/collectors/python.d.plugin/traefik/README.md
index cf30a82a4..40ed24f04 100644
--- a/collectors/python.d.plugin/traefik/README.md
+++ b/collectors/python.d.plugin/traefik/README.md
@@ -4,10 +4,10 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/pyth
sidebar_label: "traefik-python.d.plugin"
learn_status: "Published"
learn_topic_type: "References"
-learn_rel_path: "References/Collectors references/Webapps"
+learn_rel_path: "Integrations/Monitor/Webapps"
-->
-# Traefik monitoring with Netdata
+# Traefik collector
Uses the `health` API to provide statistics.
@@ -73,6 +73,26 @@ local:
Without configuration, module attempts to connect to `http://localhost:8080/health`.
----
+
+### Troubleshooting
+
+To troubleshoot issues with the `traefik` 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 `traefik` module in debug mode:
+
+```bash
+./python.d.plugin traefik debug trace
+```
+
diff --git a/collectors/python.d.plugin/traefik/metrics.csv b/collectors/python.d.plugin/traefik/metrics.csv
new file mode 100644
index 000000000..77e1c2949
--- /dev/null
+++ b/collectors/python.d.plugin/traefik/metrics.csv
@@ -0,0 +1,9 @@
+metric,scope,dimensions,unit,description,chart_type,labels,plugin,module
+traefik.response_statuses,,"success, error, redirect, bad, other",requests/s,Response statuses,stacked,,python.d.plugin,traefik
+traefik.response_codes,,"2xx, 5xx, 3xx, 4xx, 1xx, other",requests/s,Responses by codes,stacked,,python.d.plugin,traefik
+traefik.detailed_response_codes,,a dimension for each response code family,requests/s,Detailed response codes,stacked,,python.d.plugin,traefik
+traefik.requests,,requests,requests/s,Requests,line,,python.d.plugin,traefik
+traefik.total_response_time,,response,seconds,Total response time,line,,python.d.plugin,traefik
+traefik.average_response_time,,response,milliseconds,Average response time,line,,python.d.plugin,traefik
+traefik.average_response_time_per_iteration,,response,milliseconds,Average response time per iteration,line,,python.d.plugin,traefik
+traefik.uptime,,uptime,seconds,Uptime,line,,python.d.plugin,traefik