Improve docs for Web API

This commit is contained in:
nicolargo 2024-10-06 17:49:45 +02:00
parent 702b747d9d
commit adfb642539
4 changed files with 265 additions and 239 deletions

View File

@ -142,7 +142,7 @@ Get plugin stats::
"refresh": 3.0,
"regex": True,
"result": None,
"timer": 0.42218708992004395},
"timer": 0.7245726585388184},
{"count": 0,
"countmax": 20.0,
"countmin": None,
@ -151,7 +151,7 @@ Get plugin stats::
"refresh": 3.0,
"regex": True,
"result": None,
"timer": 0.4221322536468506}]
"timer": 0.7244598865509033}]
Fields descriptions:
@ -179,7 +179,7 @@ Get a specific item when field matches the given value::
"refresh": 3.0,
"regex": True,
"result": None,
"timer": 0.42218708992004395}]}
"timer": 0.7245726585388184}]}
GET cloud
---------
@ -266,19 +266,19 @@ Get plugin stats::
# curl http://localhost:61208/api/4/cpu
{"cpucore": 16,
"ctx_switches": 40238344,
"guest": 0.2,
"idle": 91.4,
"interrupts": 34760471,
"iowait": 0.2,
"ctx_switches": 186033035,
"guest": 0.3,
"idle": 89.0,
"interrupts": 163391746,
"iowait": 0.1,
"irq": 0.0,
"nice": 0.0,
"soft_interrupts": 12479317,
"soft_interrupts": 70469321,
"steal": 0.0,
"syscalls": 0,
"system": 2.9,
"total": 9.6,
"user": 5.3}
"system": 3.7,
"total": 10.1,
"user": 7.2}
Fields descriptions:
@ -311,7 +311,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/cpu/total
{"total": 9.6}
{"total": 10.1}
GET diskio
----------
@ -321,14 +321,14 @@ Get plugin stats::
# curl http://localhost:61208/api/4/diskio
[{"disk_name": "nvme0n1",
"key": "disk_name",
"read_bytes": 4852881920,
"read_count": 195248,
"write_bytes": 6887232512,
"write_count": 430698},
"read_bytes": 6196087296,
"read_count": 287521,
"write_bytes": 12688270336,
"write_count": 809254},
{"disk_name": "nvme0n1p1",
"key": "disk_name",
"read_bytes": 7476224,
"read_count": 576,
"read_bytes": 7484416,
"read_count": 592,
"write_bytes": 5120,
"write_count": 3}]
@ -364,10 +364,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": 4852881920,
"read_count": 195248,
"write_bytes": 6887232512,
"write_count": 430698}]}
"read_bytes": 6196087296,
"read_count": 287521,
"write_bytes": 12688270336,
"write_count": 809254}]}
GET folders
-----------
@ -394,13 +394,13 @@ Get plugin stats::
# curl http://localhost:61208/api/4/fs
[{"device_name": "/dev/mapper/ubuntu--vg-ubuntu--lv",
"free": 864544976896,
"free": 863859675136,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
"percent": 9.3,
"size": 1003736440832,
"used": 88128958464}]
"used": 88814260224}]
Fields descriptions:
@ -421,13 +421,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": 864544976896,
"free": 863859675136,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
"percent": 9.3,
"size": 1003736440832,
"used": 88128958464}]}
"used": 88814260224}]}
GET gpu
-------
@ -501,9 +501,9 @@ Get plugin stats::
# curl http://localhost:61208/api/4/load
{"cpucore": 16,
"min1": 0.71142578125,
"min15": 0.7822265625,
"min5": 0.876953125}
"min1": 2.43603515625,
"min15": 1.29638671875,
"min5": 1.69775390625}
Fields descriptions:
@ -515,7 +515,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/load/min1
{"min1": 0.71142578125}
{"min1": 2.43603515625}
GET mem
-------
@ -523,16 +523,16 @@ GET mem
Get plugin stats::
# curl http://localhost:61208/api/4/mem
{"active": 7556792320,
"available": 9071140864,
"buffers": 551141376,
"cached": 6598180864,
"free": 9071140864,
"inactive": 4296208384,
"percent": 44.8,
"shared": 665219072,
{"active": 9346482176,
"available": 5247922176,
"buffers": 529915904,
"cached": 5270667264,
"free": 5247922176,
"inactive": 4611420160,
"percent": 68.0,
"shared": 804429824,
"total": 16422449152,
"used": 7351308288}
"used": 11174526976}
Fields descriptions:
@ -559,13 +559,13 @@ GET memswap
Get plugin stats::
# curl http://localhost:61208/api/4/memswap
{"free": 4294963200,
"percent": 0.0,
"sin": 0,
"sout": 0,
{"free": 4288671744,
"percent": 0.1,
"sin": 32768,
"sout": 5038080,
"time_since_update": 1,
"total": 4294963200,
"used": 0}
"used": 6291456}
Fields descriptions:
@ -590,26 +590,26 @@ Get plugin stats::
# curl http://localhost:61208/api/4/network
[{"alias": None,
"bytes_all": 0,
"bytes_all_gauge": 557202178,
"bytes_all_gauge": 969783385,
"bytes_recv": 0,
"bytes_recv_gauge": 529121961,
"bytes_recv_gauge": 849097760,
"bytes_sent": 0,
"bytes_sent_gauge": 28080217,
"bytes_sent_gauge": 120685625,
"interface_name": "wlp0s20f3",
"key": "interface_name",
"speed": 0,
"time_since_update": 0.42761683464050293},
"time_since_update": 0.7369155883789062},
{"alias": None,
"bytes_all": 0,
"bytes_all_gauge": 10108935,
"bytes_all_gauge": 21110456,
"bytes_recv": 0,
"bytes_recv_gauge": 4130802,
"bytes_recv_gauge": 8207992,
"bytes_sent": 0,
"bytes_sent_gauge": 5978133,
"bytes_sent_gauge": 12902464,
"interface_name": "mpqemubr0",
"key": "interface_name",
"speed": 10485760000,
"time_since_update": 0.42761683464050293}]
"time_since_update": 0.7369155883789062}]
Fields descriptions:
@ -638,15 +638,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": 557202178,
"bytes_all_gauge": 969783385,
"bytes_recv": 0,
"bytes_recv_gauge": 529121961,
"bytes_recv_gauge": 849097760,
"bytes_sent": 0,
"bytes_sent_gauge": 28080217,
"bytes_sent_gauge": 120685625,
"interface_name": "wlp0s20f3",
"key": "interface_name",
"speed": 0,
"time_since_update": 0.42761683464050293}]}
"time_since_update": 0.7369155883789062}]}
GET now
-------
@ -654,7 +654,7 @@ GET now
Get plugin stats::
# curl http://localhost:61208/api/4/now
{"custom": "2024-10-05 13:03:23 CEST", "iso": "2024-10-05T13:03:23+02:00"}
{"custom": "2024-10-06 17:43:30 CEST", "iso": "2024-10-06T17:43:30+02:00"}
Fields descriptions:
@ -664,7 +664,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/now/iso
{"iso": "2024-10-05T13:03:23+02:00"}
{"iso": "2024-10-06T17:43:30+02:00"}
GET percpu
----------
@ -676,7 +676,7 @@ Get plugin stats::
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 26.0,
"idle": 43.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -685,13 +685,13 @@ Get plugin stats::
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 74.0,
"user": 0.0},
"total": 57.0,
"user": 1.0},
{"cpu_number": 1,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 18.0,
"idle": 37.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -700,7 +700,7 @@ Get plugin stats::
"softirq": 0.0,
"steal": 0.0,
"system": 8.0,
"total": 82.0,
"total": 63.0,
"user": 0.0}]
Fields descriptions:
@ -737,7 +737,7 @@ Get plugin stats::
"port": 0,
"refresh": 30,
"rtt_warning": None,
"status": 0.010957,
"status": 0.004085,
"timeout": 3}]
Fields descriptions:
@ -765,7 +765,7 @@ Get a specific item when field matches the given value::
"port": 0,
"refresh": 30,
"rtt_warning": None,
"status": 0.010957,
"status": 0.004085,
"timeout": 3}]}
GET processcount
@ -774,7 +774,7 @@ GET processcount
Get plugin stats::
# curl http://localhost:61208/api/4/processcount
{"pid_max": 0, "running": 1, "sleeping": 294, "thread": 1751, "total": 439}
{"pid_max": 0, "running": 1, "sleeping": 295, "thread": 1763, "total": 438}
Fields descriptions:
@ -787,7 +787,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/processcount/total
{"total": 439}
{"total": 438}
GET processlist
---------------
@ -795,7 +795,54 @@ GET processlist
Get plugin stats::
# curl http://localhost:61208/api/4/processlist
[{"cmdline": ["/snap/multipass/13186/usr/bin/qemu-system-x86_64",
[{"cmdline": ["/snap/firefox/4698/usr/lib/firefox/firefox",
"-contentproc",
"-childID",
"5",
"-isForBrowser",
"-prefsLen",
"33303",
"-prefMapSize",
"254820",
"-jsInitLen",
"234852",
"-parentBuildID",
"20240801221602",
"-greomni",
"/snap/firefox/4698/usr/lib/firefox/omni.ja",
"-appomni",
"/snap/firefox/4698/usr/lib/firefox/browser/omni.ja",
"-appDir",
"/snap/firefox/4698/usr/lib/firefox/browser",
"{08318c1e-5a2b-428e-9896-4f6447dc89a7}",
"5010",
"true",
"tab"],
"cpu_percent": 0.0,
"cpu_times": {"children_system": 0.0,
"children_user": 0.0,
"iowait": 0.0,
"system": 54.45,
"user": 548.25},
"gids": {"effective": 1000, "real": 1000, "saved": 1000},
"io_counters": [8942592, 0, 0, 0, 0],
"key": "pid",
"memory_info": {"data": 1484795904,
"dirty": 0,
"lib": 0,
"rss": 1521016832,
"shared": 121507840,
"text": 958464,
"vms": 4004737024},
"memory_percent": 9.261814836033539,
"name": "Isolated Web Co",
"nice": 0,
"num_threads": 30,
"pid": 5650,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"},
{"cmdline": ["/snap/multipass/13186/usr/bin/qemu-system-x86_64",
"-bios",
"OVMF.fd",
"--enable-kvm",
@ -826,51 +873,26 @@ Get plugin stats::
"cpu_times": {"children_system": 0.0,
"children_user": 0.0,
"iowait": 0.0,
"system": 9.06,
"user": 77.82},
"system": 42.44,
"user": 271.41},
"gids": {"effective": 0, "real": 0, "saved": 0},
"io_counters": [0, 0, 0, 0, 0],
"key": "pid",
"memory_info": {"data": 1386672128,
"memory_info": {"data": 1389240320,
"dirty": 0,
"lib": 0,
"rss": 776978432,
"rss": 1094123520,
"shared": 14680064,
"text": 6172672,
"vms": 2676256768},
"memory_percent": 4.73119706329172,
"vms": 3951325184},
"memory_percent": 6.66236509471398,
"name": "qemu-system-x86_64",
"nice": 0,
"num_threads": 4,
"pid": 2585,
"status": "S",
"time_since_update": 1,
"username": "root"},
{"cmdline": ["/snap/firefox/4698/usr/lib/firefox/firefox"],
"cpu_percent": 0.0,
"cpu_times": {"children_system": 9.92,
"children_user": 36.32,
"iowait": 0.0,
"system": 113.83,
"user": 407.51},
"gids": {"effective": 1000, "real": 1000, "saved": 1000},
"io_counters": [413947904, 532033536, 0, 0, 0],
"key": "pid",
"memory_info": {"data": 840933376,
"dirty": 0,
"lib": 0,
"rss": 610521088,
"shared": 286732288,
"text": 958464,
"vms": 12620591104},
"memory_percent": 3.7176007205091457,
"name": "firefox",
"nice": 0,
"num_threads": 133,
"pid": 5010,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"}]
"username": "root"}]
Fields descriptions:
@ -902,19 +924,19 @@ GET quicklook
Get plugin stats::
# curl http://localhost:61208/api/4/quicklook
{"cpu": 9.6,
{"cpu": 10.1,
"cpu_hz": 4475000000.0,
"cpu_hz_current": 1838833375.0000002,
"cpu_hz_current": 825055999.9999998,
"cpu_log_core": 16,
"cpu_name": "13th Gen Intel(R) Core(TM) i7-13620H",
"cpu_phys_core": 10,
"load": 4.9,
"mem": 44.8,
"load": 8.1,
"mem": 68.0,
"percpu": [{"cpu_number": 0,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 26.0,
"idle": 43.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -923,13 +945,13 @@ Get plugin stats::
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 74.0,
"user": 0.0},
"total": 57.0,
"user": 1.0},
{"cpu_number": 1,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 18.0,
"idle": 37.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -938,13 +960,13 @@ Get plugin stats::
"softirq": 0.0,
"steal": 0.0,
"system": 8.0,
"total": 82.0,
"total": 63.0,
"user": 0.0},
{"cpu_number": 2,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 26.0,
"idle": 45.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -953,13 +975,13 @@ Get plugin stats::
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 74.0,
"user": 0.0},
"total": 55.0,
"user": 1.0},
{"cpu_number": 3,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 25.0,
"idle": 45.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -968,84 +990,9 @@ Get plugin stats::
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 75.0,
"total": 55.0,
"user": 0.0},
{"cpu_number": 4,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 17.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 7.0,
"total": 83.0,
"user": 1.0},
{"cpu_number": 5,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 26.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 74.0,
"user": 0.0},
{"cpu_number": 6,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 19.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 2.0,
"total": 81.0,
"user": 5.0},
{"cpu_number": 7,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 26.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 74.0,
"user": 0.0},
{"cpu_number": 8,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 25.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 75.0,
"user": 0.0},
{"cpu_number": 9,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
@ -1057,14 +1004,89 @@ Get plugin stats::
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"system": 8.0,
"total": 73.0,
"user": 10.0},
{"cpu_number": 5,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 45.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 55.0,
"user": 0.0},
{"cpu_number": 6,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 27.0,
"interrupt": None,
"iowait": 2.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 8.0,
"total": 73.0,
"user": 9.0},
{"cpu_number": 7,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 33.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 5.0,
"total": 67.0,
"user": 8.0},
{"cpu_number": 8,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 38.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 4.0,
"total": 62.0,
"user": 4.0},
{"cpu_number": 9,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 42.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 1.0,
"total": 58.0,
"user": 2.0},
{"cpu_number": 10,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 26.0,
"idle": 43.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -1073,13 +1095,13 @@ Get plugin stats::
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 74.0,
"user": 0.0},
"total": 57.0,
"user": 1.0},
{"cpu_number": 11,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 26.0,
"idle": 45.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -1088,13 +1110,13 @@ Get plugin stats::
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 74.0,
"total": 55.0,
"user": 0.0},
{"cpu_number": 12,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 26.0,
"idle": 42.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -1102,14 +1124,14 @@ Get plugin stats::
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 74.0,
"user": 0.0},
"system": 1.0,
"total": 58.0,
"user": 3.0},
{"cpu_number": 13,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 26.0,
"idle": 45.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -1118,13 +1140,13 @@ Get plugin stats::
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 74.0,
"total": 55.0,
"user": 0.0},
{"cpu_number": 14,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 26.0,
"idle": 45.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -1133,13 +1155,13 @@ Get plugin stats::
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 74.0,
"total": 55.0,
"user": 0.0},
{"cpu_number": 15,
"dpc": None,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 26.0,
"idle": 43.0,
"interrupt": None,
"iowait": 0.0,
"irq": 0.0,
@ -1147,10 +1169,10 @@ Get plugin stats::
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
"total": 74.0,
"user": 0.0}],
"swap": 0.0}
"system": 2.0,
"total": 57.0,
"user": 1.0}],
"swap": 0.1}
Fields descriptions:
@ -1188,14 +1210,14 @@ Get plugin stats::
"label": "Ambient",
"type": "temperature_core",
"unit": "C",
"value": 39,
"value": 36,
"warning": 0},
{"critical": None,
"key": "label",
"label": "Ambient 3",
"type": "temperature_core",
"unit": "C",
"value": 30,
"value": 29,
"warning": 0}]
Fields descriptions:
@ -1256,7 +1278,7 @@ Get a specific item when field matches the given value::
"label": "Ambient",
"type": "temperature_core",
"unit": "C",
"value": 39,
"value": 36,
"warning": 0}]}
GET smart
@ -1300,7 +1322,7 @@ GET uptime
Get plugin stats::
# curl http://localhost:61208/api/4/uptime
"1:25:27"
"1 day, 6:05:33"
GET version
-----------
@ -1326,7 +1348,7 @@ Get plugin stats::
"load_1min": 0,
"load_5min": 0,
"memory_total": 1002496000,
"memory_usage": 281051136,
"memory_usage": 296628224,
"name": "upstanding-sparrow",
"release": "Ubuntu 24.04.1 LTS",
"status": "running"}]
@ -1365,7 +1387,7 @@ Get a specific item when field matches the given value::
"load_1min": 0,
"load_5min": 0,
"memory_total": 1002496000,
"memory_usage": 281051136,
"memory_usage": 296628224,
"name": "upstanding-sparrow",
"release": "Ubuntu 24.04.1 LTS",
"status": "running"}]}
@ -1377,8 +1399,8 @@ Get plugin stats::
# curl http://localhost:61208/api/4/wifi
[{"key": "ssid",
"quality_level": -74.0,
"quality_link": 36.0,
"quality_level": -66.0,
"quality_link": 44.0,
"ssid": "wlp0s20f3"}]
Get a specific field::
@ -1390,8 +1412,8 @@ Get a specific item when field matches the given value::
# curl http://localhost:61208/api/4/wifi/ssid/wlp0s20f3
{"wlp0s20f3": [{"key": "ssid",
"quality_level": -74.0,
"quality_link": 36.0,
"quality_level": -66.0,
"quality_link": 44.0,
"ssid": "wlp0s20f3"}]}
GET all stats
@ -1436,34 +1458,34 @@ GET stats history
History of a plugin::
# curl http://localhost:61208/api/4/cpu/history
{"system": [["2024-10-05T13:03:24.551854", 2.9],
["2024-10-05T13:03:25.814621", 1.0],
["2024-10-05T13:03:26.819353", 1.0]],
"user": [["2024-10-05T13:03:24.551848", 5.3],
["2024-10-05T13:03:25.814619", 1.4],
["2024-10-05T13:03:26.819351", 1.4]]}
{"system": [["2024-10-06T17:43:31.153068", 3.7],
["2024-10-06T17:43:32.502213", 1.5],
["2024-10-06T17:43:33.512518", 1.5]],
"user": [["2024-10-06T17:43:31.153064", 7.2],
["2024-10-06T17:43:32.502209", 4.9],
["2024-10-06T17:43:33.512515", 4.9]]}
Limit history to last 2 values::
# curl http://localhost:61208/api/4/cpu/history/2
{"system": [["2024-10-05T13:03:25.814621", 1.0],
["2024-10-05T13:03:26.819353", 1.0]],
"user": [["2024-10-05T13:03:25.814619", 1.4],
["2024-10-05T13:03:26.819351", 1.4]]}
{"system": [["2024-10-06T17:43:32.502213", 1.5],
["2024-10-06T17:43:33.512518", 1.5]],
"user": [["2024-10-06T17:43:32.502209", 4.9],
["2024-10-06T17:43:33.512515", 4.9]]}
History for a specific field::
# curl http://localhost:61208/api/4/cpu/system/history
{"system": [["2024-10-05T13:03:23.461543", 2.9],
["2024-10-05T13:03:24.551854", 2.9],
["2024-10-05T13:03:25.814621", 1.0],
["2024-10-05T13:03:26.819353", 1.0]]}
{"system": [["2024-10-06T17:43:30.001941", 3.7],
["2024-10-06T17:43:31.153068", 3.7],
["2024-10-06T17:43:32.502213", 1.5],
["2024-10-06T17:43:33.512518", 1.5]]}
Limit history for a specific field to last 2 values::
# curl http://localhost:61208/api/4/cpu/system/history
{"system": [["2024-10-05T13:03:25.814621", 1.0],
["2024-10-05T13:03:26.819353", 1.0]]}
{"system": [["2024-10-06T17:43:32.502213", 1.5],
["2024-10-06T17:43:33.512518", 1.5]]}
GET limits (used for thresholds)
--------------------------------

View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "GLANCES" "1" "Oct 05, 2024" "4.2.0_beta04" "Glances"
.TH "GLANCES" "1" "Oct 06, 2024" "4.2.0_beta04" "Glances"
.SH NAME
glances \- An eye on your system
.SH SYNOPSIS

View File

@ -153,6 +153,10 @@
>.
</p>
</div>
<div>
<p><a href="/docs">API documentation</a> / <a href="/openapi.json">OpenAPI file</a></p>
</div>
<div class="row">&nbsp;</div>
<div>
<p>Press <b>h</b> to came back to Glances.</p>
</div>

File diff suppressed because one or more lines are too long