diff options
author | nicolargo <nicolas@nicolargo.com> | 2023-01-30 16:51:52 +0100 |
---|---|---|
committer | nicolargo <nicolas@nicolargo.com> | 2023-01-30 16:51:52 +0100 |
commit | 7d2462075cb18bad8bb5f6b559ad4edd588881a4 (patch) | |
tree | 21af5020873b3ec4cc4726c962052405c86d539c /docs | |
parent | f67a5f2b20e0203727dedb970625e36f3786288e (diff) |
Update documentation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api.rst | 893 | ||||
-rw-r--r-- | docs/gw/mongodb.rst | 2 | ||||
-rw-r--r-- | docs/man/glances.1 | 2 |
3 files changed, 531 insertions, 366 deletions
diff --git a/docs/api.rst b/docs/api.rst index 443af5f8..e67858a9 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -66,18 +66,18 @@ GET alert Get plugin stats:: # curl http://localhost:61208/api/3/alert - [[1674381772.0, + [[1675093869.0, -1, "WARNING", - "CPU_TOTAL", - 78.1, - 78.1, - 78.1, - 78.1, + "MEM", + 82.83225325565277, + 82.83225325565277, + 82.83225325565277, + 82.83225325565277, 1, [], "", - "cpu_percent"]] + "memory_percent"]] GET amps -------- @@ -93,7 +93,7 @@ Get plugin stats:: "refresh": 3.0, "regex": True, "result": None, - "timer": 1.1751177310943604}, + "timer": 0.6673910617828369}, {"count": 0, "countmax": 20.0, "countmin": None, @@ -102,7 +102,7 @@ Get plugin stats:: "refresh": 3.0, "regex": True, "result": None, - "timer": 1.1748502254486084}] + "timer": 0.667231559753418}] Get a specific field:: @@ -120,7 +120,7 @@ Get a specific item when field matchs the given value:: "refresh": 3.0, "regex": True, "result": None, - "timer": 1.1751177310943604}]} + "timer": 0.6673910617828369}]} GET core -------- @@ -150,19 +150,19 @@ Get plugin stats:: "ctx_switches": 0, "guest": 0.0, "guest_nice": 0.0, - "idle": 14.7, + "idle": 67.7, "interrupts": 0, - "iowait": 7.4, + "iowait": 0.2, "irq": 0.0, "nice": 0.0, "soft_interrupts": 0, - "softirq": 0.9, + "softirq": 0.0, "steal": 0.0, "syscalls": 0, - "system": 19.4, + "system": 6.3, "time_since_update": 1, - "total": 78.1, - "user": 57.6} + "total": 31.2, + "user": 25.7} Fields descriptions: @@ -185,7 +185,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/3/cpu/total - {"total": 78.1} + {"total": 31.2} GET diskio ---------- @@ -230,11 +230,56 @@ GET docker Get plugin stats:: # curl http://localhost:61208/api/3/docker - {"containers": [{"Command": ["/portainer"], + {"containers": [{"Command": ["docker-entrypoint.sh", "mongod"], + "Id": "c3a1bb27858df965e1c524c6ef33c0fd26d765cae5bcd90fbe9e662b703a52aa", + "Image": ["mongo:latest"], + "Status": "running", + "Uptime": "6 hours", + "cpu": {"total": 0.0}, + "cpu_percent": 0.0, + "io": {"cumulative_ior": 0, + "cumulative_iow": 548864, + "time_since_update": 1}, + "io_r": None, + "io_w": None, + "key": "name", + "memory": {"cache": None, + "limit": 7836196864, + "max_usage": None, + "rss": None, + "usage": 121462784}, + "memory_usage": 121462784, + "name": "docker-mongo_mongo_1", + "network": {"cumulative_rx": 1546897, + "cumulative_tx": 943210, + "time_since_update": 1}, + "network_rx": None, + "network_tx": None}, + {"Command": ["tini", + "--", + "/docker-entrypoint.sh", + "mongo-express"], + "Id": "5aa8f03d6027d00244cf5ce5f4ffe616fd8a31e95ff7091ca02b8d99c00b276c", + "Image": ["mongo-express:latest"], + "Status": "running", + "Uptime": "6 hours", + "cpu": {"total": 0.0}, + "cpu_percent": 0.0, + "io": {}, + "io_r": None, + "io_w": None, + "key": "name", + "memory": {}, + "memory_usage": None, + "name": "docker-mongo_mongo-express_1", + "network": {}, + "network_rx": None, + "network_tx": None}, + {"Command": ["/portainer"], "Id": "3abd51c615968482d9ccff5afc629f267f6dda113ed68b75b432615fae3b49fb", "Image": ["portainer/portainer-ce:2.9.3"], "Status": "running", - "Uptime": "23 hours", + "Uptime": "1 weeks", "cpu": {"total": 0.0}, "cpu_percent": 0.0, "io": {}, @@ -285,13 +330,13 @@ Get plugin stats:: # curl http://localhost:61208/api/3/fs [{"device_name": "/dev/mapper/ubuntu--gnome--vg-root", - "free": 63000883200, + "free": 61967261696, "fs_type": "ext4", "key": "mnt_point", "mnt_point": "/", - "percent": 72.7, + "percent": 73.2, "size": 243334156288, - "used": 167945818112}, + "used": 168979439616}, {"device_name": "zsfpool", "free": 41811968, "fs_type": "zfs", @@ -310,13 +355,13 @@ Get a specific item when field matchs the given value:: # curl http://localhost:61208/api/3/fs/mnt_point// {"/": [{"device_name": "/dev/mapper/ubuntu--gnome--vg-root", - "free": 63000883200, + "free": 61967261696, "fs_type": "ext4", "key": "mnt_point", "mnt_point": "/", - "percent": 72.7, + "percent": 73.2, "size": 243334156288, - "used": 167945818112}]} + "used": 168979439616}]} GET ip ------ @@ -324,17 +369,17 @@ GET ip Get plugin stats:: # curl http://localhost:61208/api/3/ip - {"address": "192.168.0.32", - "gateway": "192.168.0.254", + {"address": "192.168.1.14", + "gateway": "192.168.1.1", "mask": "255.255.255.0", "mask_cidr": 24, - "public_address": "91.166.228.228", + "public_address": "109.210.93.150", "public_info_human": ""} Get a specific field:: # curl http://localhost:61208/api/3/ip/gateway - {"gateway": "192.168.0.254"} + {"gateway": "192.168.1.1"} GET load -------- @@ -342,10 +387,7 @@ GET load Get plugin stats:: # curl http://localhost:61208/api/3/load - {"cpucore": 4, - "min1": 2.79248046875, - "min15": 0.6044921875, - "min5": 1.24951171875} + {"cpucore": 4, "min1": 1.9677734375, "min15": 1.2421875, "min5": 1.4140625} Fields descriptions: @@ -357,7 +399,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/3/load/min1 - {"min1": 2.79248046875} + {"min1": 1.9677734375} GET mem ------- @@ -365,16 +407,16 @@ GET mem Get plugin stats:: # curl http://localhost:61208/api/3/mem - {"active": 3232829440, - "available": 2574643200, - "buffers": 482086912, - "cached": 2828992512, - "free": 2574643200, - "inactive": 3375968256, - "percent": 67.1, - "shared": 610131968, + {"active": 2301452288, + "available": 1345298432, + "buffers": 91602944, + "cached": 1984524288, + "free": 1345298432, + "inactive": 4274671616, + "percent": 82.8, + "shared": 603455488, "total": 7836196864, - "used": 5261553664} + "used": 6490898432} Fields descriptions: @@ -401,13 +443,13 @@ GET memswap Get plugin stats:: # curl http://localhost:61208/api/3/memswap - {"free": 6393114624, - "percent": 20.9, - "sin": 1016889344, - "sout": 2570014720, + {"free": 5992534016, + "percent": 25.9, + "sin": 2847645696, + "sout": 5540925440, "time_since_update": 1, "total": 8082419712, - "used": 1689305088} + "used": 2089885696} Fields descriptions: @@ -431,29 +473,29 @@ Get plugin stats:: # curl http://localhost:61208/api/3/network [{"alias": None, - "cumulative_cx": 104446528, - "cumulative_rx": 52223264, - "cumulative_tx": 52223264, - "cx": 2384, + "cumulative_cx": 184715152, + "cumulative_rx": 92357576, + "cumulative_tx": 92357576, + "cx": 8458, "interface_name": "lo", "is_up": True, "key": "interface_name", - "rx": 1192, + "rx": 4229, "speed": 0, "time_since_update": 1, - "tx": 1192}, + "tx": 4229}, {"alias": None, - "cumulative_cx": 12191054510, - "cumulative_rx": 11933885504, - "cumulative_tx": 257169006, - "cx": 29422, + "cumulative_cx": 13554125250, + "cumulative_rx": 13227076404, + "cumulative_tx": 327048846, + "cx": 25901, "interface_name": "wlp2s0", "is_up": True, "key": "interface_name", - "rx": 22777, + "rx": 20009, "speed": 0, "time_since_update": 1, - "tx": 6645}] + "tx": 5892}] Fields descriptions: @@ -478,25 +520,28 @@ Get a specific field:: "br-119e6ee04e05", "docker0", "br-87386b77b676", - "mpqemubr0", "vethf503072", - "tap-1e376645a40"]} + "mpqemubr0", + "tap-1e376645a40", + "br-ef0a06c4e10f", + "veth9a140b2", + "veth9ed6876"]} Get a specific item when field matchs the given value:: # curl http://localhost:61208/api/3/network/interface_name/lo {"lo": [{"alias": None, - "cumulative_cx": 104446528, - "cumulative_rx": 52223264, - "cumulative_tx": 52223264, - "cx": 2384, + "cumulative_cx": 184715152, + "cumulative_rx": 92357576, + "cumulative_tx": 92357576, + "cx": 8458, "interface_name": "lo", "is_up": True, "key": "interface_name", - "rx": 1192, + "rx": 4229, "speed": 0, "time_since_update": 1, - "tx": 1192}]} + "tx": 4229}]} GET now ------- @@ -504,7 +549,7 @@ GET now Get plugin stats:: # curl http://localhost:61208/api/3/now - "2023-01-22 11:02:51 CET" + "2023-01-30 16:51:08 CET" GET percpu ---------- @@ -515,29 +560,29 @@ Get plugin stats:: [{"cpu_number": 0, "guest": 0.0, "guest_nice": 0.0, - "idle": 20.3, - "iowait": 12.3, + "idle": 67.0, + "iowait": 0.0, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 24.6, - "total": 79.7, - "user": 42.8}, + "system": 3.0, + "total": 33.0, + "user": 11.0}, {"cpu_number": 1, "guest": 0.0, "guest_nice": 0.0, - "idle": 16.4, - "iowait": 6.0, + "idle": 41.0, + "iowait": 0.0, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 12.7, - "total": 83.6, - "user": 64.9}] + "system": 0.0, + "total": 59.0, + "user": 41.0}] Get a specific field:: @@ -551,30 +596,30 @@ Get plugin stats:: # curl http://localhost:61208/api/3/ports [{"description": "DefaultGateway", - "host": "192.168.0.254", + "host": "192.168.1.1", "indice": "port_0", "port": 0, "refresh": 30, "rtt_warning": None, - "status": 0.01009, + "status": 0.006011, "timeout": 3}] Get a specific field:: # curl http://localhost:61208/api/3/ports/host - {"host": ["192.168.0.254"]} + {"host": ["192.168.1.1"]} Get a specific item when field matchs the given value:: - # curl http://localhost:61208/api/3/ports/host/192.168.0.254 - {"192.168.0.254": [{"description": "DefaultGateway", - "host": "192.168.0.254", - "indice": "port_0", - "port": 0, - "refresh": 30, - "rtt_warning": None, - "status": 0.01009, - "timeout": 3}]} + # curl http://localhost:61208/api/3/ports/host/192.168.1.1 + {"192.168.1.1": [{"description": "DefaultGateway", + "host": "192.168.1.1", + "indice": "port_0", + "port": 0, + "refresh": 30, + "rtt_warning": None, + "status": 0.006011, + "timeout": 3}]} GET processcount ---------------- @@ -582,12 +627,12 @@ GET processcount Get plugin stats:: # curl http://localhost:61208/api/3/processcount - {"pid_max": 0, "running": 2, "sleeping": 311, "thread": 1523, "total": 386} + {"pid_max": 0, "running": 1, "sleeping": 332, "thread": 1844, "total": 463} Get a specific field:: # curl http://localhost:61208/api/3/processcount/total - {"total": 386} + {"total": 463} GET processlist --------------- @@ -595,51 +640,66 @@ GET processlist Get plugin stats:: # curl http://localhost:61208/api/3/processlist - [{"cmdline": ["/snap/firefox/2263/usr/lib/firefox/firefox"], + [{"cmdline": ["/snap/multipass/8140/usr/bin/qemu-system-x86_64", + "--enable-kvm", + "-cpu", + "host", + "-nic", + "tap,ifname=tap-1e376645a40,script=no,downscript=no,model=virtio-net-pci,mac=52:54:00:05:05:17", + "-device", + "virtio-scsi-pci,id=scsi0", + "-drive", + "file=/var/snap/multipass/common/data/multipassd/vault/instances/primary/ubuntu-22.04-server-cloudimg-amd64.img,if=none,format=qcow2,discard=unmap,id=hda", + "-device", + "scsi-hd,drive=hda,bus=scsi0.0", + "-smp", + "1", + "-m", + "1024M", + "-qmp", + "stdio", + "-chardev", + "null,id=char0", + "-serial", + "chardev:char0", + "-nographic", + "-cdrom", + "/var/snap/multipass/common/data/multipassd/vault/instances/primary/cloud-init-config.iso", + "-loadvm", + "suspend", + "-machine", + "pc-i440fx-focal"], "cpu_percent": 0.0, - "cpu_times": [2122.86, 658.23, 1239.16, 210.94, 0.0], - "gids": [1000, 1000, 1000], - "io_counters": [1674662912, 3749654528, 0, 0, 0], + "cpu_times": [15.8, 8.88, 0.0, 0.0, 0.0], + "gids": [0, 0, 0], + "io_counters": [0, 0, 0, 0, 0], "key": "pid", - "memory_info": [584667136, 21991870464, 132120576, 647168, 0, 1149304832, 0], - "memory_percent": 7.461108317556428, - "name": "firefox", + "memory_info": [508997632, 2645762048, 4816896, 5414912, 0, 1256706048, 0], + "memory_percent": 6.49546764628092, + "name": "qemu-system-x86_64", "nice": 0, - "num_threads": 146, - "pid": 5040, + "num_threads": 6, + "pid": 165054, "status": "S", "time_since_update": 1, - "username": "nicolargo"}, - {"cmdline": ["/snap/firefox/2263/usr/lib/firefox/firefox", - "-contentproc", - "-childID", - "1", - "-isForBrowser", - "-prefsLen", - "32129", - "-prefMapSize", - "236410", - "-jsInitLen", - "246772", - "-parentBuildID", - "20230104235612", - "-appDir", - "/snap/firefox/2263/usr/lib/firefox/browser", - "{152fde2c-5751-4719-9edb-ff980730fbac}", - "5040", - "true", - "tab"], + "username": "root"}, + {"cmdline": ["/usr/share/code/code", + "--ms-enable-electron-run-as-node", + "/home/nicolargo/.vscode/extensions/ms-python.vscode-pylance-2023.1.40/dist/server.bundle.js", + "--cancellationReceive=file:9e8ad4331c82252be52c9e10943b0d98e4704856e6", + "--node-ipc", + "--clientProcessId=152377"], "cpu_percent": 0.0, - "cpu_times": [467.87, 83.56, 0.0, 0.0, 0.0], + "cpu_times": [292.89, 21.42, 1.52, 0.16, 0.0], "gids": [1000, 1000, 1000], - "io_counters": [213443584, 0, 0, 0, 0], + "io_counters": [103936000, 573440, 0, 0, 0], "key": "pid", - "memory_info": [397238272, 3228049408, 70422528, 647168, 0, 639614976, 0], - "memory_percent": 5.069273767545818, - "name": "WebExtensions", + "memory_info": [444641280, 49868906496, 31858688, 112656384, 0, 718778368, 0], + "memory_percent": 5.674197416385889, + "name": "code", "nice": 0, - "num_threads": 20, - "pid": 5246, + "num_threads": 13, + "pid": 152522, "status": "S", "time_since_update": 1, "username": "nicolargo"}] @@ -647,211 +707,229 @@ Get plugin stats:: Get a specific field:: # curl http://localhost:61208/api/3/processlist/pid - {"pid": [5040, + {"pid": [165054, + 152522, + 5040, 5246, - 5369, 5752, - 10873, - 5365, - 10653, - 90446, + 5369, 4150, - 10724, - 109138, - 4519, + 10653, + 173071, + 5365, + 173932, + 171502, + 166223, + 180530, + 152377, + 137271, + 176436, + 182287, + 173116, + 184024, + 177108, + 151269, + 178661, + 173149, + 10547, + 168824, 422, - 109284, - 95798, - 22179, - 11307, - 36722, - 110258, 5261, - 62850, - 10547, - 110317, + 185474, 10709, - 109762, - 110036, - 109882, - 10612, + 186130, + 185886, + 185571, 6074, - 96478, + 10612, + 171875, + 178970, + 168735, + 178475, 42687, + 168734, + 187074, 4035, - 110285, + 62850, 2512, - 11033, - 1672, - 4473, - 5179, - 6020, + 95798, 10732, - 6022, - 4585, + 4473, 4544, - 10632, - 23231, - 23230, - 11251, - 4248, - 4413, - 11252, - 3955, - 4223, 2721, - 4932, + 4585, 1816, - 90918, - 1635, + 152506, + 10632, + 4932, + 4413, + 4248, + 1672, 14455, - 10848, - 43005, - 90973, + 3955, + 14458, + 6020, + 5179, + 164782, + 4325, 4332, - 4263, 4625, - 2239, - 1806, - 4325, - 14458, - 1, - 96102, + 1635, 4331, - 4182, - 102364, - 2701, - 91003, + 43005, + 6022, + 4445, + 160043, + 186352, + 4223, + 4352, + 4659, + 4330, + 156821, + 1, + 129101, + 129097, + 2239, + 4263, 1681, + 1660, + 4561, + 156833, + 178639, + 129087, + 178867, 4214, + 4182, + 1682, 1876, - 1655, - 2640, - 2455, + 3944, + 3968, + 4339, 10557, - 1885, - 4561, - 1660, - 4445, - 1442, 4130, - 4261, - 4339, - 4352, - 3944, - 1682, + 1442, 3934, - 4485, - 10558, - 4659, - 4328, - 4330, - 4137, 4327, - 4334, 4233, + 96102, + 1655, + 4137, 1777, - 3351, + 4261, + 4334, + 1634, + 17189, + 4485, + 4328, + 10558, 1873, + 3351, + 17205, + 1617, 59511, 2179, - 1617, - 4050, - 17205, - 4192, - 4348, - 4166, 4392, - 3700, - 1634, + 3971, + 4166, 3966, - 17189, - 4573, 4155, - 3968, - 3971, + 4348, + 4573, + 4178, + 4050, + 4452, + 4192, + 117714, + 4524, 1675, - 4347, - 4329, + 4229, + 6095, 1661, + 4347, 4377, - 6095, - 4229, - 1666, - 5299, - 2683, - 4314, 1673, + 5299, + 152553, 1643, - 1676, - 46760, - 10911, - 4452, - 468, + 4329, + 42986, 4335, + 160053, 4324, - 4524, - 2684, - 4443, + 4314, + 468, 4173, + 4212, 4337, + 4443, 4201, - 4212, - 42986, - 4178, + 3976, + 129099, + 1676, + 4045, + 1666, + 1885, 1631, 1670, 3952, - 4045, - 3976, 1443, - 3701, - 3953, - 1626, 4119, - 4162, + 9703, + 1626, + 129100, 1646, + 3953, + 3700, 2020, + 4162, + 178850, 1441, + 3701, + 178609, 1633, - 3354, - 9703, + 178617, + 178843, 49191, - 110201, - 14505, + 165074, + 186999, 49179, - 10591, - 1449, + 14505, 4579, 1685, + 1449, 1450, - 3774, + 3354, + 10591, + 2472, + 164891, + 49182, + 160052, + 1618, + 1803, + 1804, 10560, 49194, - 2472, 42952, - 1804, - 1803, + 184504, + 187073, + 42969, 42937, 42964, - 42969, - 49182, - 3945, - 1618, - 110284, - 3707, 4018, 4323, - 4820, 2480, - 104481, - 1695, + 3707, + 4820, + 3945, 2503, 2475, - 2485, + 181945, + 1695, 1447, + 2485, 1628, 49185, + 178889, 2, 3, 4, @@ -998,66 +1076,153 @@ Get a specific field:: 62923, 62924, 62925, - 78135, - 78136, - 78138, - 90658, - 90659, - 90662, - 90663, - 90665, - 90718, - 90731, - 107066, - 107228, - 107746, - 107747, - 108008, - 108340, - 108486, - 108619, - 108834, - 108931, - 109106, - 109124, - 109329, - 110081, - 110221, - 110262, - 110263, - 110268, - 110269, - 110311, - 110375, - 110376, - 110377, - 110378, - 110379]} + 156446, + 156447, + 156448, + 165059, + 165063, + 171811, + 174709, + 181685, + 182152, + 182465, + 183251, + 183453, + 184060, + 184494, + 184765, + 185058, + 185059, + 185233, + 185234, + 185575, + 185576, + 185577, + 185578, + 185753, + 185754, + 185793, + 186114, + 186175, + 186214, + 186242, + 186243, + 186244, + 186245, + 186246, + 186247, + 186248, + 186249, + 186250, + 186251, + 186252, + 186253, + 186254, + 186255, + 186256, + 186257, + 186258, + 186259, + 186260, + 186261, + 186262, + 186263, + 186264, + 186265, + 186266, + 186267, + 186268, + 186269, + 186270, + 186271, + 186272, + 186273, + 186274, + 186275, + 186276, + 186277, + 186278, + 186279, + 186280, + 186281, + 186282, + 186283, + 186284, + 186285, + 186286, + 186287, + 186288, + 186289, + 186290, + 186291, + 186292, + 186293, + 186294, + 186295, + 186296, + 186297, + 186298, + 186299, + 186300, + 186301, + 186302, + 186303, + 186304, + 186305, + 186306]} Get a specific item when field matchs the given value:: - # curl http://localhost:61208/api/3/processlist/pid/5040 - {"5040": [{"cmdline": ["/snap/firefox/2263/usr/lib/firefox/firefox"], - "cpu_percent": 0.0, - "cpu_times": [2122.86, 658.23, 1239.16, 210.94, 0.0], - "gids": [1000, 1000, 1000], - "io_counters": [1674662912, 3749654528, 0, 0, 0], - "key": "pid", - "memory_info": [584667136, - 21991870464, - 132120576, - 647168, - 0, - 1149304832, - 0], - "memory_percent": 7.461108317556428, - "name": "firefox", - "nice": 0, - "num_threads": 146, - "pid": 5040, - "status": "S", - "time_since_update": 1, - "username": "nicolargo"}]} + # curl http://localhost:61208/api/3/processlist/pid/165054 + {"165054": [{"cmdline": ["/snap/multipass/8140/usr/bin/qemu-system-x86_64", + "--enable-kvm", + "-cpu", + "host", + "-nic", + "tap,ifname=tap-1e376645a40,script=no,downscript=no,model=virtio-net-pci,mac=52:54:00:05:05:17", + "-device", + "virtio-scsi-pci,id=scsi0", + "-drive", + "file=/var/snap/multipass/common/data/multipassd/vault/instances/primary/ubuntu-22.04-server-cloudimg-amd64.img,if=none,format=qcow2,discard=unmap,id=hda", + "-device", + "scsi-hd,drive=hda,bus=scsi0.0", + "-smp", + "1", + "-m", + "1024M", + "-qmp", + "stdio", + "-chardev", + "null,id=char0", + "-serial", + "chardev:char0", + "-nographic", + "-cdrom", + "/var/snap/multipass/common/data/multipassd/vault/instan |