mirror of
https://github.com/nicolargo/glances.git
synced 2026-03-12 02:46:26 -04:00
1406 lines
40 KiB
ReStructuredText
1406 lines
40 KiB
ReStructuredText
.. _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.82912278175354},
|
|
{"count": 0,
|
|
"countmax": 20.0,
|
|
"countmin": None,
|
|
"key": "name",
|
|
"name": "Python",
|
|
"refresh": 3.0,
|
|
"regex": True,
|
|
"result": None,
|
|
"timer": 0.8289539813995361}]
|
|
|
|
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.82912278175354}]}
|
|
|
|
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": 60.1,
|
|
"interrupts": 0,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"nice": 0.0,
|
|
"soft_interrupts": 0,
|
|
"softirq": 0.2,
|
|
"steal": 0.0,
|
|
"syscalls": 0,
|
|
"system": 5.3,
|
|
"time_since_update": 1,
|
|
"total": 40.6,
|
|
"user": 34.4}
|
|
|
|
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": 40.6}
|
|
|
|
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": "4 days",
|
|
"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": 64636235776,
|
|
"fs_type": "ext4",
|
|
"key": "mnt_point",
|
|
"mnt_point": "/",
|
|
"percent": 72.0,
|
|
"size": 243334156288,
|
|
"used": 166310465536},
|
|
{"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": 64636235776,
|
|
"fs_type": "ext4",
|
|
"key": "mnt_point",
|
|
"mnt_point": "/",
|
|
"percent": 72.0,
|
|
"size": 243334156288,
|
|
"used": 166310465536}]}
|
|
|
|
GET ip
|
|
------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/ip
|
|
{"address": "192.168.0.48",
|
|
"gateway": "192.168.0.254",
|
|
"mask": "255.255.255.0",
|
|
"mask_cidr": 24,
|
|
"public_address": "82.66.169.82",
|
|
"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": 1.79931640625, "min15": 1.958984375, "min5": 2.16015625}
|
|
|
|
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": 1.79931640625}
|
|
|
|
GET mem
|
|
-------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/mem
|
|
{"active": 2861182976,
|
|
"available": 2539823104,
|
|
"buffers": 288755712,
|
|
"cached": 3050266624,
|
|
"free": 2539823104,
|
|
"inactive": 3463237632,
|
|
"percent": 67.6,
|
|
"shared": 680669184,
|
|
"total": 7836188672,
|
|
"used": 5296365568}
|
|
|
|
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": 4256415744,
|
|
"percent": 47.3,
|
|
"sin": 2738352128,
|
|
"sout": 8773423104,
|
|
"time_since_update": 1,
|
|
"total": 8082419712,
|
|
"used": 3826003968}
|
|
|
|
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": 449777162,
|
|
"cumulative_rx": 224888581,
|
|
"cumulative_tx": 224888581,
|
|
"cx": 5508,
|
|
"interface_name": "lo",
|
|
"is_up": True,
|
|
"key": "interface_name",
|
|
"rx": 2754,
|
|
"speed": 0,
|
|
"time_since_update": 1,
|
|
"tx": 2754},
|
|
{"alias": None,
|
|
"cumulative_cx": 10026810126,
|
|
"cumulative_rx": 9389174147,
|
|
"cumulative_tx": 637635979,
|
|
"cx": 25944,
|
|
"interface_name": "wlp2s0",
|
|
"is_up": True,
|
|
"key": "interface_name",
|
|
"rx": 19839,
|
|
"speed": 0,
|
|
"time_since_update": 1,
|
|
"tx": 6105}]
|
|
|
|
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",
|
|
"vethfb650c2",
|
|
"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": 449777162,
|
|
"cumulative_rx": 224888581,
|
|
"cumulative_tx": 224888581,
|
|
"cx": 5508,
|
|
"interface_name": "lo",
|
|
"is_up": True,
|
|
"key": "interface_name",
|
|
"rx": 2754,
|
|
"speed": 0,
|
|
"time_since_update": 1,
|
|
"tx": 2754}]}
|
|
|
|
GET now
|
|
-------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/now
|
|
"2022-11-03 15:30:23 CET"
|
|
|
|
GET percpu
|
|
----------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/percpu
|
|
[{"cpu_number": 0,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 59.2,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 4.9,
|
|
"total": 40.8,
|
|
"user": 35.9},
|
|
{"cpu_number": 1,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 82.0,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 5.0,
|
|
"total": 18.0,
|
|
"user": 13.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.0.254",
|
|
"indice": "port_0",
|
|
"port": 0,
|
|
"refresh": 30,
|
|
"rtt_warning": None,
|
|
"status": 0.005885,
|
|
"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.005885,
|
|
"timeout": 3}]}
|
|
|
|
GET processcount
|
|
----------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/processcount
|
|
{"pid_max": 0, "running": 1, "sleeping": 326, "thread": 1654, "total": 389}
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/processcount/total
|
|
{"total": 389}
|
|
|
|
GET processlist
|
|
---------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/processlist
|
|
[{"cmdline": ["/snap/firefox/1943/usr/lib/firefox/firefox"],
|
|
"cpu_percent": 0.0,
|
|
"cpu_times": pcputimes(user=8265.26, system=2792.3, children_user=7778.43, children_system=1384.62, iowait=0.0),
|
|
"gids": pgids(real=1000, effective=1000, saved=1000),
|
|
"io_counters": [4759993344, 9648111616, 0, 0, 0],
|
|
"key": "pid",
|
|
"memory_info": pmem(rss=462217216, vms=13290643456, shared=124010496, text=634880, lib=0, data=1298190336, dirty=0),
|
|
"memory_percent": 5.898495242356513,
|
|
"name": "firefox",
|
|
"nice": 0,
|
|
"num_threads": 150,
|
|
"pid": 252940,
|
|
"status": "S",
|
|
"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=1479.73, system=286.38, children_user=0.0, children_system=0.0, iowait=0.0),
|
|
"gids": pgids(real=1000, effective=1000, saved=1000),
|
|
"io_counters": [201466880, 0, 0, 0, 0],
|
|
"key": "pid",
|
|
"memory_info": pmem(rss=448593920, vms=3538014208, shared=79355904, text=634880, lib=0, data=936325120, dirty=0),
|
|
"memory_percent": 5.724644196009476,
|
|
"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": [252940,
|
|
253132,
|
|
3549,
|
|
590528,
|
|
590488,
|
|
253182,
|
|
479037,
|
|
479255,
|
|
604831,
|
|
253186,
|
|
479104,
|
|
17347,
|
|
549166,
|
|
253147,
|
|
51440,
|
|
478972,
|
|
479089,
|
|
605726,
|
|
601048,
|
|
605889,
|
|
606596,
|
|
606103,
|
|
450641,
|
|
602074,
|
|
480067,
|
|
479007,
|
|
597870,
|
|
482393,
|
|
590512,
|
|
3499,
|
|
606696,
|
|
603305,
|
|
546430,
|
|
4055,
|
|
602075,
|
|
495478,
|
|
3958,
|
|
2245,
|
|
546431,
|
|
479112,
|
|
521697,
|
|
521756,
|
|
590492,
|
|
253071,
|
|
253654,
|
|
557500,
|
|
521757,
|
|
479015,
|
|
16698,
|
|
450239,
|
|
521726,
|
|
255947,
|
|
479296,
|
|
2917,
|
|
3651,
|
|
449090,
|
|
2429,
|
|
3844,
|
|
3364,
|
|
521696,
|
|
4977,
|
|
3744,
|
|
1369,
|
|
3743,
|
|
17566,
|
|
450957,
|
|
17373,
|
|
4062,
|
|
17754,
|
|
1,
|
|
3737,
|
|
3627,
|
|
107498,
|
|
3929,
|
|
1391,
|
|
566917,
|
|
1415,
|
|
478976,
|
|
3760,
|
|
544074,
|
|
3618,
|
|
17501,
|
|
19717,
|
|
3742,
|
|
3345,
|
|
1587,
|
|
603476,
|
|
3528,
|
|
107499,
|
|
4087,
|
|
492260,
|
|
3663,
|
|
544139,
|
|
1945,
|
|
3806,
|
|
3592,
|
|
478977,
|
|
17308,
|
|
3736,
|
|
109608,
|
|
3353,
|
|
1381,
|
|
17346,
|
|
3557,
|
|
480091,
|
|
17292,
|
|
3750,
|
|
2371,
|
|
1416,
|
|
1368,
|
|
1593,
|
|
3745,
|
|
3637,
|
|
1487,
|
|
17755,
|
|
3378,
|
|
2412,
|
|
1352,
|
|
2187,
|
|
3891,
|
|
3739,
|
|
3817,
|
|
1408,
|
|
3373,
|
|
51420,
|
|
15018,
|
|
1917,
|
|
3799,
|
|
3616,
|
|
14997,
|
|
3697,
|
|
3380,
|
|
1615,
|
|
17237,
|
|
1392,
|
|
3943,
|
|
54676,
|
|
3599,
|
|
3588,
|
|
483374,
|
|
1375,
|
|
3905,
|
|
3755,
|
|
3547,
|
|
3633,
|
|
1407,
|
|
3813,
|
|
3741,
|
|
3604,
|
|
3444,
|
|
3569,
|
|
523017,
|
|
3583,
|
|
3734,
|
|
3747,
|
|
1397,
|
|
3753,
|
|
3748,
|
|
17238,
|
|
3804,
|
|
1365,
|
|
3362,
|
|
1412,
|
|
3437,
|
|
3729,
|
|
3385,
|
|
3361,
|
|
4518,
|
|
1360,
|
|
568870,
|
|
3556,
|
|
479311,
|
|
3517,
|
|
54624,
|
|
282637,
|
|
1399,
|
|
1743,
|
|
1377,
|
|
1176,
|
|
17258,
|
|
602118,
|
|
1367,
|
|
568871,
|
|
2405,
|
|
450933,
|
|
1470,
|
|
2920,
|
|
3953,
|
|
606671,
|
|
17516,
|
|
2406,
|
|
181215,
|
|
58637,
|
|
478993,
|
|
58407,
|
|
54523,
|
|
1363,
|
|
181218,
|
|
181225,
|
|
1353,
|
|
478979,
|
|
606695,
|
|
181228,
|
|
2208,
|
|
3733,
|
|
4187,
|
|
450920,
|
|
3425,
|
|
450913,
|
|
594820,
|
|
450892,
|
|
450882,
|
|
58639,
|
|
2226,
|
|
3354,
|
|
567106,
|
|
2252,
|
|
1485,
|
|
568756,
|
|
568754,
|
|
568874,
|
|
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,
|
|
543848,
|
|
543849,
|
|
543851,
|
|
557402,
|
|
557403,
|
|
557405,
|
|
557406,
|
|
557407,
|
|
557455,
|
|
599164,
|
|
599474,
|
|
600991,
|
|
600996,
|
|
601072,
|
|
602168,
|
|
604267,
|
|
604944,
|
|
605001,
|
|
605075,
|
|
605094,
|
|
605572,
|
|
605573,
|
|
605888,
|
|
606456]}
|
|
|
|
Get a specific item when field matchs the given value::
|
|
|
|
# curl http://localhost:61208/api/3/processlist/pid/252940
|
|
{"252940": [{"cmdline": ["/snap/firefox/1943/usr/lib/firefox/firefox"],
|
|
"cpu_percent": 0.0,
|
|
"cpu_times": [8265.26, 2792.3, 7778.43, 1384.62, 0.0],
|
|
"gids": [1000, 1000, 1000],
|
|
"io_counters": [4759993344, 9648111616, 0, 0, 0],
|
|
"key": "pid",
|
|
"memory_info": [462217216,
|
|
13290643456,
|
|
124010496,
|
|
634880,
|
|
0,
|
|
1298190336,
|
|
0],
|
|
"memory_percent": 5.898495242356513,
|
|
"name": "firefox",
|
|
"nice": 0,
|
|
"num_threads": 150,
|
|
"pid": 252940,
|
|
"status": "S",
|
|
"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": 40.6,
|
|
"cpu_hz": 1700000000.0,
|
|
"cpu_hz_current": 1248027000.0,
|
|
"cpu_name": "Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz",
|
|
"mem": 67.6,
|
|
"percpu": [{"cpu_number": 0,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 59.2,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 4.9,
|
|
"total": 40.8,
|
|
"user": 35.9},
|
|
{"cpu_number": 1,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 82.0,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 5.0,
|
|
"total": 18.0,
|
|
"user": 13.0},
|
|
{"cpu_number": 2,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 64.0,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 5.0,
|
|
"total": 36.0,
|
|
"user": 31.0},
|
|
{"cpu_number": 3,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 34.3,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 1.0,
|
|
"total": 65.7,
|
|
"user": 64.7}],
|
|
"swap": 47.3}
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/quicklook/cpu
|
|
{"cpu": 40.6}
|
|
|
|
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": 1662524}
|
|
|
|
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-11-03T15:30:24.540635", 5.3],
|
|
["2022-11-03T15:30:25.618359", 5.3],
|
|
["2022-11-03T15:30:26.877869", 4.3]],
|
|
"user": [["2022-11-03T15:30:24.540625", 34.4],
|
|
["2022-11-03T15:30:25.618348", 34.4],
|
|
["2022-11-03T15:30:26.877858", 13.3]]}
|
|
|
|
Limit history to last 2 values::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/history/2
|
|
{"system": [["2022-11-03T15:30:25.618359", 5.3],
|
|
["2022-11-03T15:30:26.877869", 4.3]],
|
|
"user": [["2022-11-03T15:30:25.618348", 34.4],
|
|
["2022-11-03T15:30:26.877858", 13.3]]}
|
|
|
|
History for a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/system/history
|
|
{"system": [["2022-11-03T15:30:24.540635", 5.3],
|
|
["2022-11-03T15:30:25.618359", 5.3],
|
|
["2022-11-03T15:30:26.877869", 4.3]]}
|
|
|
|
Limit history for a specific field to last 2 values::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/system/history
|
|
{"system": [["2022-11-03T15:30:25.618359", 5.3],
|
|
["2022-11-03T15:30:26.877869", 4.3]]}
|
|
|
|
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}
|
|
|