diff options
Diffstat (limited to 'docs/api.rst')
-rw-r--r-- | docs/api.rst | 183 |
1 files changed, 93 insertions, 90 deletions
diff --git a/docs/api.rst b/docs/api.rst index e67d2230..7bf355ff 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -141,7 +141,7 @@ Get plugin stats:: "refresh": 3.0, "regex": True, "result": None, - "timer": 0.1488208770751953}, + "timer": 0.3419933319091797}, {"count": 0, "countmax": 20.0, "countmin": None, @@ -150,7 +150,7 @@ Get plugin stats:: "refresh": 3.0, "regex": True, "result": None, - "timer": 0.14876770973205566}] + "timer": 0.34189915657043457}] Fields descriptions: @@ -178,7 +178,7 @@ Get a specific item when field matches the given value:: "refresh": 3.0, "regex": True, "result": None, - "timer": 0.1488208770751953}]} + "timer": 0.3419933319091797}]} GET cloud --------- @@ -265,14 +265,14 @@ Get plugin stats:: # curl http://localhost:61208/api/4/cpu {"cpucore": 16, - "ctx_switches": 26785017, + "ctx_switches": 226080767, "guest": 0.0, - "idle": 1.0, - "interrupts": 31606155, + "idle": 0.0, + "interrupts": 212524511, "iowait": 0.0, "irq": 0.0, "nice": 0.0, - "soft_interrupts": 7987786, + "soft_interrupts": 73033693, "steal": 0.0, "syscalls": 0, "system": 0.0, @@ -320,14 +320,14 @@ Get plugin stats:: # curl http://localhost:61208/api/4/diskio [{"disk_name": "nvme0n1", "key": "disk_name", - "read_bytes": 3989510656, - "read_count": 136457, - "write_bytes": 4117681152, - "write_count": 166108}, + "read_bytes": 4815501824, + "read_count": 206134, + "write_bytes": 13422109696, + "write_count": 782837}, {"disk_name": "nvme0n1p1", "key": "disk_name", - "read_bytes": 7476224, - "read_count": 576, + "read_bytes": 7484416, + "read_count": 592, "write_bytes": 1024, "write_count": 2}] @@ -363,10 +363,10 @@ Get a specific item when field matches the given value:: # curl http://localhost:61208/api/4/diskio/disk_name/nvme0n1 {"nvme0n1": [{"disk_name": "nvme0n1", "key": "disk_name", - "read_bytes": 3989510656, - "read_count": 136457, - "write_bytes": 4117681152, - "write_count": 166108}]} + "read_bytes": 4815501824, + "read_count": 206134, + "write_bytes": 13422109696, + "write_count": 782837}]} GET folders ----------- @@ -393,13 +393,13 @@ Get plugin stats:: # curl http://localhost:61208/api/4/fs [{"device_name": "/dev/mapper/ubuntu--vg-ubuntu--lv", - "free": 905288650752, + "free": 904885006336, "fs_type": "ext4", "key": "mnt_point", "mnt_point": "/", "percent": 5.0, "size": 1003736440832, - "used": 47385284608}] + "used": 47788929024}] Fields descriptions: @@ -420,13 +420,13 @@ Get a specific item when field matches the given value:: # curl http://localhost:61208/api/4/fs/mnt_point// {"/": [{"device_name": "/dev/mapper/ubuntu--vg-ubuntu--lv", - "free": 905288650752, + "free": 904885006336, "fs_type": "ext4", "key": "mnt_point", "mnt_point": "/", "percent": 5.0, "size": 1003736440832, - "used": 47385284608}]} + "used": 47788929024}]} GET gpu ------- @@ -499,7 +499,10 @@ GET load Get plugin stats:: # curl http://localhost:61208/api/4/load - {"cpucore": 16, "min1": 0.748046875, "min15": 0.57373046875, "min5": 0.7265625} + {"cpucore": 16, + "min1": 0.521484375, + "min15": 1.1435546875, + "min5": 0.9404296875} Fields descriptions: @@ -511,7 +514,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/4/load/min1 - {"min1": 0.748046875} + {"min1": 0.521484375} GET mem ------- @@ -519,16 +522,16 @@ GET mem Get plugin stats:: # curl http://localhost:61208/api/4/mem - {"active": 5833261056, - "available": 10653102080, - "buffers": 250515456, - "cached": 5880537088, - "free": 10653102080, - "inactive": 3567583232, - "percent": 35.1, - "shared": 705511424, + {"active": 8715345920, + "available": 7980945408, + "buffers": 456585216, + "cached": 7151083520, + "free": 7980945408, + "inactive": 4241293312, + "percent": 51.4, + "shared": 793468928, "total": 16422486016, - "used": 5769383936} + "used": 8441540608} Fields descriptions: @@ -555,13 +558,13 @@ GET memswap Get plugin stats:: # curl http://localhost:61208/api/4/memswap - {"free": 4294963200, + {"free": 4294176768, "percent": 0.0, "sin": 0, - "sout": 0, + "sout": 110592, "time_since_update": 1, "total": 4294963200, - "used": 0} + "used": 786432} Fields descriptions: @@ -586,15 +589,15 @@ Get plugin stats:: # curl http://localhost:61208/api/4/network [{"alias": None, "bytes_all": 0, - "bytes_all_gauge": 451852439, + "bytes_all_gauge": 1278105663, "bytes_recv": 0, - "bytes_recv_gauge": 428042038, + "bytes_recv_gauge": 979859126, "bytes_sent": 0, - "bytes_sent_gauge": 23810401, + "bytes_sent_gauge": 298246537, "interface_name": "wlp0s20f3", "key": "interface_name", "speed": 0, - "time_since_update": 0.15277767181396484}] + "time_since_update": 0.34995555877685547}] Fields descriptions: @@ -623,15 +626,15 @@ Get a specific item when field matches the given value:: # curl http://localhost:61208/api/4/network/interface_name/wlp0s20f3 {"wlp0s20f3": [{"alias": None, "bytes_all": 0, - "bytes_all_gauge": 451852439, + "bytes_all_gauge": 1278105663, "bytes_recv": 0, - "bytes_recv_gauge": 428042038, + "bytes_recv_gauge": 979859126, "bytes_sent": 0, - "bytes_sent_gauge": 23810401, + "bytes_sent_gauge": 298246537, "interface_name": "wlp0s20f3", "key": "interface_name", "speed": 0, - "time_since_update": 0.15277767181396484}]} + "time_since_update": 0.34995555877685547}]} GET now ------- @@ -639,7 +642,7 @@ GET now Get plugin stats:: # curl http://localhost:61208/api/4/now - {"custom": "2024-05-18 11:03:48 CEST", "iso": "2024-05-18T11:03:48+02:00"} + {"custom": "2024-05-25 12:07:37 CEST", "iso": "2024-05-25T12:07:37+02:00"} Fields descriptions: @@ -649,7 +652,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/4/now/iso - {"iso": "2024-05-18T11:03:48+02:00"} + {"iso": "2024-05-25T12:07:37+02:00"} GET percpu ---------- @@ -660,7 +663,7 @@ Get plugin stats:: [{"cpu_number": 0, "guest": 0.0, "guest_nice": 0.0, - "idle": 1.0, + "idle": 0.0, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", @@ -668,7 +671,7 @@ Get plugin stats:: "softirq": 0.0, "steal": 0.0, "system": 0.0, - "total": 99.0, + "total": 100.0, "user": 0.0}, {"cpu_number": 1, "guest": 0.0, @@ -716,7 +719,7 @@ Get plugin stats:: "port": 0, "refresh": 30, "rtt_warning": None, - "status": 0.004889, + "status": 0.007397, "timeout": 3}] Fields descriptions: @@ -744,7 +747,7 @@ Get a specific item when field matches the given value:: "port": 0, "refresh": 30, "rtt_warning": None, - "status": 0.004889, + "status": 0.007397, "timeout": 3}]} GET processcount @@ -753,7 +756,7 @@ GET processcount Get plugin stats:: # curl http://localhost:61208/api/4/processcount - {"pid_max": 0, "running": 0, "sleeping": 276, "thread": 1568, "total": 407} + {"pid_max": 0, "running": 1, "sleeping": 292, "thread": 1764, "total": 431} Fields descriptions: @@ -766,7 +769,7 @@ Fields descriptions: Get a specific field:: # curl http://localhost:61208/api/4/processcount/total - {"total": 407} + {"total": 431} GET processlist --------------- @@ -808,16 +811,16 @@ Get plugin stats:: # curl http://localhost:61208/api/4/quicklook {"cpu": 0.0, "cpu_hz": 4475000000.0, - "cpu_hz_current": 1871619687.4999998, + "cpu_hz_current": 1245390687.5, "cpu_log_core": 16, "cpu_name": "13th Gen Intel(R) Core(TM) i7-13620H", "cpu_phys_core": 10, - "load": 3.6, - "mem": 35.1, + "load": 7.1, + "mem": 51.4, "percpu": [{"cpu_number": 0, "guest": 0.0, "guest_nice": 0.0, - "idle": 1.0, + "idle": 0.0, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", @@ -825,7 +828,7 @@ Get plugin stats:: "softirq": 0.0, "steal": 0.0, "system": 0.0, - "total": 99.0, + "total": 100.0, "user": 0.0}, {"cpu_number": 1, "guest": 0.0, @@ -882,7 +885,7 @@ Get plugin stats:: {"cpu_number": 5, "guest": 0.0, "guest_nice": 0.0, - "idle": 1.0, + "idle": 0.0, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", @@ -890,7 +893,7 @@ Get plugin stats:: "softirq": 0.0, "steal": 0.0, "system": 0.0, - "total": 99.0, + "total": 100.0, "user": 0.0}, {"cpu_number": 6, "guest": 0.0, @@ -902,13 +905,13 @@ Get plugin stats:: "nice": 0.0, "softirq": 0.0, "steal": 0.0, - "system": 1.0, + "system": 0.0, "total": 100.0, "user": 0.0}, {"cpu_number": 7, "guest": 0.0, "guest_nice": 0.0, - "idle": 1.0, + "idle": 0.0, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", @@ -916,12 +919,12 @@ Get plugin stats:: "softirq": 0.0, "steal": 0.0, "system": 0.0, - "total": 99.0, + "total": 100.0, "user": 0.0}, {"cpu_number": 8, "guest": 0.0, "guest_nice": 0.0, - "idle": 1.0, + "idle": 0.0, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", @@ -929,12 +932,12 @@ Get plugin stats:: "softirq": 0.0, "steal": 0.0, "system": 0.0, - "total": 99.0, + "total": 100.0, "user": 0.0}, {"cpu_number": 9, "guest": 0.0, "guest_nice": 0.0, - "idle": 1.0, + "idle": 0.0, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", @@ -942,7 +945,7 @@ Get plugin stats:: "softirq": 0.0, "steal": 0.0, "system": 0.0, - "total": 99.0, + "total": 100.0, "user": 0.0}, {"cpu_number": 10, "guest": 0.0, @@ -960,7 +963,7 @@ Get plugin stats:: {"cpu_number": 11, "guest": 0.0, "guest_nice": 0.0, - "idle": 1.0, + "idle": 0.0, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", @@ -968,7 +971,7 @@ Get plugin stats:: "softirq": 0.0, "steal": 0.0, "system": 0.0, - "total": 99.0, + "total": 100.0, "user": 0.0}, {"cpu_number": 12, "guest": 0.0, @@ -999,7 +1002,7 @@ Get plugin stats:: {"cpu_number": 14, "guest": 0.0, "guest_nice": 0.0, - "idle": 1.0, + "idle": 0.0, "iowait": 0.0, "irq": 0.0, "key": "cpu_number", @@ -1007,7 +1010,7 @@ Get plugin stats:: "softirq": 0.0, "steal": 0.0, "system": 0.0, - "total": 99.0, + "total": 100.0, "user": 0.0}, {"cpu_number": 15, "guest": 0.0, @@ -1060,14 +1063,14 @@ Get plugin stats:: "label": "Ambient", "type": "SensorType.CPU_TEMP", "unit": "C", - "value": 38, + "value": 35, "warning": 0}, {"critical": None, "key": "label", "label": "Ambient 3", "type": "SensorType.CPU_TEMP", "unit": "C", - "value": 33, + "value": 30, "warning": 0}] Fields descriptions: @@ -1128,7 +1131,7 @@ Get a specific item when field matches the given value:: "label": "Ambient", "type": "SensorType.CPU_TEMP", "unit": "C", - "value": 38, + "value": 35, "warning": 0}]} GET smart @@ -1172,7 +1175,7 @@ GET uptime Get plugin stats:: # curl http://localhost:61208/api/4/uptime - "4 days, 11:56:37" + "11 days, 13:00:18" GET version ----------- @@ -1180,7 +1183,7 @@ GET version Get plugin stats:: # curl http://localhost:61208/api/4/version - "4.0.5" + "4.0.6" GET wifi -------- @@ -1248,34 +1251,34 @@ GET stats history History of a plugin:: # curl http://localhost:61208/api/4/cpu/history - {"system": [["2024-05-18T11:03:49.609837", 0.0], - ["2024-05-18T11:03:50.653488", 1.0], - ["2024-05-18T11:03:51.701403", 1.0]], - "user": [["2024-05-18T11:03:49.609825", 0.0], - ["2024-05-18T11:03:50.653484", 0.0], - ["2024-05-18T11:03:51.701393", 0.0]]} + {"system": [["2024-05-25T12:07:39.021345", 0.0], + ["2024-05-25T12:07:40.053748", 0.0], + ["2024-05-25T12:07:41.134700", 0.0]], + "user": [["2024-05-25T12:07:39.021338", 0.0], + ["2024-05-25T12:07:40.053742", 1.0], + ["2024-05-25T12:07:41.134683", 1.0]]} Limit history to last 2 values:: # curl http://localhost:61208/api/4/cpu/history/2 - {"system": [["2024-05-18T11:03:50.653488", 1.0], - ["2024-05-18T11:03:51.701403", 1.0]], - "user": [["2024-05-18T11:03:50.653484", 0.0], - ["2024-05-18T11:03:51.701393", 0.0]]} + {"system": [["2024-05-25T12:07:40.053748", 0.0], + ["2024-05-25T12:07:41.134700", 0.0]], + "user": [["2024-05-25T12:07:40.053742", 1.0], + ["2024-05-25T12:07:41.134683", 1.0]]} History for a specific field:: # curl http://localhost:61208/api/4/cpu/system/history - {"system": [["2024-05-18T11:03:48.519990", 0.0], - ["2024-05-18T11:03:49.609837", 0.0], - ["2024-05-18T11:03:50.653488", 1.0], - ["2024-05-18T11:03:51.701403", 1.0]]} + {"system": [["2024-05-25T12:07:37.851785", 0.0], + ["2024-05-25T12:07:39.021345", 0.0], + ["2024-05-25T12:07:40.053748", 0.0], + ["2024-05-25T12:07:41.134700", 0.0]]} Limit history for a specific field to last 2 values:: # curl http://localhost:61208/api/4/cpu/system/history - {"system": [["2024-05-18T11:03:50.653488", 1.0], - ["2024-05-18T11:03:51.701403", 1.0]]} + {"system": [["2024-05-25T12:07:40.053748", 0.0], + ["2024-05-25T12:07:41.134700", 0.0]]} GET limits (used for thresholds) -------------------------------- |