mirror/glances
1
0
Fork 0
mirror of https://github.com/nicolargo/glances.git synced 2026-03-12 10:56:53 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
8bdbed3331ac3cdeaea6a52ebc8144caf24e34db
glances/docs/api.rst

1513 lines
44 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": 0.8624663352966309},
{"count": 0,
"countmax": 20.0,
"countmin": None,
"key": "name",
"name": "Python",
"refresh": 3.0,
"regex": True,
"result": None,
"timer": 0.8622386455535889}]
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": 0.8624663352966309}]}
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": 47.0,
"interrupts": 0,
"iowait": 2.2,
"irq": 0.0,
"nice": 0.0,
"soft_interrupts": 0,
"softirq": 1.0,
"steal": 0.0,
"syscalls": 0,
"system": 8.0,
"time_since_update": 1,
"total": 48.0,
"user": 41.8}
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*)
* **dpc**: *(Windows)*: time spent servicing deferred procedure calls (DPCs) (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": 48.0}
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 docker
----------
Get plugin stats::
# curl http://localhost:61208/api/3/docker
{"containers": [{"Command": ["/portainer"],
"Id": "3abd51c615968482d9ccff5afc629f267f6dda113ed68b75b432615fae3b49fb",
"Image": ["portainer/portainer-ce:2.9.3"],
"Status": "running",
"Uptime": "3 days",
"cpu": {"total": 0.0},
"cpu_percent": 0.0,
"io": {},
"io_r": None,
"io_w": None,
"key": "name",
"memory": {},
"memory_usage": None,
"name": "portainer",
"network": {},
"network_rx": None,
"network_tx": None}],
"version": {"ApiVersion": "1.41",
"Arch": "amd64",
"BuildTime": "2022-12-15T22:25:58.000000000+00:00",
"Components": [{"Details": {"ApiVersion": "1.41",
"Arch": "amd64",
"BuildTime": "2022-12-15T22:25:58.000000000+00:00",
"Experimental": "false",
"GitCommit": "42c8b31",
"GoVersion": "go1.18.9",
"KernelVersion": "5.15.0-56-generic",
"MinAPIVersion": "1.12",
"Os": "linux"},
"Name": "Engine",
"Version": "20.10.22"},
{"Details": {"GitCommit": "78f51771157abb6c9ed224c22013cdf09962315d"},
"Name": "containerd",
"Version": "1.6.13"},
{"Details": {"GitCommit": "v1.1.4-0-g5fd4c4d"},
"Name": "runc",
"Version": "1.1.4"},
{"Details": {"GitCommit": "de40ad0"},
"Name": "docker-init",
"Version": "0.19.0"}],
"GitCommit": "42c8b31",
"GoVersion": "go1.18.9",
"KernelVersion": "5.15.0-56-generic",
"MinAPIVersion": "1.12",
"Os": "linux",
"Platform": {"Name": "Docker Engine - Community"},
"Version": "20.10.22"}}
GET fs
------
Get plugin stats::
# curl http://localhost:61208/api/3/fs
[{"device_name": "/dev/mapper/ubuntu--gnome--vg-root",
"free": 54919016448,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
"percent": 76.2,
"size": 243334156288,
"used": 176027684864},
{"device_name": "zsfpool",
"free": 41811968,
"fs_type": "zfs",
"key": "mnt_point",
"mnt_point": "/zsfpool",
"percent": 0.3,
"size": 41943040,
"used": 131072}]
Get a specific field::
# curl http://localhost:61208/api/3/fs/mnt_point
{"mnt_point": ["/", "/zsfpool", "/var/snap/firefox/common/host-hunspell"]}
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": 54919016448,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
"percent": 76.2,
"size": 243334156288,
"used": 176027684864}]}
GET ip
------
Get plugin stats::
# curl http://localhost:61208/api/3/ip
{"address": "192.168.1.12",
"gateway": "192.168.1.1",
"mask": "255.255.255.0",
"mask_cidr": 24,
"public_address": "90.8.134.236",
"public_info_human": ""}
Get a specific field::
# curl http://localhost:61208/api/3/ip/gateway
{"gateway": "192.168.1.1"}
GET load
--------
Get plugin stats::
# curl http://localhost:61208/api/3/load
{"cpucore": 4, "min1": 2.5703125, "min15": 2.0634765625, "min5": 2.2353515625}
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": 2.5703125}
GET mem
-------
Get plugin stats::
# curl http://localhost:61208/api/3/mem
{"active": 3018625024,
"available": 2375323648,
"buffers": 97480704,
"cached": 2774757376,
"free": 2375323648,
"inactive": 3403993088,
"percent": 69.7,
"shared": 623783936,
"total": 7836188672,
"used": 5460865024}
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": 7836188672}
GET memswap
-----------
Get plugin stats::
# curl http://localhost:61208/api/3/memswap
{"free": 5943132160,
"percent": 26.5,
"sin": 1293230080,
"sout": 3734319104,
"time_since_update": 1,
"total": 8082419712,
"used": 2139287552}
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": 90372412,
"cumulative_rx": 45186206,
"cumulative_tx": 45186206,
"cx": 23560,
"interface_name": "lo",
"is_up": True,
"key": "interface_name",
"rx": 11780,
"speed": 0,
"time_since_update": 1,
"tx": 11780},
{"alias": None,
"cumulative_cx": 5545979740,
"cumulative_rx": 5412582465,
"cumulative_tx": 133397275,
"cx": 11955338,
"interface_name": "wlp2s0",
"is_up": True,
"key": "interface_name",
"rx": 11833811,
"speed": 0,
"time_since_update": 1,
"tx": 121527}]
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*)
* **cx**: The cumulative received+sent 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*)
* **cumulative_cx**: The cumulative number of bytes reveived and 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",
"docker0",
"br-119e6ee04e05",
"br-87386b77b676",
"br_grafana",
"mpqemubr0",
"tap-1e376645a40",
"veth7ad1596"]}
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": 90372412,
"cumulative_rx": 45186206,
"cumulative_tx": 45186206,
"cx": 23560,
"interface_name": "lo",
"is_up": True,
"key": "interface_name",
"rx": 11780,
"speed": 0,
"time_since_update": 1,
"tx": 11780}]}
GET now
-------
Get plugin stats::
# curl http://localhost:61208/api/3/now
"2022-12-21 13:50:24 CET"
GET percpu
----------
Get plugin stats::
# curl http://localhost:61208/api/3/percpu
[{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 40.0,
"iowait": 4.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 7.0,
"total": 60.0,
"user": 48.0},
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 49.0,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 4.0,
"total": 51.0,
"user": 46.0}]
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.1.1",
"indice": "port_0",
"port": 0,
"refresh": 30,
"rtt_warning": None,
"status": 0.011101,
"timeout": 3}]
Get a specific field::
# curl http://localhost:61208/api/3/ports/host
{"host": ["192.168.1.1"]}
Get a specific item when field matchs the given value::
# curl http://localhost:61208/api/3/ports/host/192.168.1.1
{"192.168.1.1": [{"description": "DefaultGateway",
"host": "192.168.1.1",
"indice": "port_0",
"port": 0,
"refresh": 30,
"rtt_warning": None,
"status": 0.011101,
"timeout": 3}]}
GET processcount
----------------
Get plugin stats::
# curl http://localhost:61208/api/3/processcount
{"pid_max": 0, "running": 1, "sleeping": 314, "thread": 1698, "total": 441}
Get a specific field::
# curl http://localhost:61208/api/3/processcount/total
{"total": 441}
GET processlist
---------------
Get plugin stats::
# curl http://localhost:61208/api/3/processlist
[{"cmdline": ["/snap/firefox/2154/usr/lib/firefox/firefox",
"-contentproc",
"-childID",
"1",
"-isForBrowser",
"-prefsLen",
"31799",
"-prefMapSize",
"234979",
"-jsInitLen",
"246704",
"-parentBuildID",
"20221128185858",
"-appDir",
"/snap/firefox/2154/usr/lib/firefox/browser",
"{8ed7e0e9-5dcf-4c35-9523-65d5178968f5}",
"4674",
"true",
"tab"],
"cpu_percent": 0.0,
"cpu_times": [544.28, 96.68, 0.0, 0.0, 0.0],
"gids": [1000, 1000, 1000],
"io_counters": [131830784, 0, 0, 0, 0],
"key": "pid",
"memory_info": [465154048, 3321061376, 73093120, 659456, 0, 731664384, 0],
"memory_percent": 5.935973053610519,
"name": "WebExtensions",
"nice": 0,
"num_threads": 22,
"pid": 4980,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"},
{"cmdline": ["/snap/firefox/2154/usr/lib/firefox/firefox"],
"cpu_percent": 0.0,
"cpu_times": [4509.1, 1511.09, 3792.22, 791.2, 0.0],
"gids": [1000, 1000, 1000],
"io_counters": [1919733760, 4714143744, 0, 0, 0],
"key": "pid",
"memory_info": [456572928, 30645571584, 117829632, 659456, 0, 1229160448, 0],
"memory_percent": 5.826466757129147,
"name": "firefox",
"nice": 0,
"num_threads": 178,
"pid": 4674,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"}]
Get a specific field::
# curl http://localhost:61208/api/3/processlist/pid
{"pid": [4980,
4674,
5464,
5110,
87895,
87518,
93773,
3699,
5113,
87474,
10499,
10094,
10140,
56113,
50931,
87407,
65742,
5000,
87546,
99360,
87753,
87995,
87994,
99579,
99462,
99838,
51406,
51412,
51549,
10551,
87616,
94497,
9953,
87853,
94498,
87445,
3586,
87570,
100353,
2510,
48450,
4426,
67307,
5690,
87454,
1653,
4206,
87779,
427,
17411,
4050,
87412,
4903,
87413,
5691,
2702,
3820,
3512,
5730,
4008,
17316,
10649,
1777,
3903,
3792,
1616,
4433,
10381,
67618,
3902,
10082,
98474,
3829,
10318,
3897,
99871,
10319,
17315,
64241,
66633,
2209,
1,
3351,
3783,
3676,
4005,
1662,
4158,
1641,
1838,
3910,
3730,
98475,
2626,
1636,
3273,
3695,
64274,
3915,
10048,
2688,
4049,
10032,
3907,
3901,
4458,
3904,
3898,
3805,
2417,
3486,
1837,
1868,
87663,
1416,
10033,
1782,
1598,
3970,
1663,
3591,
3743,
17467,
1615,
3956,
17484,
9974,
4170,
3527,
3909,
1642,
3861,
3521,
1659,
3908,
2159,
3697,
3717,
1626,
4036,
3900,
4089,
1660,
3524,
3906,
1654,
3891,
3781,
3802,
3896,
3994,
3748,
465,
3722,
5769,
3726,
3905,
3508,
3584,
3533,
1612,
1648,
3510,
3664,
1652,
1607,
3706,
2680,
1999,
1419,
1629,
1614,
1415,
2681,
10372,
5024,
1666,
3354,
4187,
17364,
100324,
1432,
67596,
1430,
87429,
4620,
2428,
98346,
98353,
1609,
67550,
67574,
3487,
67558,
4546,
87415,
67580,
1599,
99855,
100352,
10035,
3895,
2483,
3572,
98485,
2430,
2465,
2492,
1669,
1431,
98484,
2,
3,
4,
5,
7,
9,
10,
11,
12,
13,
14,
15,
16,
18,
19,
20,
21,
22,
24,
25,
26,
27,
28,
30,
31,
32,
33,
34,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
92,
93,
94,
96,
97,
98,
99,
100,
101,
104,
105,
108,
110,
112,
113,
118,
119,
120,
121,
131,
135,
141,
204,
218,
219,
220,
221,
222,
223,
224,
225,
249,
250,
255,
256,
313,
366,
367,
447,
448,
545,
614,
685,
686,
687,
694,
950,
951,
952,
953,
956,
957,
958,
959,
960,
961,
966,
967,
1021,
1022,
1023,
1024,
1025,
1026,
1027,
1028,
1029,
1030,
1031,
1032,
1033,
1034,
1035,
1036,
1037,
1038,
1039,
1056,
1057,
1065,
1066,
1083,
1084,
1085,
1086,
1087,
1088,
1089,
2188,
2190,
2491,
2527,
2539,
2586,
2587,
2589,
2590,
2592,
2598,
2599,
2606,
3780,
10063,
75477,
87199,
93508,
93821,
93822,
93824,
95614,
96086,
96234,
96378,
96637,
96797,
97087,
97324,
97895,
98051,
98052,
98553,
99561,
99632,
99639,
99684,
99738,
99739,
99740,
99741,
99742,
99743,
99744,
99745,
99746,
99747,
99748,
99749,
99750,
99751,
99752,
99753,
99754,
99755,
99756,
99757,
99758,
99759,
99760,
99761,
99762,
99763,
99764,
99765,
99766,
99767,
99768,
99769,
99770,
99771,
99772,
99773,
99774,
99775,
99776,
99777,
99778,
99779,
99780,
99781,
99782,
99783,
99784,
99785,
99786,
99787,
99788,
99789,
99790,
99791,
99792,
99793,
99794,
99795,
99796,
99797,
99798,
99799,
99800,
99801,
99802,
99804,
100030]}
Get a specific item when field matchs the given value::
# curl http://localhost:61208/api/3/processlist/pid/4980
{"4980": [{"cmdline": ["/snap/firefox/2154/usr/lib/firefox/firefox",
"-contentproc",
"-childID",
"1",
"-isForBrowser",
"-prefsLen",
"31799",
"-prefMapSize",
"234979",
"-jsInitLen",
"246704",
"-parentBuildID",
"20221128185858",
"-appDir",
"/snap/firefox/2154/usr/lib/firefox/browser",
"{8ed7e0e9-5dcf-4c35-9523-65d5178968f5}",
"4674",
"true",
"tab"],
"cpu_percent": 0.0,
"cpu_times": [544.28, 96.68, 0.0, 0.0, 0.0],
"gids": [1000, 1000, 1000],
"io_counters": [131830784, 0, 0, 0, 0],
"key": "pid",
"memory_info": [465154048,
3321061376,
73093120,
659456,
0,
731664384,
0],
"memory_percent": 5.935973053610519,
"name": "WebExtensions",
"nice": 0,
"num_threads": 22,
"pid": 4980,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"}]}
GET psutilversion
-----------------
Get plugin stats::
# curl http://localhost:61208/api/3/psutilversion
[5, 9, 4]
GET quicklook
-------------
Get plugin stats::
# curl http://localhost:61208/api/3/quicklook
{"cpu": 48.0,
"cpu_hz": 3000000000.0,
"cpu_hz_current": 2765088250.0,
"cpu_name": "Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz",
"mem": 69.7,
"percpu": [{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 40.0,
"iowait": 4.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 7.0,
"total": 60.0,
"user": 48.0},
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 49.0,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 4.0,
"total": 51.0,
"user": 46.0},
{"cpu_number": 2,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 48.0,
"iowait": 2.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 5.9,
"total": 52.0,
"user": 44.1},
{"cpu_number": 3,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 61.8,
"iowait": 2.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 2.9,
"steal": 0.0,
"system": 6.9,
"total": 38.2,
"user": 26.5}],
"swap": 26.5}
Get a specific field::
# curl http://localhost:61208/api/3/quicklook/cpu
{"cpu": 48.0}
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",
"CPU",
"Ambient",
"SODIMM",
"Package id 0",
"Core 0",
"Core 1",
"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-56-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
"9 days, 3:34:59"
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-12-21T13:50:25.001548", 8.0],
["2022-12-21T13:50:26.107518", 8.0],
["2022-12-21T13:50:27.259558", 8.0]],
"user": [["2022-12-21T13:50:25.001537", 41.8],
["2022-12-21T13:50:26.107513", 41.8],
["2022-12-21T13:50:27.259553", 44.0]]}
Limit history to last 2 values::
# curl http://localhost:61208/api/3/cpu/history/2
{"system": [["2022-12-21T13:50:26.107518", 8.0],
["2022-12-21T13:50:27.259558", 8.0]],
"user": [["2022-12-21T13:50:26.107513", 41.8],
["2022-12-21T13:50:27.259553", 44.0]]}
History for a specific field::
# curl http://localhost:61208/api/3/cpu/system/history
{"system": [["2022-12-21T13:50:25.001548", 8.0],
["2022-12-21T13:50:26.107518", 8.0],
["2022-12-21T13:50:27.259558", 8.0]]}
Limit history for a specific field to last 2 values::
# curl http://localhost:61208/api/3/cpu/system/history
{"system": [["2022-12-21T13:50:26.107518", 8.0],
["2022-12-21T13:50:27.259558", 8.0]]}
GET limits (used for thresholds)
--------------------------------
All limits/thresholds::
# curl http://localhost:61208/api/3/all/limits
{"alert": {"history_size": 1200.0},
"amps": {"amps_disable": ["False"], "history_size": 1200.0},
"cloud": {"history_size": 1200.0},
"core": {"history_size": 1200.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": 1200.0},
"diskio": {"diskio_disable": ["False"],
"diskio_hide": ["loop.*", "/dev/loop.*"],
"history_size": 1200.0},
"docker": {"docker_all": ["False"],
"docker_disable": ["False"],
"docker_max_name_size": 20.0,
"history_size": 1200.0},
"folders": {"folders_disable": ["False"], "history_size": 1200.0},
"fs": {"fs_careful": 50.0,
"fs_critical": 90.0,
"fs_disable": ["False"],
"fs_hide": ["/boot.*", "/snap.*"],
"fs_warning": 70.0,
"history_size": 1200.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": 1200.0},
"help": {"history_size": 1200.0},
"ip": {"history_size": 1200.0,
"ip_censys_fields": ["location:continent",
"location:country",
"autonomous_system:name"],
"ip_censys_url": ["https://search.censys.io/api"],
"ip_disable": ["False"],
"ip_public_ip_disabled": ["False"],
"ip_public_refresh_interval": 300.0},
"load": {"history_size": 1200.0,
"load_careful": 0.7,
"load_critical": 5.0,
"load_disable": ["False"],
"load_warning": 1.0},
"mem": {"history_size": 1200.0,
"mem_careful": 50.0,
"mem_critical": 90.0,
"mem_disable": ["False"],
"mem_warning": 70.0},
"memswap": {"history_size": 1200.0,
"memswap_careful": 50.0,
"memswap_critical": 90.0,
"memswap_disable": ["False"],
"memswap_warning": 70.0},
"network": {"history_size": 1200.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": 1200.0},
"percpu": {"history_size": 1200.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": 1200.0,
"ports_disable": ["False"],
"ports_port_default_gateway": ["True"],
"ports_refresh": 30.0,
"ports_timeout": 3.0},
"processcount": {"history_size": 1200.0, "processcount_disable": ["False"]},
"processlist": {"history_size": 1200.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": 1200.0},
"quicklook": {"history_size": 1200.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},
"sensors": {"history_size": 1200.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},
"system": {"history_size": 1200.0,
"system_disable": ["False"],
"system_refresh": 60},
"uptime": {"history_size": 1200.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": 1200.0}
Reference in New Issue View Git Blame Copy Permalink