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.md62
1 files changed, 33 insertions, 29 deletions
diff --git a/collectors/python.d.plugin/traefik/README.md b/collectors/python.d.plugin/traefik/README.md
index 251cdf2e4..cf30a82a4 100644
--- a/collectors/python.d.plugin/traefik/README.md
+++ b/collectors/python.d.plugin/traefik/README.md
@@ -1,7 +1,10 @@
<!--
title: "Traefik monitoring with Netdata"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/traefik/README.md
-sidebar_label: "Traefik"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/traefik/README.md"
+sidebar_label: "traefik-python.d.plugin"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "References/Collectors references/Webapps"
-->
# Traefik monitoring with Netdata
@@ -10,45 +13,46 @@ Uses the `health` API to provide statistics.
It produces:
-1. **Responses** by statuses
+1. **Responses** by statuses
- - success (1xx, 2xx, 304)
- - error (5xx)
- - redirect (3xx except 304)
- - bad (4xx)
- - other (all other responses)
+ - success (1xx, 2xx, 304)
+ - error (5xx)
+ - redirect (3xx except 304)
+ - bad (4xx)
+ - other (all other responses)
-2. **Responses** by codes
+2. **Responses** by codes
- - 2xx (successful)
- - 5xx (internal server errors)
- - 3xx (redirect)
- - 4xx (bad)
- - 1xx (informational)
- - other (non-standart responses)
+ - 2xx (successful)
+ - 5xx (internal server errors)
+ - 3xx (redirect)
+ - 4xx (bad)
+ - 1xx (informational)
+ - other (non-standart responses)
-3. **Detailed Response Codes** requests/s (number of responses for each response code family individually)
+3. **Detailed Response Codes** requests/s (number of responses for each response code family individually)
-4. **Requests**/s
+4. **Requests**/s
- - request statistics
+ - request statistics
-5. **Total response time**
+5. **Total response time**
- - sum of all response time
+ - sum of all response time
-6. **Average response time**
+6. **Average response time**
-7. **Average response time per iteration**
+7. **Average response time per iteration**
-8. **Uptime**
+8. **Uptime**
- - Traefik server uptime
+ - Traefik server uptime
## Configuration
-Edit the `python.d/traefik.conf` configuration file using `edit-config` from the Netdata [config
-directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+Edit the `python.d/traefik.conf` configuration file using `edit-config` from the
+Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically
+at `/etc/netdata`.
```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different
@@ -60,11 +64,11 @@ Needs only `url` to server's `health`
Here is an example for local server:
```yaml
-update_every : 1
-priority : 60000
+update_every: 1
+priority: 60000
local:
- url : 'http://localhost:8080/health'
+ url: 'http://localhost:8080/health'
```
Without configuration, module attempts to connect to `http://localhost:8080/health`.