summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/nginx_plus/README.md
blob: 489ac9c2a367ba9284c2780a30b00bd0883f6e86 (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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!--
title: "NGINX Plus monitoring with Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/nginx_plus/README.md
sidebar_label: "NGINX Plus"
-->

# NGINX Plus monitoring with Netdata

Monitors one or more NGINX Plus servers depending on configuration. Servers can be either local or remote.

Example nginx_plus configuration can be found in 'python.d/nginx_plus.conf'

It produces following charts:

1.  **Requests total** in requests/s

    -   total

2.  **Requests current** in requests

    -   current

3.  **Connection Statistics** in connections/s

    -   accepted
    -   dropped

4.  **Workers Statistics** in workers

    -   idle
    -   active

5.  **SSL Handshakes** in handshakes/s

    -   successful
    -   failed

6.  **SSL Session Reuses** in sessions/s

    -   reused

7.  **SSL Memory Usage** in percent

    -   usage

8.  **Processes** in processes

    -   respawned

For every server zone:

1.  **Processing** in requests

-   processing

2.  **Requests** in requests/s

    -   requests

3.  **Responses** in requests/s

    -   1xx
    -   2xx
    -   3xx
    -   4xx
    -   5xx

4.  **Traffic** in kilobits/s

    -   received
    -   sent

For every upstream:

1.  **Peers Requests** in requests/s

    -   peer name (dimension per peer)

2.  **All Peers Responses** in responses/s

    -   1xx
    -   2xx
    -   3xx
    -   4xx
    -   5xx

3.  **Peer Responses** in requests/s (for every peer)

    -   1xx
    -   2xx
    -   3xx
    -   4xx
    -   5xx

4.  **Peers Connections** in active

    -   peer name (dimension per peer)

5.  **Peers Connections Usage** in percent

    -   peer name (dimension per peer)

6.  **All Peers Traffic** in KB

    -   received
    -   sent

7.  **Peer Traffic** in KB/s (for every peer)

    -   received
    -   sent

8.  **Peer Timings** in ms (for every peer)

    -   header
    -   response

9.  **Memory Usage** in percent

    -   usage

10. **Peers Status** in state

    -   peer name (dimension per peer)

11. **Peers Total Downtime** in seconds

    -   peer name (dimension per peer)

For every cache:

1.  **Traffic** in KB

    -   served
    -   written
    -   bypass

2.  **Memory Usage** in percent

    -   usage

## Configuration

Edit the `python.d/nginx_plus.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/nginx_plus.conf
```

Needs only `url` to server's `status`.

Here is an example for a local server:

```yaml
local:
  url     : 'http://localhost/status'
```

Without configuration, module fail to start.

---