mirror/glances
1
0
Fork 0
mirror of https://github.com/nicolargo/glances.git synced 2026-03-12 19:06:48 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
c5ae552a1082cae2e8d99a52ee968d48b869ea41
glances/docs/api.rst
nicolargo 8e443d342c Resolv conflict from master
2022-07-28 18:10:35 +02:00

1288 lines
38 KiB
ReStructuredText
Raw Blame History

.. _api:
API (Restfull/JSON) documentation
=================================
The Glances Restfull/API server could be ran using the following command line:
.. code-block:: bash
# glances -w --disable-webui
Note: Change request URL api/3 by api/2 if you use Glances 2.x.
GET API status
--------------
This entry point should be used to check the API status.
It will return nothing but a 200 return code if everythin is OK.
Get the Rest API status::
# curl -I http://localhost:61208/api/3/status
"HTTP/1.0 200 OK"
GET plugins list
----------------
Get the plugins list::
# curl http://localhost:61208/api/3/pluginslist
["alert",
"amps",
"cloud",
"connections",
"core",
"cpu",
"diskio",
"docker",
"folders",
"fs",
"gpu",
"help",
"ip",
"irq",
"load",
"mem",
"memswap",
"network",
"now",
"percpu",
"ports",
"processcount",
"processlist",
"psutilversion",
"quicklook",
"raid",
"sensors",
"smart",
"system",
"uptime",
"wifi"]
GET amps
--------
Get plugin stats::
# curl http://localhost:61208/api/3/amps
[{"count": 0,
"countmax": None,
"countmin": 1.0,
"key": "name",
"name": "Dropbox",
"refresh": 3.0,
"regex": True,
"result": None,
"timer": 1.025280237197876},
{"count": 0,
"countmax": 20.0,
"countmin": None,
"key": "name",
"name": "Python",
"refresh": 3.0,
"regex": True,
"result": None,
"timer": 1.025184154510498}]
Get a specific field::
# curl http://localhost:61208/api/3/amps/name
{"name": ["Dropbox", "Python", "Conntrack", "Nginx", "Systemd", "SystemV"]}
Get a specific item when field matchs the given value::
# curl http://localhost:61208/api/3/amps/name/Dropbox
{"Dropbox": [{"count": 0,
"countmax": None,
"countmin": 1.0,
"key": "name",
"name": "Dropbox",
"refresh": 3.0,
"regex": True,
"result": None,
"timer": 1.025280237197876}]}
GET core
--------
Get plugin stats::
# curl http://localhost:61208/api/3/core
{"log": 4, "phys": 2}
Fields descriptions:
* **phys**: Number of physical cores (hyper thread CPUs are excluded) (unit is *number*)
* **log**: Number of logical CPUs. A logical CPU is the number of physical cores multiplied by the number of threads that can run on each core (unit is *number*)
Get a specific field::
# curl http://localhost:61208/api/3/core/phys
{"phys": 2}
GET cpu
-------
Get plugin stats::
# curl http://localhost:61208/api/3/cpu
{"cpucore": 4,
"ctx_switches": 0,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 72.3,
"interrupts": 0,
"iowait": 0.0,
"irq": 0.0,
"nice": 0.0,
"soft_interrupts": 0,
"softirq": 0.2,
"steal": 0.0,
"syscalls": 0,
"system": 2.2,
"time_since_update": 1,
"total": 28.3,
"user": 25.5}
Fields descriptions:
* **total**: Sum of all CPU percentages (except idle) (unit is *percent*)
* **system**: percent time spent in kernel space. System CPU time is the time spent running code in the Operating System kernel (unit is *percent*)
* **user**: CPU percent time spent in user space. User CPU time is the time spent on the processor running your program's code (or code in libraries) (unit is *percent*)
* **iowait**: *(Linux)*: percent time spent by the CPU waiting for I/O operations to complete (unit is *percent*)
* **idle**: percent of CPU used by any program. Every program or task that runs on a computer system occupies a certain amount of processing time on the CPU. If the CPU has completed all tasks it is idle (unit is *percent*)
* **irq**: *(Linux and BSD)*: percent time spent servicing/handling hardware/software interrupts. Time servicing interrupts (hardware + software) (unit is *percent*)
* **nice**: *(Unix)*: percent time occupied by user level processes with a positive nice value. The time the CPU has spent running users' processes that have been *niced* (unit is *percent*)
* **steal**: *(Linux)*: percentage of time a virtual CPU waits for a real CPU while the hypervisor is servicing another virtual processor (unit is *percent*)
* **ctx_switches**: number of context switches (voluntary + involuntary) per second. A context switch is a procedure that a computer's CPU (central processing unit) follows to change from one task (or process) to another while ensuring that the tasks do not conflict (unit is *number*)
* **interrupts**: number of interrupts per second (unit is *number*)
* **soft_interrupts**: number of software interrupts per second. Always set to 0 on Windows and SunOS (unit is *number*)
* **syscalls**: number of system calls per second. Always 0 on Linux OS (unit is *number*)
* **cpucore**: Total number of CPU core (unit is *number*)
* **time_since_update**: Number of seconds since last update (unit is *seconds*)
Get a specific field::
# curl http://localhost:61208/api/3/cpu/total
{"total": 28.3}
GET diskio
----------
Get plugin stats::
# curl http://localhost:61208/api/3/diskio
[{"disk_name": "sda",
"key": "disk_name",
"read_bytes": 0,
"read_count": 0,
"time_since_update": 1,
"write_bytes": 0,
"write_count": 0},
{"disk_name": "sda1",
"key": "disk_name",
"read_bytes": 0,
"read_count": 0,
"time_since_update": 1,
"write_bytes": 0,
"write_count": 0}]
Get a specific field::
# curl http://localhost:61208/api/3/diskio/disk_name
{"disk_name": ["sda", "sda1", "sda2", "sda5", "dm-0", "dm-1"]}
Get a specific item when field matchs the given value::
# curl http://localhost:61208/api/3/diskio/disk_name/sda
{"sda": [{"disk_name": "sda",
"key": "disk_name",
"read_bytes": 0,
"read_count": 0,
"time_since_update": 1,
"write_bytes": 0,
"write_count": 0}]}
GET fs
------
Get plugin stats::
# curl http://localhost:61208/api/3/fs
[{"device_name": "/dev/mapper/ubuntu--gnome--vg-root",
"free": 89835802624,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
"percent": 61.1,
"size": 243334156288,
"used": 141110898688}]
Get a specific field::
# curl http://localhost:61208/api/3/fs/mnt_point
{"mnt_point": ["/"]}
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": 89835802624,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
"percent": 61.1,
"size": 243334156288,
"used": 141110898688}]}
GET ip
------
Get plugin stats::
# curl http://localhost:61208/api/3/ip
{"address": "192.168.0.32",
"gateway": "192.168.0.254",
"mask": "255.255.255.0",
"mask_cidr": 24,
"public_address": "91.166.228.228"}
Get a specific field::
# curl http://localhost:61208/api/3/ip/address
{"address": "192.168.0.32"}
GET load
--------
Get plugin stats::
# curl http://localhost:61208/api/3/load
{"cpucore": 4, "min1": 0.89306640625, "min15": 0.623046875, "min5": 0.892578125}
Fields descriptions:
* **min1**: Average sum of the number of processes waiting in the run-queue plus the number currently executing over 1 minute (unit is *float*)
* **min5**: Average sum of the number of processes waiting in the run-queue plus the number currently executing over 5 minutes (unit is *float*)
* **min15**: Average sum of the number of processes waiting in the run-queue plus the number currently executing over 15 minutes (unit is *float*)
* **cpucore**: Total number of CPU core (unit is *number*)
Get a specific field::
# curl http://localhost:61208/api/3/load/min1
{"min1": 0.89306640625}
GET mem
-------
Get plugin stats::
# curl http://localhost:61208/api/3/mem
{"active": 1748742144,
"available": 3150409728,
"buffers": 661204992,
"cached": 3056963584,
"free": 3150409728,
"inactive": 4735377408,
"percent": 59.8,
"shared": 604377088,
"total": 7837962240,
"used": 4687552512}
Fields descriptions:
* **total**: Total physical memory available (unit is *bytes*)
* **available**: The actual amount of available memory that can be given instantly to processes that request more memory in bytes; this is calculated by summing different memory values depending on the platform (e.g. free + buffers + cached on Linux) and it is supposed to be used to monitor actual memory usage in a cross platform fashion (unit is *bytes*)
* **percent**: The percentage usage calculated as (total - available) / total * 100 (unit is *percent*)
* **used**: Memory used, calculated differently depending on the platform and designed for informational purposes only (unit is *bytes*)
* **free**: Memory not being used at all (zeroed) that is readily available; note that this doesn't reflect the actual memory available (use 'available' instead) (unit is *bytes*)
* **active**: *(UNIX)*: memory currently in use or very recently used, and so it is in RAM (unit is *bytes*)
* **inactive**: *(UNIX)*: memory that is marked as not used (unit is *bytes*)
* **buffers**: *(Linux, BSD)*: cache for things like file system metadata (unit is *bytes*)
* **cached**: *(Linux, BSD)*: cache for various things (unit is *bytes*)
* **wired**: *(BSD, macOS)*: memory that is marked to always stay in RAM. It is never moved to disk (unit is *bytes*)
* **shared**: *(BSD)*: memory that may be simultaneously accessed by multiple processes (unit is *bytes*)
Get a specific field::
# curl http://localhost:61208/api/3/mem/total
{"total": 7837962240}
GET memswap
-----------
Get plugin stats::
# curl http://localhost:61208/api/3/memswap
{"free": 7923298304,
"percent": 2.0,
"sin": 6930432,
"sout": 161832960,
"time_since_update": 1,
"total": 8082419712,
"used": 159121408}
Fields descriptions:
* **total**: Total swap memory (unit is *bytes*)
* **used**: Used swap memory (unit is *bytes*)
* **free**: Free swap memory (unit is *bytes*)
* **percent**: Used swap memory in percentage (unit is *percent*)
* **sin**: The number of bytes the system has swapped in from disk (cumulative) (unit is *bytes*)
* **sout**: The number of bytes the system has swapped out from disk (cumulative) (unit is *bytes*)
* **time_since_update**: Number of seconds since last update (unit is *seconds*)
Get a specific field::
# curl http://localhost:61208/api/3/memswap/total
{"total": 8082419712}
GET network
-----------
Get plugin stats::
# curl http://localhost:61208/api/3/network
[{"alias": None,
"cumulative_cx": 63263372,
"cumulative_rx": 31631686,
"cumulative_tx": 31631686,
"cx": 2240,
"interface_name": "lo",
"is_up": True,
"key": "interface_name",
"rx": 1120,
"speed": 0,
"time_since_update": 1,
"tx": 1120},
{"alias": None,
"cumulative_cx": 6121583802,
"cumulative_rx": 5987015590,
"cumulative_tx": 134568212,
"cx": 11733,
"interface_name": "wlp2s0",
"is_up": True,
"key": "interface_name",
"rx": 8809,
"speed": 0,
"time_since_update": 1,
"tx": 2924}]
Fields descriptions:
* **interface_name**: Interface name (unit is *string*)
* **alias**: Interface alias name (optional) (unit is *string*)
* **rx**: The received/input rate (in bit per second) (unit is *bps*)
* **tx**: The sent/output rate (in bit per second) (unit is *bps*)
* **cumulative_rx**: The number of bytes received through the interface (cumulative) (unit is *bytes*)
* **cumulative_tx**: The number of bytes sent through the interface (cumulative) (unit is *bytes*)
* **speed**: Maximum interface speed (in bit per second). Can return 0 on some operating-system (unit is *bps*)
* **is_up**: Is the interface up ? (unit is *bool*)
* **time_since_update**: Number of seconds since last update (unit is *seconds*)
Get a specific field::
# curl http://localhost:61208/api/3/network/interface_name
{"interface_name": ["lo",
"wlp2s0",
"br-119e6ee04e05",
"br-87386b77b676",
"br_grafana",
"docker0",
"mpqemubr0"]}
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": 63263372,
"cumulative_rx": 31631686,
"cumulative_tx": 31631686,
"cx": 2240,
"interface_name": "lo",
"is_up": True,
"key": "interface_name",
"rx": 1120,
"speed": 0,
"time_since_update": 1,
"tx": 1120}]}
GET now
-------
Get plugin stats::
# curl http://localhost:61208/api/3/now
"2022-07-28 17:47:36 CEST"
GET percpu
----------
Get plugin stats::
# curl http://localhost:61208/api/3/percpu
[{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 90.1,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 2.7,
"total": 9.9,
"user": 7.2},
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 95.5,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.9,
"total": 4.5,
"user": 3.6}]
Get a specific field::
# curl http://localhost:61208/api/3/percpu/cpu_number
{"cpu_number": [0, 1, 2, 3]}
GET ports
---------
Get plugin stats::
# curl http://localhost:61208/api/3/ports
[{"description": "DefaultGateway",
"host": "192.168.0.254",
"indice": "port_0",
"port": 0,
"refresh": 30,
"rtt_warning": None,
"status": 0.003491,
"timeout": 3}]
Get a specific field::
# curl http://localhost:61208/api/3/ports/host
{"host": ["192.168.0.254"]}
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.003491,
"timeout": 3}]}
GET processcount
----------------
Get plugin stats::
# curl http://localhost:61208/api/3/processcount
{"pid_max": 0, "running": 1, "sleeping": 230, "thread": 1172, "total": 296}
Get a specific field::
# curl http://localhost:61208/api/3/processcount/total
{"total": 296}
GET processlist
---------------
Get plugin stats::
# curl http://localhost:61208/api/3/processlist
[{"cmdline": ["/snap/firefox/1551/usr/lib/firefox/firefox"],
"cpu_percent": 0.0,
"cpu_times": pcputimes(user=1010.67, system=364.61, children_user=355.1, children_system=90.0, iowait=0.0),
"gids": pgids(real=1000, effective=1000, saved=1000),
"io_counters": [800161792, 7131361280, 0, 0, 0],
"key": "pid",
"memory_info": pmem(rss=644706304, vms=13331173376, shared=158920704, text=630784, lib=0, data=1310646272, dirty=0),
"memory_percent": 8.225432634898736,
"name": "firefox",
"nice": 0,
"num_threads": 146,
"pid": 3866,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"},
{"cmdline": ["/snap/firefox/1551/usr/lib/firefox/firefox",
"-contentproc",
"-childID",
"1",
"-isForBrowser",
"-prefsLen",
"35771",
"-prefMapSize",
"226281",
"-jsInitLen",
"277276",
"-parentBuildID",
"20220707183149",
"-appDir",
"/snap/firefox/1551/usr/lib/firefox/browser",
"3866",
"true",
"tab"],
"cpu_percent": 0.0,
"cpu_times": pcputimes(user=138.84, system=31.43, children_user=0.0, children_system=0.0, iowait=0.0),
"gids": pgids(real=1000, effective=1000, saved=1000),
"io_counters": [8065024, 0, 0, 0, 0],
"key": "pid",
"memory_info": pmem(rss=433627136, vms=3162419200, shared=83726336, text=630784, lib=0, data=573640704, dirty=0),
"memory_percent": 5.532396338770829,
"name": "WebExtensions",
"nice": 0,
"num_threads": 20,
"pid": 4232,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"}]
Get a specific field::
# curl http://localhost:61208/api/3/processlist/pid
{"pid": [3866,
4232,
4291,
12527,
3558,
3173,
13334,
12643,
12475,
4255,
12512,
12406,
12443,
3996,
6101,
52860,
52993,
53135,
53134,
53215,
1952,
2029,
12583,
4007,
12544,
3084,
53348,
5463,
2234,
12723,
3288,
3456,
1377,
8852,
12462,
1273,
343,
1374,
1446,
4105,
3256,
3638,
2977,
3319,
4311,
3213,
2160,
1236,
3370,
1251,
3247,
3369,
3523,
5576,
2195,
3364,
1772,
12412,
9801,
3378,
1284,
3368,
2865,
1955,
1432,
12413,
3150,
9884,
4033,
1077,
3605,
1,
3383,
3365,
3064,
1257,
3522,
3372,
6775,
3184,
1369,
2768,
3222,
9895,
2966,
2868,
1429,
3375,
1285,
2190,
1282,
3422,
14980,
3272,
15002,
1742,
1280,
3377,
1218,
6122,
3309,
2996,
2191,
3194,
1235,
389,
3174,
12681,
3366,
3376,
3570,
1258,
3529,
2991,
3414,
3519,
3615,
3348,
1243,
3207,
52896,
2988,
1276,
3265,
1265,
3373,
3374,
3227,
3363,
3199,
3005,
3061,
1079,
1271,
2974,
2975,
3245,
1231,
3139,
3181,
1227,
6177,
2967,
1588,
1245,
1076,
1234,
3804,
1290,
3632,
1089,
53333,
1088,
1974,
12429,
1229,
4224,
3047,
1219,
53347,
1976,
3360,
1294,
2021,
1978,
1962,
12415,
2,
3,
4,
5,
7,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
23,
24,
25,
26,
27,
29,
30,
31,
32,
33,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
91,
92,
93,
95,
96,
97,
98,
99,
100,
102,
104,
105,
107,
110,
112,
117,
118,
119,
129,
132,
138,
187,
188,
195,
196,
197,
198,
199,
200,
201,
202,
203,
209,
210,
215,
217,
234,
282,
283,
363,
364,
390,
498,
534,
569,
576,
577,
578,
800,
801,
802,
803,
808,
809,
810,
811,
812,
813,
814,
815,
2006,
2048,
2072,
2127,
2128,
2131,
2132,
2133,
2134,
2136,
2138,
3244,
9667,
12922,
19063,
49473,
49810,
50045,
50203,
50501,
50684,
51522,
51523,
51717,
51914,
52048,
52159,
52947,
52970,
53065,
53329,
53330]}
Get a specific item when field matchs the given value::
# curl http://localhost:61208/api/3/processlist/pid/3866
{"3866": [{"cmdline": ["/snap/firefox/1551/usr/lib/firefox/firefox"],
"cpu_percent": 0.0,
"cpu_times": [1010.67, 364.61, 355.1, 90.0, 0.0],
"gids": [1000, 1000, 1000],
"io_counters": [800161792, 7131361280, 0, 0, 0],
"key": "pid",
"memory_info": [644706304,
13331173376,
158920704,
630784,
0,
1310646272,
0],
"memory_percent": 8.225432634898736,
"name": "firefox",
"nice": 0,
"num_threads": 146,
"pid": 3866,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"}]}
GET psutilversion
-----------------
Get plugin stats::
# curl http://localhost:61208/api/3/psutilversion
(5, 9, 1)
GET quicklook
-------------
Get plugin stats::
# curl http://localhost:61208/api/3/quicklook
{"cpu": 28.3,
"cpu_hz": 3000000000.0,
"cpu_hz_current": 1605956000.0000002,
"cpu_name": "Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz",
"mem": 59.8,
"percpu": [{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 90.1,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 2.7,
"total": 9.9,
"user": 7.2},
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 95.5,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.9,
"total": 4.5,
"user": 3.6},
{"cpu_number": 2,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 23.2,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 3.6,
"total": 76.8,
"user": 73.2},
{"cpu_number": 3,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 77.5,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.9,
"total": 22.5,
"user": 21.6}],
"swap": 2.0}
Get a specific field::
# curl http://localhost:61208/api/3/quicklook/cpu
{"cpu": 28.3}
GET sensors
-----------
Get plugin stats::
# curl http://localhost:61208/api/3/sensors
[{"critical": 105,
"key": "label",
"label": "acpitz 1",
"type": "temperature_core",
"unit": "C",
"value": 27,
"warning": 105},
{"critical": 105,
"key": "label",
"label": "acpitz 2",
"type": "temperature_core",
"unit": "C",
"value": 29,
"warning": 105}]
Get a specific field::
# curl http://localhost:61208/api/3/sensors/label
{"label": ["acpitz 1",
"acpitz 2",
"Package id 0",
"Core 0",
"Core 1",
"CPU",
"Ambient",
"SODIMM",
"BAT BAT0"]}
Get a specific item when field matchs the given value::
# curl http://localhost:61208/api/3/sensors/label/acpitz 1
{"acpitz 1": [{"critical": 105,
"key": "label",
"label": "acpitz 1",
"type": "temperature_core",
"unit": "C",
"value": 27,
"warning": 105}]}
GET system
----------
Get plugin stats::
# curl http://localhost:61208/api/3/system
{"hostname": "XPS13-9333",
"hr_name": "Ubuntu 22.04 64bit",
"linux_distro": "Ubuntu 22.04",
"os_name": "Linux",
"os_version": "5.15.0-41-generic",
"platform": "64bit"}
Get a specific field::
# curl http://localhost:61208/api/3/system/os_name
{"os_name": "Linux"}
GET uptime
----------
Get plugin stats::
# curl http://localhost:61208/api/3/uptime
{"seconds": 81023}
GET all stats
-------------
Get all Glances stats::
# curl http://localhost:61208/api/3/all
Return a very big dictionnary (avoid using this request, performances will be poor)...
GET stats history
-----------------
History of a plugin::
# curl http://localhost:61208/api/3/cpu/history
{"system": [["2022-07-28T17:47:37.780462", 2.2],
["2022-07-28T17:47:38.809590", 2.2],
["2022-07-28T17:47:39.883006", 0.4]],
"user": [["2022-07-28T17:47:37.780457", 25.5],
["2022-07-28T17:47:38.809586", 25.5],
["2022-07-28T17:47:39.883002", 1.7]]}
Limit history to last 2 values::
# curl http://localhost:61208/api/3/cpu/history/2
{"system": [["2022-07-28T17:47:38.809590", 2.2],
["2022-07-28T17:47:39.883006", 0.4]],
"user": [["2022-07-28T17:47:38.809586", 25.5],
["2022-07-28T17:47:39.883002", 1.7]]}
History for a specific field::
# curl http://localhost:61208/api/3/cpu/system/history
{"system": [["2022-07-28T17:47:37.780462", 2.2],
["2022-07-28T17:47:38.809590", 2.2],
["2022-07-28T17:47:39.883006", 0.4]]}
Limit history for a specific field to last 2 values::
# curl http://localhost:61208/api/3/cpu/system/history
{"system": [["2022-07-28T17:47:38.809590", 2.2],
["2022-07-28T17:47:39.883006", 0.4]]}
GET limits (used for thresholds)
--------------------------------
All limits/thresholds::
# curl http://localhost:61208/api/3/all/limits
{"alert": {"history_size": 3600.0},
"amps": {"amps_disable": ["False"], "history_size": 3600.0},
"cloud": {"history_size": 3600.0},
"connections": {"connections_disable": ["True"],
"connections_nf_conntrack_percent_careful": 70.0,
"connections_nf_conntrack_percent_critical": 90.0,
"connections_nf_conntrack_percent_warning": 80.0,
"history_size": 3600.0},
"core": {"history_size": 3600.0},
"cpu": {"cpu_ctx_switches_careful": 160000.0,
"cpu_ctx_switches_critical": 200000.0,
"cpu_ctx_switches_warning": 180000.0,
"cpu_disable": ["False"],
"cpu_iowait_careful": 20.0,
"cpu_iowait_critical": 25.0,
"cpu_iowait_warning": 22.5,
"cpu_steal_careful": 50.0,
"cpu_steal_critical": 90.0,
"cpu_steal_warning": 70.0,
"cpu_system_careful": 50.0,
"cpu_system_critical": 90.0,
"cpu_system_log": ["False"],
"cpu_system_warning": 70.0,
"cpu_total_careful": 65.0,
"cpu_total_critical": 85.0,
"cpu_total_log": ["True"],
"cpu_total_warning": 75.0,
"cpu_user_careful": 50.0,
"cpu_user_critical": 90.0,
"cpu_user_log": ["False"],
"cpu_user_warning": 70.0,
"history_size": 3600.0},
"diskio": {"diskio_disable": ["False"],
"diskio_hide": ["loop.*", "/dev/loop*"],
"history_size": 3600.0},
"docker": {"docker_all": ["False"],
"docker_disable": ["False"],
"docker_max_name_size": 20.0,
"history_size": 3600.0},
"folders": {"folders_disable": ["False"], "history_size": 3600.0},
"fs": {"fs_careful": 50.0,
"fs_critical": 90.0,
"fs_disable": ["False"],
"fs_hide": ["/boot.*", "/snap.*"],
"fs_warning": 70.0,
"history_size": 3600.0},
"gpu": {"gpu_disable": ["False"],
"gpu_mem_careful": 50.0,
"gpu_mem_critical": 90.0,
"gpu_mem_warning": 70.0,
"gpu_proc_careful": 50.0,
"gpu_proc_critical": 90.0,
"gpu_proc_warning": 70.0,
"history_size": 3600.0},
"help": {"history_size": 3600.0},
"ip": {"history_size": 3600.0, "ip_disable": ["False"]},
"irq": {"history_size": 3600.0, "irq_disable": ["True"]},
"load": {"history_size": 3600.0,
"load_careful": 0.7,
"load_critical": 5.0,
"load_disable": ["False"],
"load_warning": 1.0},
"mem": {"history_size": 3600.0,
"mem_careful": 50.0,
"mem_critical": 90.0,
"mem_disable": ["False"],
"mem_warning": 70.0},
"memswap": {"history_size": 3600.0,
"memswap_careful": 50.0,
"memswap_critical": 90.0,
"memswap_disable": ["False"],
"memswap_warning": 70.0},
"network": {"history_size": 3600.0,
"network_disable": ["False"],
"network_rx_careful": 70.0,
"network_rx_critical": 90.0,
"network_rx_warning": 80.0,
"network_tx_careful": 70.0,
"network_tx_critical": 90.0,
"network_tx_warning": 80.0},
"now": {"history_size": 3600.0},
"percpu": {"history_size": 3600.0,
"percpu_disable": ["False"],
"percpu_iowait_careful": 50.0,
"percpu_iowait_critical": 90.0,
"percpu_iowait_warning": 70.0,
"percpu_system_careful": 50.0,
"percpu_system_critical": 90.0,
"percpu_system_warning": 70.0,
"percpu_user_careful": 50.0,
"percpu_user_critical": 90.0,
"percpu_user_warning": 70.0},
"ports": {"history_size": 3600.0,
"ports_disable": ["False"],
"ports_port_default_gateway": ["True"],
"ports_refresh": 30.0,
"ports_timeout": 3.0},
"processcount": {"history_size": 3600.0, "processcount_disable": ["False"]},
"processlist": {"history_size": 3600.0,
"processlist_cpu_careful": 50.0,
"processlist_cpu_critical": 90.0,
"processlist_cpu_warning": 70.0,
"processlist_disable": ["False"],
"processlist_mem_careful": 50.0,
"processlist_mem_critical": 90.0,
"processlist_mem_warning": 70.0,
"processlist_nice_warning": ["-20",
"-19",
"-18",
"-17",
"-16",
"-15",
"-14",
"-13",
"-12",
"-11",
"-10",
"-9",
"-8",
"-7",
"-6",
"-5",
"-4",
"-3",
"-2",
"-1",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19"]},
"psutilversion": {"history_size": 3600.0},
"quicklook": {"history_size": 3600.0,
"quicklook_cpu_careful": 50.0,
"quicklook_cpu_critical": 90.0,
"quicklook_cpu_warning": 70.0,
"quicklook_disable": ["False"],
"quicklook_mem_careful": 50.0,
"quicklook_mem_critical": 90.0,
"quicklook_mem_warning": 70.0,
"quicklook_percentage_char": ["|"],
"quicklook_swap_careful": 50.0,
"quicklook_swap_critical": 90.0,
"quicklook_swap_warning": 70.0},
"raid": {"history_size": 3600.0, "raid_disable": ["True"]},
"sensors": {"history_size": 3600.0,
"sensors_battery_careful": 80.0,
"sensors_battery_critical": 95.0,
"sensors_battery_warning": 90.0,
"sensors_disable": ["False"],
"sensors_refresh": 4.0,
"sensors_temperature_core_careful": 60.0,
"sensors_temperature_core_critical": 80.0,
"sensors_temperature_core_warning": 70.0,
"sensors_temperature_hdd_careful": 45.0,
"sensors_temperature_hdd_critical": 60.0,
"sensors_temperature_hdd_warning": 52.0},
"smart": {"history_size": 3600.0, "smart_disable": ["True"]},
"system": {"history_size": 3600.0,
"system_disable": ["False"],
"system_refresh": 60},
"uptime": {"history_size": 3600.0},
"wifi": {"history_size": 3600.0,
"wifi_careful": -65.0,
"wifi_critical": -85.0,
"wifi_disable": ["True"],
"wifi_hide": ["lo", "docker.*"],
"wifi_warning": -75.0}}
Limits/thresholds for the cpu plugin::
# curl http://localhost:61208/api/3/cpu/limits
{"cpu_ctx_switches_careful": 160000.0,
"cpu_ctx_switches_critical": 200000.0,
"cpu_ctx_switches_warning": 180000.0,
"cpu_disable": ["False"],
"cpu_iowait_careful": 20.0,
"cpu_iowait_critical": 25.0,
"cpu_iowait_warning": 22.5,
"cpu_steal_careful": 50.0,
"cpu_steal_critical": 90.0,
"cpu_steal_warning": 70.0,
"cpu_system_careful": 50.0,
"cpu_system_critical": 90.0,
"cpu_system_log": ["False"],
"cpu_system_warning": 70.0,
"cpu_total_careful": 65.0,
"cpu_total_critical": 85.0,
"cpu_total_log": ["True"],
"cpu_total_warning": 75.0,
"cpu_user_careful": 50.0,
"cpu_user_critical": 90.0,
"cpu_user_log": ["False"],
"cpu_user_warning": 70.0,
"history_size": 3600.0}
Reference in New Issue View Git Blame Copy Permalink