nginx_plus: python.d readme update
lgz committed
Jan 19, 2018 at 16:43 UTC
a3252eafeeabb73ce31dce4e3d52d2de2d84fcbd
1 file changed
+117
python.d/README.md
+117
@@ -1258,6 +1258,123 @@ Without configuration, module attempts to connect to `http://localhost/stub_stat
1258
1259
---
1260
1261
+# nginx_plus
1262
+
1263
+This module will monitor one or more nginx_plus servers depending on configuration.
1264
+Servers can be either local or remote.
1265
+
1266
+Example nginx_plus configuration can be found in 'python.d/nginx_plus.conf'
1267
+
1268
+It produces following charts:
1269
+
1270
+1. **Requests total** in requests/s
1271
+ * total
1272
+
1273
+2. **Requests current** in requests
1274
+ * current
1275
+
1276
+3. **Connection Statistics** in connections/s
1277
+ * accepted
1278
+ * dropped
1279
+
1280
+4. **Workers Statistics** in workers
1281
+ * idle
1282
+ * active
1283
+
1284
+5. **SSL Handshakes** in handshakes/s
1285
+ * successful
1286
+ * failed
1287
+
1288
+6. **SSL Session Reuses** in sessions/s
1289
+ * reused
1290
+
1291
+7. **SSL Memory Usage** in percent
1292
+ * usage
1293
+
1294
+8. **Processes** in processes
1295
+ * respawned
1296
+
1297
+For every server zone:
1298
+
1299
+1. **Processing** in requests
1300
+ * processing
1301
+
1302
+2. **Requests** in requests/s
1303
+ * requests
1304
+
1305
+3. **Responses** in requests/s
1306
+ * 1xx
1307
+ * 2xx
1308
+ * 3xx
1309
+ * 4xx
1310
+ * 5xx
1311
+
1312
+4. **Traffic** in kilobits/s
1313
+ * received
1314
+ * sent
1315
+
1316
+For every upstream:
1317
+
1318
+1. **Peers Requests** in requests/s
1319
+ * peer name (dimension per peer)
1320
+
1321
+2. **All Peers Responses** in responses/s
1322
+ * 1xx
1323
+ * 2xx
1324
+ * 3xx
1325
+ * 4xx
1326
+ * 5xx
1327
+
1328
+3. **Peer Responses** in requests/s (for every peer)
1329
+ * 1xx
1330
+ * 2xx
1331
+ * 3xx
1332
+ * 4xx
1333
+ * 5xx
1334
+
1335
+4. **Peers Connections** in active
1336
+ * peer name (dimension per peer)
1337
+
1338
+5. **Peers Connections Usage** in percent
1339
+ * peer name (dimension per peer)
1340
+
1341
+6. **All Peers Traffic** in kilobits/s
1342
+ * received
1343
+ * sent
1344
+
1345
+7. **Peer Traffic** in kilobits/s (for every peer)
1346
+ * received
1347
+ * sent
1348
+
1349
+8. **Peer Timings** in ms (for every peer)
1350
+ * header
1351
+ * response
1352
+
1353
+9. **Memory Usage** in percent
1354
+ * usage
1355
+
1356
+10. **Peers Status** in state
1357
+ * peer name (dimension per peer)
1358
+
1359
+11. **Peers Total Downtime** in seconds
1360
+ * peer name (dimension per peer)
1361
+
1362
+
1363
+### configuration
1364
+
1365
+Needs only `url` to server's `status`
1366
+
1367
+Here is an example for local server:
1368
+
1369
+```yaml
1370
+local:
1371
+ url : 'http://localhost/status'
1372
+```
1373
+
1374
+Without configuration, module fail to start.
1375
+
1376
+---
1377
+
1378
# nsd
1379
1380
Module uses the `nsd-control stats_noreset` command to provide `nsd` statistics.