summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/traefik/README.md
blob: 251cdf2e4949f16dd37812e0c96aa0303efb3492 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<!--
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"
-->

# Traefik monitoring with Netdata

Uses the `health` API to provide statistics.

It produces:

1.  **Responses** by statuses

    -   success (1xx, 2xx, 304)
    -   error (5xx)
    -   redirect (3xx except 304)
    -   bad (4xx)
    -   other (all other responses)

2.  **Responses** by codes

    -   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)

4.  **Requests**/s

    -   request statistics

5.  **Total response time**

    -   sum of all response time

6.  **Average response time**

7.  **Average response time per iteration**

8.  **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`.

```bash
cd /etc/netdata   # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/traefik.conf
```

Needs only `url` to server's `health`

Here is an example for local server:

```yaml
update_every : 1
priority     : 60000

local:
  url     : 'http://localhost:8080/health'
```

Without configuration, module attempts to connect to `http://localhost:8080/health`.

---