diff options
author | nicolargo <nicolas@nicolargo.com> | 2023-05-16 09:32:17 +0200 |
---|---|---|
committer | nicolargo <nicolas@nicolargo.com> | 2023-05-16 09:32:17 +0200 |
commit | 1c28d543f2537b488cff78693954797242ce7655 (patch) | |
tree | 69fc05f5fb6395a363e755841058bd6a3cab3cf4 /docs/api.rst | |
parent | b3a80ab0284f9f3f0ab4674f1b0f15237f1f4949 (diff) |
Update docs for Glances 3.4.0
Diffstat (limited to 'docs/api.rst')
-rw-r--r-- | docs/api.rst | 700 |
1 files changed, 310 insertions, 390 deletions
diff --git a/docs/api.rst b/docs/api.rst index bd984be2..205297d3 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -60,25 +60,6 @@ Get the plugins list:: "uptime", "wifi"] -GET alert ---------- - -Get plugin stats:: - - # curl http://localhost:61208/api/3/alert - [[1683984558.0, - -1, - "WARNING", - "MEM", - 73.17533404664918, - 73.17533404664918, - 73.17533404664918, - 73.17533404664918, - 1, - [], - "", - "memory_percent"]] - GET amps -------- @@ -93,7 +74,7 @@ Get plugin stats:: "refresh": 3.0, "regex": True, "result": None, - "timer": 0.8803508281707764}, + "timer": 1.0034148693084717}, {"count": 0, "countmax": 20.0, "countmin": None, @@ -102,7 +83,7 @@ Get plugin stats:: "refresh": 3.0, "regex": True, "result": None, - "timer": 0.8801853656768799}] + "timer": 1.003244400024414}] Get a specific field:: @@ -120,7 +101,7 @@ Get a specific item when field matchs the given value:: "refresh": 3.0, "regex": True, "result": None, - "timer": 0.8803508281707764}]} + "timer": 1.0034148693084717}]} GET connections --------------- @@ -141,44 +122,21 @@ GET containers Get plugin stats:: # curl http://localhost:61208/api/3/containers - {"containers": [{"Command": ["/portainer"], - "Created": "2022-10-29T14:59:10.266701439Z", - "Id": "3abd51c615968482d9ccff5afc629f267f6dda113ed68b75b432615fae3b49fb", - "Image": ["portainer/portainer-ce:2.9.3"], - "Status": "running", - "Uptime": "6 hours", - "cpu": {"total": 0.0}, - "cpu_percent": 0.0, - "engine": "docker", - "io": {"cumulative_ior": 0, "cumulative_iow": 184320}, - "io_r": None, - "io_w": None, - "key": "name", - "memory": {"cache": None, - "limit": 7836184576, - "max_usage": None, - "rss": None, - "usage": 19238912}, - "memory_usage": 19238912, - "name": "portainer", - "network": {"cumulative_rx": 516952, "cumulative_tx": 0}, - "network_rx": None, - "network_tx": None}, - {"Command": ["top"], + {"containers": [{"Command": ["top"], "Created": "2023-05-08T15:29:34.918692365+02:00", "Id": "4b7f732d43e4bc5d92fe5298cba025b550e6a608754c1c38f9a90aaecd46b8f9", "Image": "["docker.io/library/ubuntu:latest"]", "Status": "running", - "Uptime": "4 days", - "cpu": {"total": 3.4516486319009634e-07}, - "cpu_percent": 3.4516486319009634e-07, + "Uptime": "1 weeks", + "cpu": {"total": 7.811242562687869e-07}, + "cpu_percent": 7.811242562687869e-07, "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": 2195456.0}, - "memory_usage": 2195456.0, + "memory": {"limit": 7836184576.0, "usage": 1576960.0}, + "memory_usage": 1576960.0, "name": "frosty_bouman", "network": {"rx": 0.0, "time_since_update": 1, "tx": 0.0}, "network_rx": 0.0, @@ -190,22 +148,41 @@ Get plugin stats:: "Id": "9491515251edcd5bb5dc17205d7ee573c0be96fe0b08b0a12a7e2cea874565ea", "Image": "["k8s.gcr.io/pause:3.5"]", "Status": "running", - "Uptime": "4 days", - "cpu": {"total": 2.5083365383979135e-10}, - "cpu_percent": 2.5083365383979135e-10, + "Uptime": "1 weeks", + "cpu": {"total": 2.630294095569028e-10}, + "cpu_percent": 2.630294095569028e-10, "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": 647168.0}, - "memory_usage": 647168.0, + "memory": {"limit": 7836184576.0, "usage": 454656.0}, + "memory_usage": 454656.0, "name": "8d0f1c783def-infra", "network": {"rx": 0.0, "time_since_update": 1, "tx": 0.0}, "network_rx": 0.0, "network_tx": 0.0, "pod_id": "8d0f1c783def", - "pod_name": "8d0f1c783def-infra"}], + "pod_name": "8d0f1c783def-infra"}, + {"Command": ["/portainer"], + "Created": "2022-10-29T14:59:10.266701439Z", + "Id": "3abd51c615968482d9ccff5afc629f267f6dda113ed68b75b432615fae3b49fb", + "Image": ["portainer/portainer-ce:2.9.3"], + "Status": "running", + "Uptime": "3 days", + "cpu": {"total": 0.0}, + "cpu_percent": 0.0, + "engine": "docker", + "io": {}, + "io_r": None, + "io_w": None, + "key": "name", + "memory": {}, + "memory_usage": None, + "name": "portainer", + "network": {}, + "network_rx": None, + "network_tx": None}], "version": {}, "version_podman": {}} @@ -237,7 +214,7 @@ Get plugin stats:: "ctx_switches": 0, "guest": 0.0, "guest_nice": 0.0, - "idle": 70.8, + "idle": 73.0, "interrupts": 0, "iowait": 0.2, "irq": 0.0, @@ -246,10 +223,10 @@ Get plugin stats:: "softirq": 0.0, "steal": 0.0, "syscalls": 0, - "system": 3.7, + "system": 4.1, "time_since_update": 1, - "total": 29.0, - "user": 25.2} + "total": 27.4, + "user": 22.7} Fields descriptions: @@ -272,7 +249,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/3/cpu/total - {"total": 29.0} + {"total": 27.4} GET diskio ---------- @@ -318,13 +295,13 @@ Get plugin stats:: # curl http://localhost:61208/api/3/fs [{"device_name": "/dev/mapper/ubuntu--gnome--vg-root", - "free": 9096110080, + "free": 7953657856, "fs_type": "ext4", "key": "mnt_point", "mnt_point": "/", - "percent": 96.1, + "percent": 96.6, "size": 243334156288, - "used": 221850591232}, + "used": 222993043456}, {"device_name": "zsfpool", "free": 41811968, "fs_type": "zfs", @@ -343,13 +320,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": 9096110080, + "free": 7953657856, "fs_type": "ext4", "key": "mnt_point", "mnt_point": "/", - "percent": 96.1, + "percent": 96.6, "size": 243334156288, - "used": 221850591232}]} + "used": 222993043456}]} GET ip ------ @@ -376,9 +353,9 @@ Get plugin stats:: # curl http://localhost:61208/api/3/load {"cpucore": 4, - "min1": 0.8857421875, - "min15": 0.74365234375, - "min5": 0.77685546875} + "min1": 0.55029296875, + "min15": 1.06982421875, + "min5": 0.85693359375} Fields descriptions: @@ -390,7 +367,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/3/load/min1 - {"min1": 0.8857421875} + {"min1": 0.55029296875} GET mem ------- @@ -398,16 +375,16 @@ GET mem Get plugin stats:: # curl http://localhost:61208/api/3/mem - {"active": 2534027264, - "available": 2102030336, - "buffers": 218550272, - "cached": 2393772032, - "free": 2102030336, - "inactive": 3635040256, - "percent": 73.2, - "shared": 637190144, + {"active": 3109634048, + "available": 2829815808, + "buffers": 207228928, + "cached": 3178246144, + "free": 2829815808, + "inactive": 3462545408, + "percent": 63.9, + "shared": 451821568, "total": 7836184576, - "used": 5734154240} + "used": 5006368768} Fields descriptions: @@ -434,13 +411,13 @@ GET memswap Get plugin stats:: # curl http://localhost:61208/api/3/memswap - {"free": 7234039808, - "percent": 10.5, - "sin": 499916800, - "sout": 1525796864, + {"free": 5400473600, + "percent": 33.2, + "sin": 2319233024, + "sout": 4863959040, "time_since_update": 1, "total": 8082419712, - "used": 848379904} + "used": 2681946112} Fields descriptions: @@ -464,29 +441,29 @@ Get plugin stats:: # curl http://localhost:61208/api/3/network [{"alias": None, - "cumulative_cx": 56960572, - "cumulative_rx": 28480286, - "cumulative_tx": 28480286, - "cx": 6512, + "cumulative_cx": 130574070, + "cumulative_rx": 65287035, + "cumulative_tx": 65287035, + "cx": 2414, "interface_name": "lo", "is_up": True, "key": "interface_name", - "rx": 3256, + "rx": 1207, "speed": 0, "time_since_update": 1, - "tx": 3256}, + "tx": 1207}, {"alias": None, - "cumulative_cx": 3229266842, - "cumulative_rx": 3098498206, - "cumulative_tx": 130768636, - "cx": 22545, + "cumulative_cx": 8162673663, + "cumulative_rx": 7914211852, + "cumulative_tx": 248461811, + "cx": 17399, "interface_name": "wlp2s0", "is_up": True, "key": "interface_name", - "rx": 14112, + "rx": 13173, "speed": 0, "time_since_update": 1, - "tx": 8433}] + "tx": 4226}] Fields descriptions: @@ -516,17 +493,17 @@ 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": 56960572, - "cumulative_rx": 28480286, - "cumulative_tx": 28480286, - "cx": 6512, + "cumulative_cx": 130574070, + "cumulative_rx": 65287035, + "cumulative_tx": 65287035, + "cx": 2414, "interface_name": "lo", "is_up": True, "key": "interface_name", - "rx": 3256, + "rx": 1207, "speed": 0, "time_since_update": 1, - "tx": 3256}]} + "tx": 1207}]} GET now ------- @@ -534,7 +511,7 @@ GET now Get plugin stats:: # curl http://localhost:61208/api/3/now - "2023-05-13 15:29:18 CEST" + "2023-05-16 09:31:49 CEST" GET percpu ---------- @@ -545,29 +522,29 @@ Get plugin stats:: [{"cpu_number": 0, "guest": 0.0, "guest_nice": 0.0, - "idle": 2.9, + "idle": 19.8, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 4.9, - "total": 97.1, - "user": 92.2}, + "system": 3.4, + "total": 80.2, + "user": 76.7}, {"cpu_number": 1, "guest": 0.0, "guest_nice": 0.0, - "idle": 96.0, + "idle": 91.2, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 1.0, - "total": 4.0, - "user": 3.0}] + "system": 2.7, + "total": 8.8, + "user": 6.2}] Get a specific field:: @@ -586,7 +563,7 @@ Get plugin stats:: "port": 0, "refresh": 30, "rtt_warning": None, - "status": 0.008301, + "status": 0.005767, "timeout": 3}] Get a specific field:: @@ -603,7 +580,7 @@ Get a specific item when field matchs the given value:: "port": 0, "refresh": 30, "rtt_warning": None, - "status": 0.008301, + "status": 0.005767, "timeout": 3}]} GET processcount @@ -612,12 +589,12 @@ GET processcount Get plugin stats:: # curl http://localhost:61208/api/3/processcount - {"pid_max": 0, "running": 1, "sleeping": 310, "thread": 1568, "total": 439} + {"pid_max": 0, "running": 1, "sleeping": 315, "thread": 1562, "total": 382} Get a specific field:: # curl http://localhost:61208/api/3/processcount/total - {"total": 439} + {"total": 382} GET processlist --------------- @@ -627,15 +604,15 @@ Get plugin stats:: # curl http://localhost:61208/api/3/processlist [{"cmdline": ["/snap/firefox/2605/usr/lib/firefox/firefox"], "cpu_percent": 0.0, - "cpu_times": [2184.25, 667.78, 1237.1, 178.98, 0.0], + "cpu_times": [5239.7, 1595.52, 4093.05, 570.73, 0.0], "gids": [1000, 1000, 1000], - "io_counters": [1531420672, 2813288448, 0, 0, 0], + "io_counters": [3503764480, 5856641024, 0, 0, 0], "key": "pid", - "memory_info": [487464960, 21833334784, 137736192, 618496, 0, 1029808128, 0], - "memory_percent": 6.220692676037344, + "memory_info": [468434944, 22123225088, 114802688, 618496, 0, 1282670592, 0], + "memory_percent": 5.977844695423366, "name": "firefox", "nice": 0, - "num_threads": 140, + "num_threads": 160, "pid": 10541, "status": "S", "time_since_update": 1, @@ -660,12 +637,12 @@ Get plugin stats:: "true", "tab"], "cpu_percent": 0.0, - "cpu_times": [435.82, 49.35, 0.0, 0.0, 0.0], + "cpu_times": [914.43, 104.03, 0.0, 0.0, 0.0], "gids": [1000, 1000, 1000], - "io_counters": [30860288, 0, 0, 0, 0], + "io_counters": [131410944, 0, 0, 0, 0], "key": "pid", - "memory_info": [473804800, 3518271488, 87040000, 618496, 0, 924098560, 0], - "memory_percent": 6.046371105794638, + "memory_info": [438992896, 3601903616, 70893568, 618496, 0, 1002868736, 0], + "memory_percent": 5.602125520939235, "name": "WebExtensions", "nice": 0, "num_threads": 20, @@ -679,206 +656,211 @@ Get a specific field:: # curl http://localhost:61208/api/3/processlist/pid {"pid": [10541, 11043, - 60503, 10770, + 55857, 10778, - 67269, - 59454, - 3927, + 181461, 59195, - 4288, + 3927, + 60503, 10774, - 82905, - 55857, - 50925, + 59454, + 195248, + 228679, + 165661, 10790, - 71741, - 59069, + 4288, + 11646, 10733, - 60104, + 59069, + 229507, + 229901, + 229717, 421, - 11646, - 71710, 59523, - 60134, - 60106, - 84415, 59161, - 60489, - 85078, - 85144, - 59525, - 59663, 60232, + 60489, + 230002, 2398, + 230013, + 60104, 3810, - 85317, - 60191, - 11380, - 59182, - 60192, - 10710, + 60106, + 195141, + 59525, + 4243, + 60134, 11381, - 4179, + 10710, + 11380, 4385, - 4243, - 4023, + 1618, + 59663, + 143262, + 143263, + 193297, + 193376, + 59182, + 2636, 1771, + 4023, 3730, - 20173, - 17997, - 2636, - 59126, - 59127, - 4000, + 60191, 4666, - 4091, - 1618, - 4403, - 1727, + 60192, + 1, + 193364, 1584, - 2168, - 4046, + 227509, 56140, + 17997, + 4179, + 4091, + 4000, 4090, - 36919, + 4403, 4075, - 1598, - 3956, - 1825, - 4169, + 3901, + 3115, + 193411, 2554, - 3991, - 1, - 2607, - 4442, - 4339, - 84438, - 1630, + 1605, 1794, - 51324, + 1630, + 2168, + 4046, + 36919, + 3991, 4308, - 1605, - 4086, - 4126, - 1379, - 4244, - 2341, - 4080, - 3901, - 4078, 3719, - 4105, + 4339, + 59126, + 20173, + 2607, + 1598, 3710, + 2341, + 1631, + 3956, + 1727, + 4105, + 59127, 3908, - 3115, - 51357, - 4097, - 3825, 4009, + 1379, 1764, - 1631, + 4086, + 4244, 1818, - 1628, - 2116, + 1583, + 197243, + 4127, + 4169, + 4126, + 14243, + 4442, 74953, + 14266, + 4097, 1627, + 4078, + 2116, + 1628, + 4080, 1566, - 14243, - 14266, - 3970, - 3939, - 4119, - 4145, - 56119, - 78856, - 3743, - 4033, + 3745, 3498, - 60199, - 1583, + 4145, + 4119, 3748, - 4316, - 3952, - 4107, 3925, + 2604, + 3939, 4062, + 3970, 1591, - 4302, - 1606, - 2604, + 4033, + 3952, + 4099, + 4005, 1624, - 4127, - 4079, + 1612, + 4316, 4196, - 4005, - 3975, - 10848, - 1616, + 3825, 3947, + 1825, + 4107, + 1606, + 3975, 4098, - 1380, + 4302, + 2605, + 1579, + 3743, 4074, - 4099, - 3745, - 1612, - 16182, - 4157, - 461, + 60199, 3989, + 10848, 3819, - 3727, + 4157, + 461, + 1380, + 4079, 3753, - 1579, - 2605, + 3499, + 56119, + 3727, + 1616, + 1575, 3728, 3888, - 3499, 3934, - 1575, 1593, 1377, 1964, + 229977, 1582, - 18045, - 12489, 12480, - 1634, + 12489, + 18045, 4332, - 85272, + 3118, + 1634, 1390, 1391, 59145, - 3118, 3573, - 20400, 2361, - 12492, - 12483, - 3720, - 59130, + 20400, + 16182, 1725, 1726, - 4593, + 12483, + 1567, 20396, 20180, - 1567, + 12492, + 59130, + 230001, + 4593, + 3720, + 56100, 56106, 56087, - 56100, - 85316, + 3503, 56081, - 3794, 4072, + 3794, 2358, - 3503, - 78769, - 1637, + 225591, 2382, 2345, + 1637, 2360, - 20185, 1392, + 20185, 1577, 12486, 2, @@ -1025,118 +1007,56 @@ Get a specific field:: 2515, 2525, 3988, - 51078, - 51079, - 51081, - 69313, - 69647, - 70461, - 75183, - 80333, - 81339, - 81683, - 81911, - 82593, - 82688, - 82773, - 82994, - 83112, - 83723, - 83900, - 83920, - 84008, - 84129, - 84204, - 84205, - 84302, - 84303, - 84304, - 84305, - 84306, - 84307, - 84308, - 84309, - 84310, - 84311, - 84312, - 84313, - 84314, - 84315, - 84316, - 84317, - 84318, - 84319, - 84320, - 84321, - 84322, - 84323, - 84324, - 84325, - 84326, - 84327, - 84328, - 84329, - 84330, - 84331, - 84332, - 84333, - 84334, - 84335, - 84336, - 84337, - 84338, - 84339, - 84340, - 84341, - 84342, - 84343, - 84344, - 84345, - 84346, - 84347, - 84348, - 84349, - 84350, - 84351, - 84352, - 84353, - 84354, - 84355, - 84356, - 84357, - 84358, - 84359, - 84360, - 84361, - 84362, - 84363, - 84364, - 84365, - 84366, - 84403, - 84463, - 84575]} + 190070, + 190071, + 190072, + 193066, + 193067, + 193069, + 193070, + 193072, + 193122, + 199564, + 199838, + 199918, + 200002, + 224417, + 225391, + 226425, + 228320, + 228350, + 228656, + 228870, + 228902, + 229080, + 229081, + 229082, + 229233, + 229447, + 229542, + 229866, + 229894]} 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": [2184.25, 667.78, 1237.1, 178.98, 0.0], + "cpu_times": [5239.7, 1595.52, 4093.05, 570.73, 0.0], "gids": [1000, 1000, 1000], - "io_counters": [1531420672, 2813288448, 0, 0, 0], + "io_counters": [3503764480, 5856641024, 0, 0, 0], "key": "pid", - "memory_info": [487464960, - 21833334784, - 137736192, + "memory_info": [468434944, + 22123225088, + 114802688, 618496, 0, - 1029808128, + 1282670592, 0], - "memory_percent": 6.220692676037344, + "memory_percent": 5.977844695423366, "name": "firefox", "nice": 0, - "num_threads": 140, + "num_threads": 160, "pid": 10541, "status": "S", "time_since_update": 1, @@ -1156,69 +1076,69 @@ GET quicklook Get plugin stats:: # curl http://localhost:61208/api/3/quicklook - {"cpu": 29.0, + {"cpu": 27.4, "cpu_hz": 2025000000.0, - "cpu_hz_current": 1634067000.0, + "cpu_hz_current": 1273975000.0, "cpu_name": "Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz", - "mem": 73.2, + "mem": 63.9, "percpu": [{"cpu_number": 0, "guest": 0.0, "guest_nice": 0.0, - "idle": 2.9, + "idle": 19.8, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 4.9, - "total": 97.1, - "user": 92.2}, + "system": 3.4, + "total": 80.2, + "user": 76.7}, {"cpu_number": 1, "guest": 0.0, "guest_nice": 0.0, - "idle": 96.0, + "idle": 91.2, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 1.0, - "total": 4.0, - "user": 3.0}, + "system": 2.7, + "total": 8.8, + "user": 6.2}, {"cpu_number": 2, "guest": 0.0, "guest_nice": 0.0, - "idle": 92.2, + "idle": 91.3, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 3.9, - "total": 7.8, - "user": 3.9}, + "system": 2.6, + "total": 8.7, + "user": 6.1}, {"cpu_number": 3, "guest": 0.0, "guest_nice": 0.0, - "idle": 94.1, - "iowait": 0.0, + "idle": 88.6, + "iowait": 0.9, "irq": 0.0, "key": "cpu_number", "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 2.0, - "total": 5.9, - "user": 4.0}], - "swap": 10.5} + "system": 2.6, + "total": 11.4, + "user": 7.9}], + "swap": 33.2} |