2016-03-02 15:29:19 +03:00
.. _api:
2021-07-17 10:31:07 +03:00
API (Restfull/JSON) documentation
=================================
2016-03-02 15:29:19 +03:00
2021-07-17 10:31:07 +03:00
The Glances Restfull/API server could be ran using the following command line:
2016-03-02 15:29:19 +03:00
2021-07-17 10:31:07 +03:00
.. code-block :: bash
2016-03-02 15:29:19 +03:00
2021-07-17 10:31:07 +03:00
# glances -w --disable-webui
Note: Change request URL api/3 by api/2 if you use Glances 2.x.
GET Plugins list
----------------
2021-07-17 10:44:21 +03:00
.. code-block :: json
2021-07-17 10:31:07 +03:00
# 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
---------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/alert
2021-07-17 10:44:21 +03:00
[[1626507830.0,
2021-07-17 10:31:07 +03:00
-1,
'WARNING',
'MEM',
2021-07-17 10:44:21 +03:00
75.6720721190852,
75.6720721190852,
75.6720721190852,
75.6720721190852,
2021-07-17 10:31:07 +03:00
1,
[],
'',
'memory_percent']]
GET amps
--------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# 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,
2021-07-17 10:44:21 +03:00
'timer': 0.11265683174133301},
2021-07-17 10:31:07 +03:00
{'count': 0,
'countmax': 20.0,
'countmin': None,
'key': 'name',
'name': 'Python',
'refresh': 3.0,
'regex': True,
'result': None,
2021-07-17 10:44:21 +03:00
'timer': 0.11254549026489258}]
2021-07-17 10:31:07 +03:00
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/amps/name
{'name': ['Dropbox', 'Python', 'Conntrack', 'Nginx', 'Systemd', 'SystemV']}
2021-07-17 10:44:21 +03:00
Get a specific item when field matchs the given value::
2021-07-17 10:31:07 +03:00
# 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,
2021-07-17 10:44:21 +03:00
'timer': 0.11265683174133301}]}
2021-07-17 10:31:07 +03:00
GET core
--------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# 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* )
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/core/phys
{'phys': 2}
GET cpu
-------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/cpu
{'cpucore': 4,
'ctx_switches': 0,
'guest': 0.0,
'guest_nice': 0.0,
2021-07-17 10:44:21 +03:00
'idle': 68.6,
2021-07-17 10:31:07 +03:00
'interrupts': 0,
'iowait': 0.0,
'irq': 0.0,
'nice': 0.0,
'soft_interrupts': 0,
2021-07-17 10:44:21 +03:00
'softirq': 5.0,
2021-07-17 10:31:07 +03:00
'steal': 0.0,
'syscalls': 0,
2021-07-17 10:44:21 +03:00
'system': 5.0,
2021-07-17 10:31:07 +03:00
'time_since_update': 1,
2021-07-17 10:44:21 +03:00
'total': 31.4,
'user': 21.4}
2021-07-17 10:31:07 +03:00
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 *percent* )
* **interrupts** : number of interrupts per second (unit is *percent* )
* **soft_interrupts** : number of software interrupts per second. Always set to 0 on Windows and SunOS (unit is *percent* )
* **cpucore** : Total number of CPU core (unit is *number* )
* **time_since_update** : Number of seconds since last update (unit is *seconds* )
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/cpu/total
2021-07-17 10:44:21 +03:00
{'total': 31.4}
2021-07-17 10:31:07 +03:00
GET diskio
----------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# 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}]
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/diskio/disk_name
{'disk_name': ['sda', 'sda1', 'sda2', 'sda5', 'dm-0', 'dm-1', 'sdc', 'sdc1']}
2021-07-17 10:44:21 +03:00
Get a specific item when field matchs the given value::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/diskio/disk_name/sda
{'sda': [{'disk_name': 'sda',
'key': 'disk_name',
'read_bytes': 0,
'read_count': 0,
'time_since_update': 1,
'write_bytes': 0,
'write_count': 0}]}
GET fs
------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/fs
[{'device_name': '/dev/mapper/ubuntu--gnome--vg-root',
2021-07-17 10:44:21 +03:00
'free': 36253220864,
2021-07-17 10:31:07 +03:00
'fs_type': 'ext4',
'key': 'mnt_point',
'mnt_point': '/',
'percent': 84.3,
'size': 243396149248,
2021-07-17 10:44:21 +03:00
'used': 194755473408},
2021-07-17 10:31:07 +03:00
{'device_name': '/dev/sdc1',
'free': 3814915088384,
'fs_type': 'fuseblk',
'key': 'mnt_point',
'mnt_point': '/media/nicolargo/Elements',
'percent': 4.6,
'size': 4000750497792,
'used': 185835409408}]
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/fs/mnt_point
{'mnt_point': ['/', '/media/nicolargo/Elements']}
2021-07-17 10:44:21 +03:00
Get a specific item when field matchs the given value::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/fs/mnt_point//
{'/': [{'device_name': '/dev/mapper/ubuntu--gnome--vg-root',
2021-07-17 10:44:21 +03:00
'free': 36253220864,
2021-07-17 10:31:07 +03:00
'fs_type': 'ext4',
'key': 'mnt_point',
'mnt_point': '/',
'percent': 84.3,
'size': 243396149248,
2021-07-17 10:44:21 +03:00
'used': 194755473408}]}
2021-07-17 10:31:07 +03:00
GET ip
------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/ip
{'address': '192.168.43.139',
'gateway': '192.168.43.136',
'mask': '255.255.255.0',
'mask_cidr': 24}
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/ip/address
{'address': '192.168.43.139'}
GET load
--------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/load
2021-07-17 10:44:21 +03:00
{'cpucore': 4, 'min1': 1.29, 'min15': 1.01, 'min5': 1.08}
2021-07-17 10:31:07 +03:00
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 *number* )
* **min5** : Average sum of the number of processes waiting in the run-queue plus the number currently executing over 5 minutes (unit is *number* )
* **min15** : Average sum of the number of processes waiting in the run-queue plus the number currently executing over 15 minutes (unit is *number* )
* **cpucore** : Total number of CPU core (unit is *number* )
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/load/min1
2021-07-17 10:44:21 +03:00
{'min1': 1.29}
2021-07-17 10:31:07 +03:00
GET mem
-------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/mem
2021-07-17 10:44:21 +03:00
{'active': 4897742848,
'available': 1909514240,
'buffers': 694054912,
'cached': 1825673216,
'free': 1909514240,
'inactive': 1632006144,
'percent': 75.7,
'shared': 692854784,
2021-07-17 10:31:07 +03:00
'total': 7849062400,
2021-07-17 10:44:21 +03:00
'used': 5939548160}
2021-07-17 10:31:07 +03:00
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* )
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/mem/total
{'total': 7849062400}
GET memswap
-----------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/memswap
{'free': 6102118400,
'percent': 24.5,
2021-07-17 10:44:21 +03:00
'sin': 8697958400,
2021-07-17 10:31:07 +03:00
'sout': 13157560320,
'time_since_update': 1,
'total': 8082419712,
'used': 1980301312}
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* )
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/memswap/total
{'total': 8082419712}
GET network
-----------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/network
[{'alias': None,
'cumulative_cx': 0,
'cumulative_rx': 0,
'cumulative_tx': 0,
'cx': 0,
'interface_name': 'mpqemubr0-dummy',
'is_up': False,
'key': 'interface_name',
'rx': 0,
'speed': 0,
'time_since_update': 1,
'tx': 0},
{'alias': None,
2021-07-17 10:44:21 +03:00
'cumulative_cx': 3716936768,
'cumulative_rx': 1858468384,
'cumulative_tx': 1858468384,
2021-07-17 10:31:07 +03:00
'cx': 200,
'interface_name': 'lo',
'is_up': True,
'key': 'interface_name',
'rx': 100,
'speed': 0,
'time_since_update': 1,
'tx': 100}]
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* )
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/network/interface_name
{'interface_name': ['mpqemubr0-dummy',
'lo',
'mpqemubr0',
'tap-838a195875f',
'docker0',
'wlp2s0',
'br-119e6ee04e05',
'vboxnet0',
'br-87386b77b676']}
2021-07-17 10:44:21 +03:00
Get a specific item when field matchs the given value::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/network/interface_name/mpqemubr0-dummy
{'mpqemubr0-dummy': [{'alias': None,
'cumulative_cx': 0,
'cumulative_rx': 0,
'cumulative_tx': 0,
'cx': 0,
'interface_name': 'mpqemubr0-dummy',
'is_up': False,
'key': 'interface_name',
'rx': 0,
'speed': 0,
'time_since_update': 1,
'tx': 0}]}
GET now
-------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/now
2021-07-17 10:44:21 +03:00
'2021-07-17 09:43:50 CEST'
2021-07-17 10:31:07 +03:00
GET percpu
----------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/percpu
[{'cpu_number': 0,
'guest': 0.0,
'guest_nice': 0.0,
2021-07-17 10:44:21 +03:00
'idle': 7.0,
2021-07-17 10:31:07 +03:00
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
2021-07-17 10:44:21 +03:00
'softirq': 0.0,
2021-07-17 10:31:07 +03:00
'steal': 0.0,
2021-07-17 10:44:21 +03:00
'system': 2.0,
'total': 93.0,
'user': 16.0},
2021-07-17 10:31:07 +03:00
{'cpu_number': 1,
'guest': 0.0,
'guest_nice': 0.0,
2021-07-17 10:44:21 +03:00
'idle': 20.0,
2021-07-17 10:31:07 +03:00
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
'softirq': 1.0,
'steal': 0.0,
2021-07-17 10:44:21 +03:00
'system': 0.0,
'total': 80.0,
'user': 3.0}]
2021-07-17 10:31:07 +03:00
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/percpu/cpu_number
{'cpu_number': [0, 1, 2, 3]}
GET ports
---------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/ports
[{'description': 'DefaultGateway',
'host': '192.168.43.136',
'indice': 'port_0',
'port': 0,
'refresh': 30,
'rtt_warning': None,
2021-07-17 10:44:21 +03:00
'status': 0.00617,
2021-07-17 10:31:07 +03:00
'timeout': 3}]
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/ports/host
{'host': ['192.168.43.136']}
2021-07-17 10:44:21 +03:00
Get a specific item when field matchs the given value::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/ports/host/192.168.43.136
{'192.168.43.136': [{'description': 'DefaultGateway',
'host': '192.168.43.136',
'indice': 'port_0',
'port': 0,
'refresh': 30,
'rtt_warning': None,
2021-07-17 10:44:21 +03:00
'status': 0.00617,
2021-07-17 10:31:07 +03:00
'timeout': 3}]}
GET processcount
----------------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/processcount
2021-07-17 10:44:21 +03:00
{'pid_max': 0, 'running': 1, 'sleeping': 287, 'thread': 1495, 'total': 348}
2021-07-17 10:31:07 +03:00
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/processcount/total
2021-07-17 10:44:21 +03:00
{'total': 348}
2021-07-17 10:31:07 +03:00
GET processlist
---------------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/processlist
[{'cmdline': ['/home/nicolargo/dev/glances/venv/bin/python3.8',
'/home/nicolargo/.vscode/extensions/ms-python.python-2021.5.926500501/pythonFiles/run-jedi-language-server.py'],
'cpu_percent': 0.0,
2021-07-17 10:44:21 +03:00
'cpu_times': pcputimes(user=5838.15, system=345.85, children_user=0.0, children_system=0.0, iowait=15.24),
2021-07-17 10:31:07 +03:00
'gids': pgids(real=1000, effective=1000, saved=1000),
'io_counters': [678944768, 109338624, 0, 0, 0],
'key': 'pid',
2021-07-17 10:44:21 +03:00
'memory_info': pmem(rss=665624576, vms=909639680, shared=3633152, text=2846720, lib=0, data=689029120, dirty=0),
'memory_percent': 8.480306845311867,
2021-07-17 10:31:07 +03:00
'name': 'python3.8',
'nice': 0,
'num_threads': 4,
'pid': 2702806,
'ppid': 2702621,
'status': 'S',
'time_since_update': 1,
'username': 'nicolargo'},
2021-07-17 10:44:21 +03:00
{'cmdline': ['/usr/lib/firefox/firefox', '-new-window'],
2021-07-17 10:31:07 +03:00
'cpu_percent': 0.0,
2021-07-17 10:44:21 +03:00
'cpu_times': pcputimes(user=2104.27, system=824.75, children_user=3425.17, children_system=514.13, iowait=2.37),
2021-07-17 10:31:07 +03:00
'gids': pgids(real=1000, effective=1000, saved=1000),
2021-07-17 10:44:21 +03:00
'io_counters': [1527762944, 2602557440, 0, 0, 0],
2021-07-17 10:31:07 +03:00
'key': 'pid',
2021-07-17 10:44:21 +03:00
'memory_info': pmem(rss=452657152, vms=4601450496, shared=113090560, text=622592, lib=0, data=1007812608, dirty=0),
'memory_percent': 5.767021956660709,
'name': 'firefox',
2021-07-17 10:31:07 +03:00
'nice': 0,
2021-07-17 10:44:21 +03:00
'num_threads': 114,
'pid': 2993020,
'ppid': 8496,
2021-07-17 10:31:07 +03:00
'status': 'S',
'time_since_update': 1,
'username': 'nicolargo'}]
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/processlist/pid
{'pid': [2702806,
2021-07-17 10:44:21 +03:00
2993020,
2021-07-17 10:31:07 +03:00
2702582,
2993144,
2993283,
9122,
3079121,
42230,
2993375,
2702621,
2021-07-17 10:44:21 +03:00
2993148,
2021-07-17 10:31:07 +03:00
3078543,
2021-07-17 10:44:21 +03:00
3125399,
3125732,
2021-07-17 10:31:07 +03:00
3075417,
2021-07-17 10:44:21 +03:00
3125352,
2021-07-17 10:31:07 +03:00
3090242,
2938292,
2702525,
744165,
3056321,
2021-07-17 10:44:21 +03:00
2702553,
2021-07-17 10:31:07 +03:00
2993158,
2021-07-17 10:44:21 +03:00
2702636,
2021-07-17 10:31:07 +03:00
8654,
2702653,
2791638,
2702815,
3244,
3103852,
8639,
2021-07-17 10:44:21 +03:00
3126511,
2021-07-17 10:31:07 +03:00
2741015,
2791637,
2702565,
2791665,
8540,
3419,
3120308,
2817004,
2021-07-17 10:44:21 +03:00
2702789,
2021-07-17 10:31:07 +03:00
2625397,
2021-07-17 10:44:21 +03:00
3076986,
2021-07-17 10:31:07 +03:00
2598927,
2994159,
4497,
9696,
28036,
8538,
2021-07-17 10:44:21 +03:00
3120307,
2021-07-17 10:31:07 +03:00
9412,
1,
3120328,
1101,
9880,
2739211,
9520,
2021-07-17 10:44:21 +03:00
2702662,
2021-07-17 10:31:07 +03:00
9915,
2791760,
10076,
3120327,
9918,
1140,
9539,
218114,
2625601,
1264,
9975,
9421,
42244,
9791,
7479,
8496,
8553,
9911,
1675998,
3074778,
9427,
3074791,
9962,
3074785,
3201,
8594,
9608,
2625324,
2702529,
2625388,
2702528,
9936,
1099,
8546,
1636,
9073,
2625339,
3103956,
9910,
9820,
2078532,
9432,
10009,
223473,
1141,
1137,
9957,
9934,
2625334,
3075380,
9596,
10001,
2035399,
9903,
44159,
1085,
9929,
10045,
2622728,
9453,
8623,
9925,
10017,
2625605,
223504,
9953,
1093,
9877,
1115,
2625489,
43602,
2614935,
8822,
8672,
3056033,
9762,
8650,
9941,
169607,
9420,
2548721,
2525291,
1905447,
627089,
9010,
713820,
1122,
9016,
9969,
8995,
298444,
1110,
8664,
2021-07-17 10:44:21 +03:00
3126498,
2021-07-17 10:31:07 +03:00
43938,
8575,
8614,
1134,
1096,
3103851,
1316,
8633,
2625337,
1168,
2879345,
1001,
8586,
2879435,
2625021,
1097,
4504,
1125,
9066,
2625338,
3217,
1462,
8953,
2620923,
9512,
1086,
2021-07-17 10:44:21 +03:00
3126510,
2021-07-17 10:31:07 +03:00
3953,
3229,
3103980,
3077281,
3225,
1310,
978,
1171,
370,
13314,
8498,
2,
3,
4,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
21,
22,
23,
24,
27,
28,
29,
30,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
91,
92,
93,
94,
95,
96,
97,
98,
99,
102,
103,
105,
107,
108,
112,
121,
139,
181,
191,
192,
193,
194,
195,
196,
197,
198,
200,
201,
206,
207,
238,
288,
289,
309,
360,
364,
390,
439,
450,
451,
452,
453,
513,
514,
531,
842,
843,
844,
845,
846,
847,
848,
849,
850,
851,
852,
853,
1323,
1527,
1529,
1531,
1533,
1534,
1537,
1538,
1540,
8648,
11754,
14346,
45609,
45610,
45621,
45622,
45623,
45624,
45625,
45626,
217392,
574771,
1893153,
2058173,
2318240,
2624916,
2624918,
2702007,
2717801,
2777389,
2779024,
2780261,
2816759,
2816957,
2817447,
2817525,
2817644,
2848355,
2848483,
2848744,
2891750,
2892014,
2926441,
2927027,
2927659,
2938027,
2939167,
2981539,
3043867,
3055870,
3055871,
3055872,
3076088,
3076171,
3076588,
3106441,
3115093,
3120203,
3120205,
3122327,
3122446,
3123701,
3124311,
2021-07-17 10:44:21 +03:00
3124426,
3125017,
3125269,
3125272,
3125705,
3125716,
3126114]}
Get a specific item when field matchs the given value::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/processlist/pid/2702806
{'2702806': [{'cmdline': ['/home/nicolargo/dev/glances/venv/bin/python3.8',
'/home/nicolargo/.vscode/extensions/ms-python.python-2021.5.926500501/pythonFiles/run-jedi-language-server.py'],
'cpu_percent': 0.0,
2021-07-17 10:44:21 +03:00
'cpu_times': [5838.15, 345.85, 0.0, 0.0, 15.24],
2021-07-17 10:31:07 +03:00
'gids': [1000, 1000, 1000],
'io_counters': [678944768, 109338624, 0, 0, 0],
'key': 'pid',
2021-07-17 10:44:21 +03:00
'memory_info': [665624576,
909639680,
2021-07-17 10:31:07 +03:00
3633152,
2846720,
0,
2021-07-17 10:44:21 +03:00
689029120,
2021-07-17 10:31:07 +03:00
0],
2021-07-17 10:44:21 +03:00
'memory_percent': 8.480306845311867,
2021-07-17 10:31:07 +03:00
'name': 'python3.8',
'nice': 0,
'num_threads': 4,
'pid': 2702806,
'ppid': 2702621,
'status': 'S',
'time_since_update': 1,
'username': 'nicolargo'}]}
GET psutilversion
-----------------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/psutilversion
(5, 8, 0)
GET quicklook
-------------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/quicklook
2021-07-17 10:44:21 +03:00
{'cpu': 31.4,
2021-07-17 10:31:07 +03:00
'cpu_hz': 3000000000.0,
2021-07-17 10:44:21 +03:00
'cpu_hz_current': 2484555500.0,
2021-07-17 10:31:07 +03:00
'cpu_name': 'Intel(R) Core(TM) i7-4500U CPU @ 1.80GH',
2021-07-17 10:44:21 +03:00
'mem': 75.7,
2021-07-17 10:31:07 +03:00
'percpu': [{'cpu_number': 0,
'guest': 0.0,
'guest_nice': 0.0,
2021-07-17 10:44:21 +03:00
'idle': 7.0,
2021-07-17 10:31:07 +03:00
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
2021-07-17 10:44:21 +03:00
'softirq': 0.0,
2021-07-17 10:31:07 +03:00
'steal': 0.0,
2021-07-17 10:44:21 +03:00
'system': 2.0,
'total': 93.0,
'user': 16.0},
2021-07-17 10:31:07 +03:00
{'cpu_number': 1,
'guest': 0.0,
'guest_nice': 0.0,
2021-07-17 10:44:21 +03:00
'idle': 20.0,
2021-07-17 10:31:07 +03:00
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
'softirq': 1.0,
'steal': 0.0,
2021-07-17 10:44:21 +03:00
'system': 0.0,
'total': 80.0,
'user': 3.0},
2021-07-17 10:31:07 +03:00
{'cpu_number': 2,
'guest': 0.0,
'guest_nice': 0.0,
2021-07-17 10:44:21 +03:00
'idle': 23.0,
2021-07-17 10:31:07 +03:00
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
2021-07-17 10:44:21 +03:00
'softirq': 1.0,
2021-07-17 10:31:07 +03:00
'steal': 0.0,
'system': 1.0,
2021-07-17 10:44:21 +03:00
'total': 77.0,
2021-07-17 10:31:07 +03:00
'user': 1.0},
{'cpu_number': 3,
'guest': 0.0,
'guest_nice': 0.0,
2021-07-17 10:44:21 +03:00
'idle': 19.0,
2021-07-17 10:31:07 +03:00
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
2021-07-17 10:44:21 +03:00
'softirq': 4.0,
2021-07-17 10:31:07 +03:00
'steal': 0.0,
2021-07-17 10:44:21 +03:00
'system': 1.0,
'total': 81.0,
'user': 5.0}],
2021-07-17 10:31:07 +03:00
'swap': 24.5}
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/quicklook/cpu
2021-07-17 10:44:21 +03:00
{'cpu': 31.4}
2021-07-17 10:31:07 +03:00
GET sensors
-----------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# 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}]
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/sensors/label
{'label': ['acpitz 1',
'acpitz 2',
'CPU',
'Ambient',
'SODIMM',
'Package id 0',
'Core 0',
'Core 1',
'Battery']}
2021-07-17 10:44:21 +03:00
Get a specific item when field matchs the given value::
2021-07-17 10:31:07 +03:00
# 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
----------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/system
{'hostname': 'XPS13-9333',
'hr_name': 'Ubuntu 20.04 64bit',
'linux_distro': 'Ubuntu 20.04',
'os_name': 'Linux',
'os_version': '5.4.0-66-generic',
'platform': '64bit'}
2021-07-17 10:44:21 +03:00
Get a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/system/os_name
{'os_name': 'Linux'}
GET uptime
----------
2021-07-17 10:44:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/uptime
2021-07-17 10:44:21 +03:00
{'seconds': 7860717}
2021-07-17 10:31:07 +03:00
GET all stats
-------------
2021-07-17 10:44:21 +03:00
Get all Glances stats::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/all
Return a very big dictionnary (avoid using this request, performances will be poor)...
GET stats history
-----------------
2021-07-17 10:44:21 +03:00
History of a plugin::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/cpu/history
2021-07-17 10:44:21 +03:00
{'system': [['2021-07-17T09:43:50.760441', 5.0],
['2021-07-17T09:43:51.798650', 5.0],
['2021-07-17T09:43:52.893517', 1.3]],
'user': [['2021-07-17T09:43:50.760434', 21.4],
['2021-07-17T09:43:51.798646', 21.4],
['2021-07-17T09:43:52.893513', 3.0]]}
Limit history to last 2 values::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/cpu/history/2
2021-07-17 10:44:21 +03:00
{'system': [['2021-07-17T09:43:51.798650', 5.0],
['2021-07-17T09:43:52.893517', 1.3]],
'user': [['2021-07-17T09:43:51.798646', 21.4],
['2021-07-17T09:43:52.893513', 3.0]]}
2021-07-17 10:31:07 +03:00
2021-07-17 10:44:21 +03:00
History for a specific field::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/cpu/system/history
2021-07-17 10:44:21 +03:00
{'system': [['2021-07-17T09:43:50.760441', 5.0],
['2021-07-17T09:43:51.798650', 5.0],
['2021-07-17T09:43:52.893517', 1.3]]}
2021-07-17 10:31:07 +03:00
2021-07-17 10:44:21 +03:00
Limit history for a specific field to last 2 values::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/cpu/system/history
2021-07-17 10:44:21 +03:00
{'system': [['2021-07-17T09:43:51.798650', 5.0],
['2021-07-17T09:43:52.893517', 1.3]]}
2021-07-17 10:31:07 +03:00
GET limits (used for thresholds)
--------------------------------
2021-07-17 10:44:21 +03:00
All limits/thresholds::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/all/limits
{'alert': {'history_size': 3600.0},
'amps': {'amps_disable': ['False'], 'history_size': 3600.0},
'cloud': {'history_size': 3600.0},
'connections': {'connections_disable': ['True'],
'connections_nf_conntrack_percent_careful': 70.0,
'connections_nf_conntrack_percent_critical': 90.0,
'connections_nf_conntrack_percent_warning': 80.0,
'history_size': 3600.0},
'core': {'history_size': 3600.0},
'cpu': {'cpu_ctx_switches_careful': 160000.0,
'cpu_ctx_switches_critical': 200000.0,
'cpu_ctx_switches_warning': 180000.0,
'cpu_disable': ['False'],
'cpu_iowait_careful': 20.0,
'cpu_iowait_critical': 25.0,
'cpu_iowait_warning': 22.5,
'cpu_steal_careful': 50.0,
'cpu_steal_critical': 90.0,
'cpu_steal_warning': 70.0,
'cpu_system_careful': 50.0,
'cpu_system_critical': 90.0,
'cpu_system_log': ['False'],
'cpu_system_warning': 70.0,
'cpu_total_careful': 65.0,
'cpu_total_critical': 85.0,
'cpu_total_log': ['True'],
'cpu_total_warning': 75.0,
'cpu_user_careful': 50.0,
'cpu_user_critical': 90.0,
'cpu_user_log': ['False'],
'cpu_user_warning': 70.0,
'history_size': 3600.0},
'diskio': {'diskio_disable': ['False'],
'diskio_hide': ['loop.*', '/dev/loop* '],
'history_size': 3600.0},
'docker': {'docker_all': ['False'],
'docker_disable': ['False'],
'docker_max_name_size': 20.0,
'history_size': 3600.0},
'folders': {'folders_disable': ['False'], 'history_size': 3600.0},
'fs': {'fs_careful': 50.0,
'fs_critical': 90.0,
'fs_disable': ['False'],
'fs_hide': ['/boot.*', '/snap.* '],
'fs_warning': 70.0,
'history_size': 3600.0},
'gpu': {'gpu_disable': ['False'],
'gpu_mem_careful': 50.0,
'gpu_mem_critical': 90.0,
'gpu_mem_warning': 70.0,
'gpu_proc_careful': 50.0,
'gpu_proc_critical': 90.0,
'gpu_proc_warning': 70.0,
'history_size': 3600.0},
'help': {'history_size': 3600.0},
'ip': {'history_size': 3600.0},
'irq': {'history_size': 3600.0, 'irq_disable': ['True']},
'load': {'history_size': 3600.0,
'load_careful': 0.7,
'load_critical': 5.0,
'load_disable': ['False'],
'load_warning': 1.0},
'mem': {'history_size': 3600.0,
'mem_careful': 50.0,
'mem_critical': 90.0,
'mem_disable': ['False'],
'mem_warning': 70.0},
'memswap': {'history_size': 3600.0,
'memswap_careful': 50.0,
'memswap_critical': 90.0,
'memswap_disable': ['False'],
'memswap_warning': 70.0},
'network': {'history_size': 3600.0,
'network_disable': ['False'],
'network_rx_careful': 70.0,
'network_rx_critical': 90.0,
'network_rx_warning': 80.0,
'network_tx_careful': 70.0,
'network_tx_critical': 90.0,
'network_tx_warning': 80.0},
'now': {'history_size': 3600.0},
'percpu': {'history_size': 3600.0,
'percpu_disable': ['False'],
'percpu_iowait_careful': 50.0,
'percpu_iowait_critical': 90.0,
'percpu_iowait_warning': 70.0,
'percpu_system_careful': 50.0,
'percpu_system_critical': 90.0,
'percpu_system_warning': 70.0,
'percpu_user_careful': 50.0,
'percpu_user_critical': 90.0,
'percpu_user_warning': 70.0},
'ports': {'history_size': 3600.0,
'ports_disable': ['False'],
'ports_port_default_gateway': ['True'],
'ports_refresh': 30.0,
'ports_timeout': 3.0},
'processcount': {'history_size': 3600.0, 'processcount_disable': ['False']},
'processlist': {'history_size': 3600.0,
'processlist_cpu_careful': 50.0,
'processlist_cpu_critical': 90.0,
'processlist_cpu_warning': 70.0,
'processlist_disable': ['False'],
'processlist_mem_careful': 50.0,
'processlist_mem_critical': 90.0,
'processlist_mem_warning': 70.0,
'processlist_nice_warning': ['-20',
'-19',
'-18',
'-17',
'-16',
'-15',
'-14',
'-13',
'-12',
'-11',
'-10',
'-9',
'-8',
'-7',
'-6',
'-5',
'-4',
'-3',
'-2',
'-1',
'1',
'2',
'3',
'4',
'5',
'6',
'7',
'8',
'9',
'10',
'11',
'12',
'13',
'14',
'15',
'16',
'17',
'18',
'19']},
'psutilversion': {'history_size': 3600.0},
'quicklook': {'history_size': 3600.0,
'quicklook_cpu_careful': 50.0,
'quicklook_cpu_critical': 90.0,
'quicklook_cpu_warning': 70.0,
'quicklook_disable': ['False'],
'quicklook_mem_careful': 50.0,
'quicklook_mem_critical': 90.0,
'quicklook_mem_warning': 70.0,
'quicklook_percentage_char': ['|'],
'quicklook_swap_careful': 50.0,
'quicklook_swap_critical': 90.0,
'quicklook_swap_warning': 70.0},
'raid': {'history_size': 3600.0, 'raid_disable': ['True']},
'sensors': {'history_size': 3600.0,
'sensors_battery_careful': 80.0,
'sensors_battery_critical': 95.0,
'sensors_battery_warning': 90.0,
'sensors_disable': ['False'],
'sensors_refresh': 4.0,
'sensors_temperature_core_careful': 60.0,
'sensors_temperature_core_critical': 80.0,
'sensors_temperature_core_warning': 70.0,
'sensors_temperature_hdd_careful': 45.0,
'sensors_temperature_hdd_critical': 60.0,
'sensors_temperature_hdd_warning': 52.0},
'smart': {'history_size': 3600.0, 'smart_disable': ['True']},
'system': {'history_size': 3600.0,
'system_disable': ['False'],
'system_refresh': 60},
'uptime': {'history_size': 3600.0},
'wifi': {'history_size': 3600.0,
'wifi_careful': -65.0,
'wifi_critical': -85.0,
'wifi_disable': ['True'],
'wifi_hide': ['lo', 'docker.*'],
'wifi_warning': -75.0}}
2021-07-17 10:44:21 +03:00
Limits/thresholds for the cpu plugin::
2021-07-17 10:31:07 +03:00
# 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}
2016-03-02 15:29:19 +03:00
