mirror of https://github.com/nicolargo/glances.git
1365 lines
40 KiB
ReStructuredText
1365 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": 1.0426795482635498},
|
|
{"count": 0,
|
|
"countmax": 20.0,
|
|
"countmin": None,
|
|
"key": "name",
|
|
"name": "Python",
|
|
"refresh": 3.0,
|
|
"regex": True,
|
|
"result": None,
|
|
"timer": 1.0425083637237549}]
|
|
|
|
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.0426795482635498}]}
|
|
|
|
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.6,
|
|
"interrupts": 0,
|
|
"iowait": 0.2,
|
|
"irq": 0.0,
|
|
"nice": 0.0,
|
|
"soft_interrupts": 0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"syscalls": 0,
|
|
"system": 3.2,
|
|
"time_since_update": 1,
|
|
"total": 28.1,
|
|
"user": 24.0}
|
|
|
|
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.1}
|
|
|
|
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": ["/entrypoint.sh", "telegraf"],
|
|
"Id": "9230f84acadbb7bc8c087d0827389c9a87bb7c7022a1a299dcf4a5f3a441f1d3",
|
|
"Image": ["telegraf:latest"],
|
|
"Names": ["telegraf"],
|
|
"Status": "running",
|
|
"Uptime": "2 mins",
|
|
"cpu_percent": 0.0,
|
|
"io_r": None,
|
|
"io_w": None,
|
|
"key": "name",
|
|
"memory_usage": 103878656,
|
|
"name": "telegraf",
|
|
"network_rx": None,
|
|
"network_tx": None},
|
|
{"Command": ["/run.sh"],
|
|
"Id": "09d96704c3e6b6cb21657d990e3c8ae1e44bac779ded141efb8fed899563dd66",
|
|
"Image": ["grafana/grafana:latest"],
|
|
"Names": ["grafana"],
|
|
"Status": "running",
|
|
"Uptime": "2 mins",
|
|
"cpu_percent": 0.0,
|
|
"io_r": None,
|
|
"io_w": None,
|
|
"key": "name",
|
|
"memory_usage": None,
|
|
"name": "grafana",
|
|
"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": 89524908032,
|
|
"fs_type": "ext4",
|
|
"key": "mnt_point",
|
|
"mnt_point": "/",
|
|
"percent": 61.2,
|
|
"size": 243334156288,
|
|
"used": 141421793280}]
|
|
|
|
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": 89524908032,
|
|
"fs_type": "ext4",
|
|
"key": "mnt_point",
|
|
"mnt_point": "/",
|
|
"percent": 61.2,
|
|
"size": 243334156288,
|
|
"used": 141421793280}]}
|
|
|
|
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": ""}
|
|
|
|
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": 2.10107421875,
|
|
"min15": 1.04443359375,
|
|
"min5": 1.2177734375}
|
|
|
|
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.10107421875}
|
|
|
|
GET mem
|
|
-------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/mem
|
|
{"active": 1977434112,
|
|
"available": 2583166976,
|
|
"buffers": 274051072,
|
|
"cached": 2911555584,
|
|
"free": 2583166976,
|
|
"inactive": 4626870272,
|
|
"percent": 67.0,
|
|
"shared": 627933184,
|
|
"total": 7837970432,
|
|
"used": 5254803456}
|
|
|
|
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": 7837970432}
|
|
|
|
GET memswap
|
|
-----------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/memswap
|
|
{"free": 7971336192,
|
|
"percent": 1.4,
|
|
"sin": 1716224,
|
|
"sout": 112037888,
|
|
"time_since_update": 1,
|
|
"total": 8082419712,
|
|
"used": 111083520}
|
|
|
|
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": 51558900,
|
|
"cumulative_rx": 25779450,
|
|
"cumulative_tx": 25779450,
|
|
"cx": 2564,
|
|
"interface_name": "lo",
|
|
"is_up": True,
|
|
"key": "interface_name",
|
|
"rx": 1282,
|
|
"speed": 0,
|
|
"time_since_update": 1,
|
|
"tx": 1282},
|
|
{"alias": None,
|
|
"cumulative_cx": 799485477,
|
|
"cumulative_rx": 724411778,
|
|
"cumulative_tx": 75073699,
|
|
"cx": 26850,
|
|
"interface_name": "wlp2s0",
|
|
"is_up": True,
|
|
"key": "interface_name",
|
|
"rx": 20210,
|
|
"speed": 0,
|
|
"time_since_update": 1,
|
|
"tx": 6640}]
|
|
|
|
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",
|
|
"vethbbfefd1",
|
|
"veth67968bf",
|
|
"veth9beb7e9",
|
|
"vboxnet0"]}
|
|
|
|
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": 51558900,
|
|
"cumulative_rx": 25779450,
|
|
"cumulative_tx": 25779450,
|
|
"cx": 2564,
|
|
"interface_name": "lo",
|
|
"is_up": True,
|
|
"key": "interface_name",
|
|
"rx": 1282,
|
|
"speed": 0,
|
|
"time_since_update": 1,
|
|
"tx": 1282}]}
|
|
|
|
GET now
|
|
-------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/now
|
|
"2022-08-08 11:23:35 CEST"
|
|
|
|
GET percpu
|
|
----------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/percpu
|
|
[{"cpu_number": 0,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 93.3,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 1.7,
|
|
"total": 6.7,
|
|
"user": 5.0},
|
|
{"cpu_number": 1,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 95.0,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 2.5,
|
|
"total": 5.0,
|
|
"user": 2.5}]
|
|
|
|
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.005961,
|
|
"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.005961,
|
|
"timeout": 3}]}
|
|
|
|
GET processcount
|
|
----------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/processcount
|
|
{"pid_max": 0, "running": 1, "sleeping": 250, "thread": 1350, "total": 320}
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/processcount/total
|
|
{"total": 320}
|
|
|
|
GET processlist
|
|
---------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/processlist
|
|
[{"cmdline": ["/snap/firefox/1551/usr/lib/firefox/firefox",
|
|
"-contentproc",
|
|
"-childID",
|
|
"3",
|
|
"-isForBrowser",
|
|
"-prefsLen",
|
|
"40409",
|
|
"-prefMapSize",
|
|
"226824",
|
|
"-jsInitLen",
|
|
"277276",
|
|
"-parentBuildID",
|
|
"20220707183149",
|
|
"-appDir",
|
|
"/snap/firefox/1551/usr/lib/firefox/browser",
|
|
"4775",
|
|
"true",
|
|
"tab"],
|
|
"cpu_percent": 0.0,
|
|
"cpu_times": pcputimes(user=301.74, system=54.8, children_user=0.0, children_system=0.0, iowait=0.0),
|
|
"gids": pgids(real=1000, effective=1000, saved=1000),
|
|
"io_counters": [4717568, 0, 0, 0, 0],
|
|
"key": "pid",
|
|
"memory_info": pmem(rss=556769280, vms=3492495360, shared=99401728, text=630784, lib=0, data=890585088, dirty=0),
|
|
"memory_percent": 7.10348788414516,
|
|
"name": "WebExtensions",
|
|
"nice": 0,
|
|
"num_threads": 20,
|
|
"pid": 5153,
|
|
"status": "S",
|
|
"time_since_update": 1,
|
|
"username": "nicolargo"},
|
|
{"cmdline": ["/snap/firefox/1551/usr/lib/firefox/firefox"],
|
|
"cpu_percent": 0.0,
|
|
"cpu_times": pcputimes(user=1523.25, system=547.66, children_user=1342.92, children_system=204.51, iowait=0.0),
|
|
"gids": pgids(real=1000, effective=1000, saved=1000),
|
|
"io_counters": [744497152, 1817063424, 0, 0, 0],
|
|
"key": "pid",
|
|
"memory_info": pmem(rss=532205568, vms=13050781696, shared=183783424, text=630784, lib=0, data=943808512, dirty=0),
|
|
"memory_percent": 6.790094101748201,
|
|
"name": "firefox",
|
|
"nice": 0,
|
|
"num_threads": 135,
|
|
"pid": 4775,
|
|
"status": "S",
|
|
"time_since_update": 1,
|
|
"username": "nicolargo"}]
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/processlist/pid
|
|
{"pid": [5153,
|
|
4775,
|
|
13432,
|
|
4988,
|
|
13587,
|
|
3318,
|
|
18044,
|
|
13380,
|
|
11015,
|
|
68051,
|
|
4957,
|
|
13417,
|
|
13348,
|
|
13313,
|
|
70647,
|
|
3836,
|
|
70747,
|
|
11481,
|
|
68773,
|
|
70809,
|
|
2057,
|
|
70276,
|
|
1999,
|
|
71028,
|
|
71256,
|
|
3843,
|
|
71770,
|
|
13486,
|
|
3258,
|
|
6482,
|
|
13440,
|
|
343,
|
|
71993,
|
|
2242,
|
|
13633,
|
|
3615,
|
|
1402,
|
|
3419,
|
|
1279,
|
|
3737,
|
|
10466,
|
|
1363,
|
|
1452,
|
|
13366,
|
|
4929,
|
|
3395,
|
|
4071,
|
|
3432,
|
|
3510,
|
|
3349,
|
|
3113,
|
|
5002,
|
|
3509,
|
|
3557,
|
|
3500,
|
|
2186,
|
|
1257,
|
|
2724,
|
|
1242,
|
|
13317,
|
|
3385,
|
|
3868,
|
|
2223,
|
|
3530,
|
|
1778,
|
|
3508,
|
|
13318,
|
|
53326,
|
|
3288,
|
|
1289,
|
|
2002,
|
|
3503,
|
|
53372,
|
|
1434,
|
|
3197,
|
|
1,
|
|
3699,
|
|
1083,
|
|
3505,
|
|
2727,
|
|
3356,
|
|
3649,
|
|
1290,
|
|
1263,
|
|
57665,
|
|
3513,
|
|
69193,
|
|
1393,
|
|
3523,
|
|
3059,
|
|
53406,
|
|
3322,
|
|
70706,
|
|
70780,
|
|
3102,
|
|
70623,
|
|
1445,
|
|
2221,
|
|
24571,
|
|
3578,
|
|
1286,
|
|
1225,
|
|
24589,
|
|
1750,
|
|
3404,
|
|
3529,
|
|
1285,
|
|
3335,
|
|
3135,
|
|
3448,
|
|
2222,
|
|
3125,
|
|
3506,
|
|
1241,
|
|
3524,
|
|
13527,
|
|
1264,
|
|
3667,
|
|
385,
|
|
3308,
|
|
3566,
|
|
3720,
|
|
3542,
|
|
3563,
|
|
3130,
|
|
33066,
|
|
3491,
|
|
1248,
|
|
3514,
|
|
38294,
|
|
3345,
|
|
1280,
|
|
3341,
|
|
3515,
|
|
3362,
|
|
3401,
|
|
71891,
|
|
3194,
|
|
3498,
|
|
1272,
|
|
3140,
|
|
11502,
|
|
1085,
|
|
1274,
|
|
3110,
|
|
3383,
|
|
3111,
|
|
1237,
|
|
3274,
|
|
3316,
|
|
13568,
|
|
1234,
|
|
1594,
|
|
1081,
|
|
1251,
|
|
70543,
|
|
1240,
|
|
70578,
|
|
70600,
|
|
70563,
|
|
70759,
|
|
70608,
|
|
70586,
|
|
70748,
|
|
70557,
|
|
70536,
|
|
3045,
|
|
3103,
|
|
1328,
|
|
1096,
|
|
3730,
|
|
71980,
|
|
1095,
|
|
13334,
|
|
2023,
|
|
1235,
|
|
3963,
|
|
3181,
|
|
1226,
|
|
2019,
|
|
13320,
|
|
71992,
|
|
3497,
|
|
1341,
|
|
2039,
|
|
2044,
|
|
2016,
|
|
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,
|
|
103,
|
|
105,
|
|
106,
|
|
108,
|
|
109,
|
|
112,
|
|
116,
|
|
117,
|
|
129,
|
|
132,
|
|
138,
|
|
160,
|
|
187,
|
|
189,
|
|
196,
|
|
198,
|
|
199,
|
|
200,
|
|
201,
|
|
202,
|
|
203,
|
|
204,
|
|
205,
|
|
210,
|
|
211,
|
|
216,
|
|
217,
|
|
234,
|
|
281,
|
|
282,
|
|
359,
|
|
362,
|
|
384,
|
|
469,
|
|
487,
|
|
544,
|
|
546,
|
|
548,
|
|
577,
|
|
810,
|
|
811,
|
|
812,
|
|
813,
|
|
814,
|
|
815,
|
|
816,
|
|
817,
|
|
818,
|
|
819,
|
|
820,
|
|
821,
|
|
2060,
|
|
2069,
|
|
2073,
|
|
2131,
|
|
2133,
|
|
2134,
|
|
2136,
|
|
2138,
|
|
2139,
|
|
2140,
|
|
2143,
|
|
3365,
|
|
39944,
|
|
53202,
|
|
59706,
|
|
64830,
|
|
67462,
|
|
67625,
|
|
67996,
|
|
68485,
|
|
68501,
|
|
68529,
|
|
68537,
|
|
69598,
|
|
69800,
|
|
69946,
|
|
70230,
|
|
70337,
|
|
70494,
|
|
71004,
|
|
71140,
|
|
71141,
|
|
71142,
|
|
71143,
|
|
71354,
|
|
71590]}
|
|
|
|
Get a specific item when field matchs the given value::
|
|
|
|
# curl http://localhost:61208/api/3/processlist/pid/5153
|
|
{"5153": [{"cmdline": ["/snap/firefox/1551/usr/lib/firefox/firefox",
|
|
"-contentproc",
|
|
"-childID",
|
|
"3",
|
|
"-isForBrowser",
|
|
"-prefsLen",
|
|
"40409",
|
|
"-prefMapSize",
|
|
"226824",
|
|
"-jsInitLen",
|
|
"277276",
|
|
"-parentBuildID",
|
|
"20220707183149",
|
|
"-appDir",
|
|
"/snap/firefox/1551/usr/lib/firefox/browser",
|
|
"4775",
|
|
"true",
|
|
"tab"],
|
|
"cpu_percent": 0.0,
|
|
"cpu_times": [301.74, 54.8, 0.0, 0.0, 0.0],
|
|
"gids": [1000, 1000, 1000],
|
|
"io_counters": [4717568, 0, 0, 0, 0],
|
|
"key": "pid",
|
|
"memory_info": [556769280,
|
|
3492495360,
|
|
99401728,
|
|
630784,
|
|
0,
|
|
890585088,
|
|
0],
|
|
"memory_percent": 7.10348788414516,
|
|
"name": "WebExtensions",
|
|
"nice": 0,
|
|
"num_threads": 20,
|
|
"pid": 5153,
|
|
"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.1,
|
|
"cpu_hz": 1700000000.0,
|
|
"cpu_hz_current": 1015367750.0,
|
|
"cpu_name": "Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz",
|
|
"mem": 67.0,
|
|
"percpu": [{"cpu_number": 0,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 93.3,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 1.7,
|
|
"total": 6.7,
|
|
"user": 5.0},
|
|
{"cpu_number": 1,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 95.0,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 2.5,
|
|
"total": 5.0,
|
|
"user": 2.5},
|
|
{"cpu_number": 2,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 48.8,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 4.1,
|
|
"total": 51.2,
|
|
"user": 47.1},
|
|
{"cpu_number": 3,
|
|
"guest": 0.0,
|
|
"guest_nice": 0.0,
|
|
"idle": 50.4,
|
|
"iowait": 0.0,
|
|
"irq": 0.0,
|
|
"key": "cpu_number",
|
|
"nice": 0.0,
|
|
"softirq": 0.0,
|
|
"steal": 0.0,
|
|
"system": 1.7,
|
|
"total": 49.6,
|
|
"user": 47.9}],
|
|
"swap": 1.4}
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/quicklook/cpu
|
|
{"cpu": 28.1}
|
|
|
|
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-43-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": 152028}
|
|
|
|
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-08-08T11:23:36.104452", 3.2],
|
|
["2022-08-08T11:23:37.183237", 3.2],
|
|
["2022-08-08T11:23:38.374857", 1.4]],
|
|
"user": [["2022-08-08T11:23:36.104438", 24.0],
|
|
["2022-08-08T11:23:37.183226", 24.0],
|
|
["2022-08-08T11:23:38.374850", 4.1]]}
|
|
|
|
Limit history to last 2 values::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/history/2
|
|
{"system": [["2022-08-08T11:23:37.183237", 3.2],
|
|
["2022-08-08T11:23:38.374857", 1.4]],
|
|
"user": [["2022-08-08T11:23:37.183226", 24.0],
|
|
["2022-08-08T11:23:38.374850", 4.1]]}
|
|
|
|
History for a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/system/history
|
|
{"system": [["2022-08-08T11:23:36.104452", 3.2],
|
|
["2022-08-08T11:23:37.183237", 3.2],
|
|
["2022-08-08T11:23:38.374857", 1.4]]}
|
|
|
|
Limit history for a specific field to last 2 values::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/system/history
|
|
{"system": [["2022-08-08T11:23:37.183237", 3.2],
|
|
["2022-08-08T11:23:38.374857", 1.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}
|
|
|