mirror/glances
1
0
Fork 0
mirror of https://github.com/nicolargo/glances.git synced 2026-03-13 03:17:12 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
57a8a12a68de1860fa23b7941c8dfd4a41a51cd1
glances/docs/api.rst
nicolargo 53f74248cd version 3.3.0.2
2022-10-30 14:57:18 +01:00

1439 lines
41 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 alert
---------
Get plugin stats::
# curl http://localhost:61208/api/3/alert
[[1667138120.0,
-1,
"CRITICAL",
"CPU_TOTAL",
99.9,
99.9,
99.9,
99.9,
1,
[],
"",
"cpu_percent"]]
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": 2.3771681785583496},
{"count": 0,
"countmax": 20.0,
"countmin": None,
"key": "name",
"name": "Python",
"refresh": 3.0,
"regex": True,
"result": None,
"timer": 2.374648332595825}]
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": 2.3771681785583496}]}
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": 0.2,
"interrupts": 0,
"iowait": 0.0,
"irq": 0.0,
"nice": 13.1,
"soft_interrupts": 0,
"softirq": 0.5,
"steal": 0.0,
"syscalls": 0,
"system": 23.5,
"time_since_update": 1,
"total": 99.9,
"user": 62.7}
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": 99.9}
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
[{"Command": ["/portainer"],
"Id": "3abd51c615968482d9ccff5afc629f267f6dda113ed68b75b432615fae3b49fb",
"Image": ["portainer/portainer-ce:2.9.3"],
"Status": "running",
"Uptime": "a min",
"cpu_percent": 0.0,
"io_r": None,
"io_w": None,
"key": "name",
"memory_usage": None,
"name": "portainer",
"network_rx": None,
"network_tx": None}]
GET fs
------
Get plugin stats::
# curl http://localhost:61208/api/3/fs
[{"device_name": "/dev/mapper/ubuntu--gnome--vg-root",
"free": 68973690880,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
"percent": 70.1,
"size": 243334156288,
"used": 161973010432},
{"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": 68973690880,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
"percent": 70.1,
"size": 243334156288,
"used": 161973010432}]}
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",
"public_info_human": ""}
Get a specific field::
# curl http://localhost:61208/api/3/ip/gateway
{"gateway": "192.168.0.254"}
GET load
--------
Get plugin stats::
# curl http://localhost:61208/api/3/load
{"cpucore": 4,
"min1": 8.32861328125,
"min15": 3.55517578125,
"min5": 5.59521484375}
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": 8.32861328125}
GET mem
-------
Get plugin stats::
# curl http://localhost:61208/api/3/mem
{"active": 2941202432,
"available": 3058556928,
"buffers": 245547008,
"cached": 3377664000,
"free": 3058556928,
"inactive": 3580866560,
"percent": 61.0,
"shared": 446537728,
"total": 7836188672,
"used": 4777631744}
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": 5359255552,
"percent": 33.7,
"sin": 1496064000,
"sout": 5930201088,
"time_since_update": 1,
"total": 8082419712,
"used": 2723164160}
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": 324035404,
"cumulative_rx": 162017702,
"cumulative_tx": 162017702,
"cx": 8656,
"interface_name": "lo",
"is_up": True,
"key": "interface_name",
"rx": 4328,
"speed": 0,
"time_since_update": 1,
"tx": 4328},
{"alias": None,
"cumulative_cx": 7020944105,
"cumulative_rx": 6584640933,
"cumulative_tx": 436303172,
"cx": 40118,
"interface_name": "wlp2s0",
"is_up": True,
"key": "interface_name",
"rx": 30455,
"speed": 0,
"time_since_update": 1,
"tx": 9663}]
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-87386b77b676",
"br_grafana",
"br-119e6ee04e05",
"docker0",
"mpqemubr0",
"vethfb650c2"]}
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": 324035404,
"cumulative_rx": 162017702,
"cumulative_tx": 162017702,
"cx": 8656,
"interface_name": "lo",
"is_up": True,
"key": "interface_name",
"rx": 4328,
"speed": 0,
"time_since_update": 1,
"tx": 4328}]}
GET now
-------
Get plugin stats::
# curl http://localhost:61208/api/3/now
"2022-10-30 14:55:19 CET"
GET percpu
----------
Get plugin stats::
# curl http://localhost:61208/api/3/percpu
[{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 0.3,
"iowait": 0.3,
"irq": 0.0,
"key": "cpu_number",
"nice": 2.0,
"softirq": 0.0,
"steal": 0.0,
"system": 23.1,
"total": 99.7,
"user": 74.4},
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 0.3,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.3,
"softirq": 0.0,
"steal": 0.0,
"system": 20.4,
"total": 99.7,
"user": 79.1}]
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.021405,
"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.021405,
"timeout": 3}]}
GET processcount
----------------
Get plugin stats::
# curl http://localhost:61208/api/3/processcount
{"pid_max": 0, "running": 4, "sleeping": 308, "thread": 1501, "total": 390}
Get a specific field::
# curl http://localhost:61208/api/3/processcount/total
{"total": 390}
GET processlist
---------------
Get plugin stats::
# curl http://localhost:61208/api/3/processlist
[{"cmdline": ["/usr/share/code/code",
"--ms-enable-electron-run-as-node",
"/home/nicolargo/.vscode/extensions/ms-python.vscode-pylance-2022.10.40/dist/server.bundle.js",
"--cancellationReceive=file:97bd564ed75c2175235169e7d92ebebc9051c6973a",
"--node-ipc",
"--clientProcessId=315791"],
"cpu_percent": 0.0,
"cpu_times": pcputimes(user=379.52, system=28.88, children_user=3.52, children_system=0.45, iowait=0.0),
"gids": pgids(real=1000, effective=1000, saved=1000),
"io_counters": [95522816, 733184, 0, 0, 0],
"key": "pid",
"memory_info": pmem(rss=392232960, vms=39119650816, shared=40448000, text=112652288, lib=0, data=682287104, dirty=0),
"memory_percent": 5.005404749907481,
"name": "code",
"nice": 0,
"num_threads": 15,
"pid": 315949,
"status": "R",
"time_since_update": 1,
"username": "nicolargo"},
{"cmdline": ["/snap/firefox/1943/usr/lib/firefox/firefox",
"-contentproc",
"-childID",
"1",
"-isForBrowser",
"-prefsLen",
"30965",
"-prefMapSize",
"235589",
"-jsInitLen",
"246848",
"-parentBuildID",
"20221007191409",
"-appDir",
"/snap/firefox/1943/usr/lib/firefox/browser",
"{9845d5f8-7cf9-4af9-9d46-4d914b28196f}",
"252940",
"true",
"tab"],
"cpu_percent": 0.0,
"cpu_times": pcputimes(user=636.51, system=120.75, children_user=0.0, children_system=0.0, iowait=0.0),
"gids": pgids(real=1000, effective=1000, saved=1000),
"io_counters": [44116992, 0, 0, 0, 0],
"key": "pid",
"memory_info": pmem(rss=379420672, vms=3176718336, shared=72417280, text=634880, lib=0, data=588877824, dirty=0),
"memory_percent": 4.841903224659877,
"name": "WebExtensions",
"nice": 0,
"num_threads": 20,
"pid": 253132,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"}]
Get a specific field::
# curl http://localhost:61208/api/3/processlist/pid
{"pid": [315949,
253132,
252940,
3549,
293825,
253182,
427502,
253186,
315791,
428662,
424495,
426999,
17347,
293759,
5818,
453170,
317004,
253147,
293862,
11646,
450641,
446469,
448787,
448343,
427103,
293796,
449090,
315800,
428709,
17308,
453358,
388750,
3499,
2245,
4055,
425004,
51440,
450239,
293894,
293804,
3958,
315877,
315875,
253654,
253071,
450957,
3844,
17501,
17346,
4977,
255947,
4062,
2429,
3743,
3651,
107498,
3737,
19717,
3744,
3364,
3806,
3760,
17373,
3742,
4087,
107499,
430951,
1369,
293764,
425025,
109608,
293765,
3627,
1,
1391,
425059,
3929,
453601,
17755,
2917,
17754,
1587,
17292,
17566,
1415,
3528,
3663,
1945,
1381,
3345,
3618,
3592,
2371,
3353,
3557,
3736,
2187,
3750,
2412,
1593,
3637,
3745,
3739,
3891,
1352,
1368,
11667,
3817,
1487,
51420,
1615,
180852,
3378,
17237,
3373,
1416,
54676,
14997,
294139,
3697,
450933,
452064,
3588,
1408,
16698,
3799,
1917,
3755,
1392,
3905,
3599,
3444,
1375,
3380,
15018,
3943,
3569,
3604,
3741,
1539,
3813,
17238,
1407,
3583,
3747,
3734,
1412,
3547,
3748,
3633,
3753,
3804,
3729,
1365,
3616,
1397,
3361,
3437,
4518,
282637,
17258,
3385,
2405,
3362,
3517,
54624,
1399,
1360,
3556,
1743,
2406,
1367,
1377,
2920,
450920,
1176,
450913,
450892,
450882,
1470,
17516,
3953,
293781,
181215,
452597,
58637,
58407,
293767,
54523,
1363,
181218,
3221,
181225,
4187,
1353,
453356,
181228,
453600,
2208,
3733,
3425,
58639,
2226,
3354,
2252,
1485,
181221,
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,
103,
105,
106,
108,
110,
112,
114,
118,
119,
121,
130,
133,
139,
188,
195,
196,
197,
198,
199,
200,
201,
202,
210,
211,
216,
217,
234,
283,
284,
359,
362,
386,
485,
495,
559,
560,
561,
562,
778,
779,
780,
781,
788,
789,
790,
791,
792,
793,
794,
795,
848,
849,
850,
851,
852,
853,
854,
855,
856,
857,
858,
859,
860,
861,
862,
863,
864,
865,
866,
890,
891,
898,
899,
915,
916,
917,
918,
919,
920,
921,
1891,
1897,
2256,
2266,
3584,
17240,
17274,
58642,
58643,
58644,
58645,
58646,
58647,
58648,
58649,
58650,
393410,
402735,
402736,
402737,
405762,
408876,
413643,
417539,
419011,
419088,
421434,
422634,
424786,
424787,
424793,
424794,
424798,
424799,
424800,
424802,
424803,
424804,
424852,
424855,
424997,
428574,
429232,
429437,
430079,
430202,
430203,
430204,
430738,
446547,
448820,
448926,
448927,
449488,
450140,
450640]}
Get a specific item when field matchs the given value::
# curl http://localhost:61208/api/3/processlist/pid/315949
{"315949": [{"cmdline": ["/usr/share/code/code",
"--ms-enable-electron-run-as-node",
"/home/nicolargo/.vscode/extensions/ms-python.vscode-pylance-2022.10.40/dist/server.bundle.js",
"--cancellationReceive=file:97bd564ed75c2175235169e7d92ebebc9051c6973a",
"--node-ipc",
"--clientProcessId=315791"],
"cpu_percent": 0.0,
"cpu_times": [379.52, 28.88, 3.52, 0.45, 0.0],
"gids": [1000, 1000, 1000],
"io_counters": [95522816, 733184, 0, 0, 0],
"key": "pid",
"memory_info": [392232960,
39119650816,
40448000,
112652288,
0,
682287104,
0],
"memory_percent": 5.005404749907481,
"name": "code",
"nice": 0,
"num_threads": 15,
"pid": 315949,
"status": "R",
"time_since_update": 1,
"username": "nicolargo"}]}
GET psutilversion
-----------------
Get plugin stats::
# curl http://localhost:61208/api/3/psutilversion
(5, 9, 2)
GET quicklook
-------------
Get plugin stats::
# curl http://localhost:61208/api/3/quicklook
{"cpu": 99.9,
"cpu_hz": 1700000000.0,
"cpu_hz_current": 1696051750.0,
"cpu_name": "Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz",
"mem": 61.0,
"percpu": [{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 0.3,
"iowait": 0.3,
"irq": 0.0,
"key": "cpu_number",
"nice": 2.0,
"softirq": 0.0,
"steal": 0.0,
"system": 23.1,
"total": 99.7,
"user": 74.4},
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 0.3,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.3,
"softirq": 0.0,
"steal": 0.0,
"system": 20.4,
"total": 99.7,
"user": 79.1},
{"cpu_number": 2,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 0.0,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 35.8,
"softirq": 1.5,
"steal": 0.0,
"system": 26.3,
"total": 100.0,
"user": 36.3},
{"cpu_number": 3,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 0.3,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 14.3,
"softirq": 0.8,
"steal": 0.0,
"system": 26.6,
"total": 99.7,
"user": 58.0}],
"swap": 33.7}
Get a specific field::
# curl http://localhost:61208/api/3/quicklook/cpu
{"cpu": 99.9}
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-48-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": 1314827}
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-10-30T14:55:20.666293", 23.5],
["2022-10-30T14:55:22.010041", 23.5],
["2022-10-30T14:55:23.678028", 22.4]],
"user": [["2022-10-30T14:55:20.666277", 62.7],
["2022-10-30T14:55:22.010026", 62.7],
["2022-10-30T14:55:23.678009", 67.3]]}
Limit history to last 2 values::
# curl http://localhost:61208/api/3/cpu/history/2
{"system": [["2022-10-30T14:55:22.010041", 23.5],
["2022-10-30T14:55:23.678028", 22.4]],
"user": [["2022-10-30T14:55:22.010026", 62.7],
["2022-10-30T14:55:23.678009", 67.3]]}
History for a specific field::
# curl http://localhost:61208/api/3/cpu/system/history
{"system": [["2022-10-30T14:55:20.666293", 23.5],
["2022-10-30T14:55:22.010041", 23.5],
["2022-10-30T14:55:23.678028", 22.4]]}
Limit history for a specific field to last 2 values::
# curl http://localhost:61208/api/3/cpu/system/history
{"system": [["2022-10-30T14:55:22.010041", 23.5],
["2022-10-30T14:55:23.678028", 22.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},
"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_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": 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},
"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},
"system": {"history_size": 3600.0,
"system_disable": ["False"],
"system_refresh": 60},
"uptime": {"history_size": 3600.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