diff options
author | nicolargo <nicolas@nicolargo.com> | 2023-05-20 16:46:56 +0200 |
---|---|---|
committer | nicolargo <nicolas@nicolargo.com> | 2023-05-20 16:46:56 +0200 |
commit | f360404a3c238e5fd1dc4606c9f88ba5d10d25d3 (patch) | |
tree | 73acf57271d1e082bcecf377c0434095227a9f86 /docs/api.rst | |
parent | ac4da6fd5b7097c7b66d5572bcb4e470971aee35 (diff) |
version 3.4.0.3
Diffstat (limited to 'docs/api.rst')
-rw-r--r-- | docs/api.rst | 738 |
1 files changed, 396 insertions, 342 deletions
diff --git a/docs/api.rst b/docs/api.rst index b87e7f56..b68312a1 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -60,6 +60,25 @@ Get the plugins list:: "uptime", "wifi"] +GET alert +--------- + +Get plugin stats:: + + # curl http://localhost:61208/api/3/alert + [[1684593857.0, + -1, + "WARNING", + "MEM", + 74.95383222581204, + 74.95383222581204, + 74.95383222581204, + 74.95383222581204, + 1, + [], + "", + "memory_percent"]] + GET amps -------- @@ -74,7 +93,7 @@ Get plugin stats:: "refresh": 3.0, "regex": True, "result": None, - "timer": 1.053581953048706}, + "timer": 1.7997314929962158}, {"count": 0, "countmax": 20.0, "countmin": None, @@ -83,7 +102,7 @@ Get plugin stats:: "refresh": 3.0, "regex": True, "result": None, - "timer": 1.0533969402313232}] + "timer": 1.7995269298553467}] Get a specific field:: @@ -101,7 +120,7 @@ Get a specific item when field matchs the given value:: "refresh": 3.0, "regex": True, "result": None, - "timer": 1.053581953048706}]} + "timer": 1.7997314929962158}]} GET connections --------------- @@ -128,15 +147,15 @@ Get plugin stats:: "Image": "["docker.io/library/ubuntu:latest"]", "Status": "running", "Uptime": "1 weeks", - "cpu": {"total": 1.2768348293282041e-06}, - "cpu_percent": 1.2768348293282041e-06, + "cpu": {"total": 2.2993346332214973e-06}, + "cpu_percent": 2.2993346332214973e-06, "engine": "podman", "io": {"ior": 0.0, "iow": 0.0, "time_since_update": 1}, "io_r": 0.0, "io_w": 0.0, "key": "name", - "memory": {"limit": 7836184576.0, "usage": 1282048.0}, - "memory_usage": 1282048.0, + "memory": {"limit": 7836184576.0, "usage": 1142784.0}, + "memory_usage": 1142784.0, "name": "frosty_bouman", "network": {"rx": 0.0, "time_since_update": 1, "tx": 0.0}, "network_rx": 0.0, @@ -149,8 +168,8 @@ Get plugin stats:: "Image": "["k8s.gcr.io/pause:3.5"]", "Status": "running", "Uptime": "1 weeks", - "cpu": {"total": 2.6911269370551856e-10}, - "cpu_percent": 2.6911269370551856e-10, + "cpu": {"total": 2.754373096346692e-10}, + "cpu_percent": 2.754373096346692e-10, "engine": "podman", "io": {"ior": 0.0, "iow": 0.0, "time_since_update": 1}, "io_r": 0.0, @@ -169,7 +188,7 @@ Get plugin stats:: "Id": "3abd51c615968482d9ccff5afc629f267f6dda113ed68b75b432615fae3b49fb", "Image": ["portainer/portainer-ce:2.9.3"], "Status": "running", - "Uptime": "5 days", + "Uptime": "7 hours", "cpu": {"total": 0.0}, "cpu_percent": 0.0, "engine": "docker", @@ -212,21 +231,21 @@ Get plugin stats:: # curl http://localhost:61208/api/3/cpu {"cpucore": 4, "ctx_switches": 0, - "guest": 0.0, + "guest": 1.1, "guest_nice": 0.0, - "idle": 55.9, + "idle": 38.7, "interrupts": 0, - "iowait": 0.0, + "iowait": 3.2, "irq": 0.0, "nice": 0.0, "soft_interrupts": 0, - "softirq": 0.0, + "softirq": 0.4, "steal": 0.0, "syscalls": 0, - "system": 6.6, + "system": 7.7, "time_since_update": 1, - "total": 42.1, - "user": 37.5} + "total": 62.2, + "user": 50.0} Fields descriptions: @@ -249,7 +268,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/3/cpu/total - {"total": 42.1} + {"total": 62.2} GET diskio ---------- @@ -295,13 +314,13 @@ Get plugin stats:: # curl http://localhost:61208/api/3/fs [{"device_name": "/dev/mapper/ubuntu--gnome--vg-root", - "free": 3450388480, + "free": 4763168768, "fs_type": "ext4", "key": "mnt_point", "mnt_point": "/", - "percent": 98.5, + "percent": 97.9, "size": 243334156288, - "used": 227496312832}, + "used": 226183532544}, {"device_name": "zsfpool", "free": 41811968, "fs_type": "zfs", @@ -320,13 +339,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": 3450388480, + "free": 4763168768, "fs_type": "ext4", "key": "mnt_point", "mnt_point": "/", - "percent": 98.5, + "percent": 97.9, "size": 243334156288, - "used": 227496312832}]} + "used": 226183532544}]} GET ip ------ @@ -352,7 +371,10 @@ GET load Get plugin stats:: # curl http://localhost:61208/api/3/load - {"cpucore": 4, "min1": 1.8046875, "min15": 1.51025390625, "min5": 1.6845703125} + {"cpucore": 4, + "min1": 3.00634765625, + "min15": 1.19775390625, + "min5": 1.4345703125} Fields descriptions: @@ -364,7 +386,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/3/load/min1 - {"min1": 1.8046875} + {"min1": 3.00634765625} GET mem ------- @@ -372,16 +394,16 @@ GET mem Get plugin stats:: # curl http://localhost:61208/api/3/mem - {"active": 2122240000, - "available": 2791682048, - "buffers": 85512192, - "cached": 2199904256, - "free": 2791682048, - "inactive": 3360813056, - "percent": 64.4, - "shared": 575238144, + {"active": 3130548224, + "available": 1962663936, + "buffers": 142680064, + "cached": 2079936512, + "free": 1962663936, + "inactive": 3094474752, + "percent": 75.0, + "shared": 498302976, "total": 7836184576, - "used": 5044502528} + "used": 5873520640} Fields descriptions: @@ -408,13 +430,13 @@ GET memswap Get plugin stats:: # curl http://localhost:61208/api/3/memswap - {"free": 4049227776, - "percent": 49.9, - "sin": 4989526016, - "sout": 8589299712, + {"free": 3018182656, + "percent": 62.7, + "sin": 10520571904, + "sout": 16592646144, "time_since_update": 1, "total": 8082419712, - "used": 4033191936} + "used": 5064237056} Fields descriptions: @@ -438,29 +460,29 @@ Get plugin stats:: # curl http://localhost:61208/api/3/network [{"alias": None, - "cumulative_cx": 194497112, - "cumulative_rx": 97248556, - "cumulative_tx": 97248556, - "cx": 3794, + "cumulative_cx": 344481682, + "cumulative_rx": 172240841, + "cumulative_tx": 172240841, + "cx": 7770, "interface_name": "lo", "is_up": True, "key": "interface_name", - "rx": 1897, + "rx": 3885, "speed": 0, "time_since_update": 1, - "tx": 1897}, + "tx": 3885}, {"alias": None, - "cumulative_cx": 13127976036, - "cumulative_rx": 12705380323, - "cumulative_tx": 422595713, - "cx": 39560, + "cumulative_cx": 22624441944, + "cumulative_rx": 21888194655, + "cumulative_tx": 736247289, + "cx": 146685, "interface_name": "wlp2s0", "is_up": True, "key": "interface_name", - "rx": 26691, + "rx": 135811, "speed": 0, "time_since_update": 1, - "tx": 12869}] + "tx": 10874}] Fields descriptions: @@ -484,24 +506,25 @@ Get a specific field:: "docker0", "br_grafana", "mpqemubr0", - "vethcddb0e6", - "vboxnet0"]} + "vboxnet0", + "tap-1e376645a40", + "veth54fd604"]} 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": 194497112, - "cumulative_rx": 97248556, - "cumulative_tx": 97248556, - "cx": 3794, + "cumulative_cx": 344481682, + "cumulative_rx": 172240841, + "cumulative_tx": 172240841, + "cx": 7770, "interface_name": "lo", "is_up": True, "key": "interface_name", - "rx": 1897, + "rx": 3885, "speed": 0, "time_since_update": 1, - "tx": 1897}]} + "tx": 3885}]} GET now ------- @@ -509,7 +532,7 @@ GET now Get plugin stats:: # curl http://localhost:61208/api/3/now - "2023-05-18 17:40:44 CEST" + "2023-05-20 16:44:16 CEST" GET percpu ---------- @@ -518,31 +541,31 @@ Get plugin stats:: # curl http://localhost:61208/api/3/percpu [{"cpu_number": 0, - "guest": 0.0, + "guest": 1.5, "guest_nice": 0.0, - "idle": 71.1, - "iowait": 0.0, + "idle": 26.2, + "iowait": 1.5, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 6.2, - "total": 28.9, - "user": 22.7}, + "system": 4.4, + "total": 73.8, + "user": 68.0}, {"cpu_number": 1, "guest": 0.0, "guest_nice": 0.0, - "idle": 72.1, - "iowait": 0.0, + "idle": 39.4, + "iowait": 1.0, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 8.5, - "total": 27.9, - "user": 19.4}] + "system": 4.8, + "total": 60.6, + "user": 54.8}] Get a specific field:: @@ -561,7 +584,7 @@ Get plugin stats:: "port": 0, "refresh": 30, "rtt_warning": None, - "status": 0.004474, + "status": 0.00792, "timeout": 3}] Get a specific field:: @@ -578,7 +601,7 @@ Get a specific item when field matchs the given value:: "port": 0, "refresh": 30, "rtt_warning": None, - "status": 0.004474, + "status": 0.00792, "timeout": 3}]} GET processcount @@ -587,12 +610,12 @@ GET processcount Get plugin stats:: # curl http://localhost:61208/api/3/processcount - {"pid_max": 0, "running": 2, "sleeping": 326, "thread": 1750, "total": 392} + {"pid_max": 0, "running": 1, "sleeping": 347, "thread": 1761, "total": 415} Get a specific field:: # curl http://localhost:61208/api/3/processcount/total - {"total": 392} + {"total": 415} GET processlist --------------- @@ -602,275 +625,290 @@ Get plugin stats:: # curl http://localhost:61208/api/3/processlist [{"cmdline": ["/snap/firefox/2605/usr/lib/firefox/firefox"], "cpu_percent": 0.0, - "cpu_times": [9681.14, 2938.04, 7162.98, 1045.12, 0.0], + "cpu_times": [16463.82, 5059.85, 11961.09, 1725.84, 0.0], "gids": [1000, 1000, 1000], - "io_counters": [5914563584, 9486209024, 0, 0, 0], + "io_counters": [9699624960, 15455608832, 0, 0, 0], "key": "pid", - "memory_info": [409571328, 21839839232, 109895680, 618496, 0, 1071738880, 0], - "memory_percent": 5.226667698134628, + "memory_info": [524517376, 22345007104, 90595328, 618496, 0, 1481629696, 0], + "memory_percent": 6.693530134632704, "name": "firefox", "nice": 0, - "num_threads": 174, + "num_threads": 171, "pid": 10541, "status": "S", "time_since_update": 1, "username": "nicolargo"}, - {"cmdline": ["/snap/firefox/2605/usr/lib/firefox/firefox", - "-contentproc", - "-childID", - "2", - "-isForBrowser", - "-prefsLen", - "27003", - "-prefMapSize", - "241898", - "-jsInitLen", - "240056", - "-parentBuildID", - "20230424185118", - "-appDir", - "/snap/firefox/2605/usr/lib/firefox/browser", - "{dbcbe484-8536-44ea-aa85-ba683b538aa8}", - "10541", - "true", - "tab"], + {"cmdline": ["/snap/multipass/8465/usr/bin/qemu-system-x86_64", + "-bios", + "OVMF.fd", + "--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"], "cpu_percent": 0.0, - "cpu_times": [1257.75, 117.29, 0.0, 0.0, 0.0], - "gids": [1000, 1000, 1000], - "io_counters": [301149184, 0, 0, 0, 0], + "cpu_times": [846.85, 90.96, 0.0, 0.0, 0.0], + "gids": [0, 0, 0], + "io_counters": [0, 0, 0, 0, 0], "key": "pid", - "memory_info": [371560448, 3219562496, 60375040, 618496, 0, 553922560, 0], - "memory_percent": 4.741598980937532, - "name": "Isolated Web Co", + "memory_info": [510238720, 3458437120, 2822144, 5304320, 0, 1366933504, 0], + "memory_percent": 6.511315743668364, + "name": "qemu-system-x86_64", "nice": 0, - "num_threads": 22, - "pid": 10770, + "num_threads": 4, + "pid": 354319, "status": "S", "time_since_update": 1, - "username": "nicolargo"}] + "username": "root"}] Get a specific field:: # curl http://localhost:61208/api/3/processlist/pid {"pid": [10541, + 354319, 10770, - 59195, - 60503, 11043, - 59454, + 374779, + 374071, 3927, + 469948, + 374587, + 317865, 10778, 10774, - 55857, - 296364, - 277461, - 293836, - 261989, - 307573, - 297410, + 429788, + 59195, + 469241, + 399766, + 430971, + 372037, 11646, - 4288, 59069, - 314895, - 10790, - 315078, - 315445, - 314927, - 294622, + 374904, 10733, - 306969, - 59523, - 313257, - 421, + 480322, + 480143, + 480228, + 374842, + 435889, + 10790, 59161, - 315564, - 315575, - 60104, - 60232, - 4385, - 195248, + 480580, + 59523, 4243, + 421, + 480591, + 466459, + 374575, + 374705, 3810, - 315023, - 59182, - 2398, - 281405, - 307822, + 457618, + 466460, + 374905, + 372303, + 4385, 165661, - 59525, - 56140, - 1771, - 4023, - 60191, - 313283, + 417207, + 463383, 1618, - 60192, - 2636, - 3730, + 1771, + 372048, + 372151, + 2398, + 372186, + 372172, + 59182, 4339, - 11380, + 374703, + 313257, + 2636, + 431242, + 374702, + 4023, + 4666, 1, - 60489, + 3730, + 4179, + 59663, 1584, - 3115, - 299963, - 195141, - 4090, + 427863, 4075, - 4000, - 313650, - 4666, - 59663, - 3719, - 4179, + 10710, 17997, + 430855, + 4308, + 4091, 1630, 1605, - 4086, - 4091, - 60106, - 4169, - 4046, 4403, - 3908, - 143263, - 4308, - 60134, - 143262, - 74953, - 4126, - 1794, + 4000, 4009, - 3901, + 4090, 3991, - 36919, - 3956, - 4442, + 3719, 11381, - 4080, - 1583, - 3743, - 4302, - 2116, + 11380, + 1794, + 372168, + 431219, + 479905, + 372170, + 354726, + 4169, + 372169, + 4086, + 1727, + 4033, + 3745, + 4105, + 3901, 3710, + 4442, + 3908, + 4046, 4127, - 4105, - 59126, - 289122, + 36919, + 1631, + 3743, + 14243, + 1583, + 4302, + 3956, + 1379, + 418247, + 74953, + 4126, + 3748, + 3115, 20173, - 2168, - 2607, - 3745, - 10710, - 56119, + 14266, + 1591, 4196, + 59126, + 2116, 4005, - 1379, - 4244, - 289100, + 1764, + 4316, + 4145, + 4097, + 4080, + 1627, + 2168, + 2607, + 1818, + 3989, + 1579, + 1628, + 3925, 4079, + 4244, + 4157, + 3970, + 59127, + 2554, 4099, - 227509, - 1818, + 1612, + 3819, + 1380, 4078, + 10848, 2341, - 14266, - 59127, 1566, - 2554, - 4145, - 1591, - 16182, - 14243, + 227509, + 1598, 1624, - 1628, - 3925, - 1764, - 3947, - 1612, - 3939, 4119, - 4316, - 1598, - 3819, 4074, - 3952, + 3825, + 3947, 4098, - 4107, - 3748, - 3970, - 4033, - 313277, 4062, - 3989, - 4157, - 3825, - 10848, + 3939, + 4107, 3975, 3753, + 3952, + 1575, 1606, + 313277, 461, - 1631, - 3934, - 1579, - 4097, - 1825, - 1627, - 1575, - 315523, + 354741, 1593, - 1616, + 480538, + 3934, + 3728, 12480, - 261973, 3888, + 1616, 59145, - 1377, 12489, - 3727, - 1380, + 1377, 1582, 18045, - 1964, 4332, - 3728, + 1964, + 1825, + 3727, + 59130, 1634, - 3118, - 2361, + 16182, 1391, - 1727, + 2361, + 2605, + 1577, + 3118, 2604, 1390, - 2605, 12483, 1567, + 431184, 20396, + 354739, + 431178, + 431203, 20180, - 315563, + 480579, + 431197, 4072, 2358, - 20400, - 59130, - 3498, + 469137, + 3503, 12492, - 314768, - 56087, - 56106, - 1725, 1726, + 1725, 3794, + 3498, 3499, - 56100, - 56081, - 3503, 3720, + 20400, + 313283, 2345, - 4593, 2382, + 4593, 2360, - 20185, - 1637, 1392, - 1577, + 1637, + 3573, + 20185, 2, 3, 4, @@ -998,11 +1036,6 @@ Get a specific field:: 1035, 1036, 1037, - 2138, - 2140, - 2141, - 2142, - 2143, 2394, 2410, 2422, @@ -1014,57 +1047,78 @@ Get a specific field:: 2510, 2515, 2525, - 3573, 3988, 12486, - 288792, - 288793, - 288795, - 304692, - 306042, - 307710, - 307711, - 307713, - 307714, - 307715, - 307764, - 309333, - 310964, - 311618, - 311630, - 313395, 313404, - 313720, - 313725, - 313896, - 314273, - 314367, - 314371, - 314524, - 315132, - 315249, - 315374]} + 354325, + 354329, + 417249, + 417250, + 417251, + 417252, + 417254, + 417255, + 417257, + 417258, + 417259, + 417260, + 417261, + 417262, + 417263, + 417264, + 417265, + 417266, + 417267, + 427608, + 427609, + 427611, + 454059, + 459092, + 463267, + 463268, + 463271, + 463272, + 463274, + 463320, + 467345, + 467496, + 468536, + 468902, + 469637, + 469929, + 470092, + 471704, + 476042, + 477638, + 478302, + 479060, + 479698, + 479767, + 480036, + 480278, + 480424, + 480454]} Get a specific item when field matchs the given value:: # curl http://localhost:61208/api/3/processlist/pid/10541 {"10541": [{"cmdline": ["/snap/firefox/2605/usr/lib/firefox/firefox"], "cpu_percent": 0.0, - "cpu_times": [9681.14, 2938.04, 7162.98, 1045.12, 0.0], + "cpu_times": [16463.82, 5059.85, 11961.09, 1725.84, 0.0], "gids": [1000, 1000, 1000], - "io_counters": [5914563584, 9486209024, 0, 0, 0], + "io_counters": [9699624960, 15455608832, 0, 0, 0], "key": "pid", - "memory_info": [409571328, - 21839839232, - 109895680, + "memory_info": [524517376, + 22345007104, + 90595328, 618496, 0, - 1071738880, + 1481629696, 0], - "memory_percent": 5.226667698134628, + "memory_percent": 6.693530134632704, "name": "firefox", "nice": 0, - "num_threads": 174, + "num_threads": 171, "pid": 10541, "status": "S", "time_since_update": 1, @@ -1084,69 +1138,69 @@ GET quicklook Get plugin stats:: # curl http://localhost:61208/api/3/quicklook - {"cpu": 42.1, + {"cpu": 62.2, "cpu_hz": 2025000000.0, - "cpu_hz_current": 1264730000.0, + "cpu_hz_current": 1273980750.0, "cpu_name": "Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz", - "mem": 64.4, + "mem": 75.0, "percpu": [{"cpu_number": 0, - "guest": 0.0, + "guest": 1.5, "guest_nice": 0.0, - "idle": 71.1, - "iowait": 0.0, + "idle": 26.2, + "iowait": 1.5, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 6.2, - "total": 28.9, - "user": 22.7}, + "system": 4.4, + "total": 73.8, + "user": 68.0}, {"cpu_number": 1, "guest": 0.0, "guest_nice": 0.0, - "idle": 72.1, - "iowait": 0.0, + "idle": 39.4, + "iowait": 1.0, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 8.5, - "total": 27.9, - "user": 19.4}, + "system": 4.8, + "total": 60.6, + "user": 54.8}, {"cpu_number": 2, - "guest": 0.0, + "guest": 0.5, "guest_nice": 0.0, - "idle": 27.9, - "iowait": 0.0, + "idle": 36.0, + "iowait": 4.3, "irq": 0.0, "key": "cpu_number", "nice": 0.0, - "softirq": 0.0, + "softirq": 0.9, "steal": 0.0, - "system": 3.3, - "total": 72.1, - "user": 68.9}, + "system": 9.5, + "total": 64.0, + "user": 49.3}, {"cpu_numbe |