mirror of https://github.com/nicolargo/glances.git
1335 lines
39 KiB
ReStructuredText
1335 lines
39 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 plugins list
|
|
----------------
|
|
|
|
Get the plugins list::
|
|
|
|
# curl http://localhost:61208/api/3/pluginslist
|
|
['alert',
|
|
'amps',
|
|
'cloud',
|
|
'connections',
|
|
'core',
|
|
'cpu',
|
|
'diskio',
|
|
'docker',
|
|
'folders',
|
|
'fs',
|
|
'gpu',
|
|
'help',
|
|
'ip',
|
|
'irq',
|
|
'load',
|
|
'mem',
|
|
'memswap',
|
|
'network',
|
|
'now',
|
|
'percpu',
|
|
'ports',
|
|
'processcount',
|
|
'processlist',
|
|
'psutilversion',
|
|
'quicklook',
|
|
'raid',
|
|
'sensors',
|
|
'smart',
|
|
'system',
|
|
'uptime',
|
|
'wifi']
|
|
|
|
GET alert
|
|
---------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/alert
|
|
[[1636623973.0,
|
|
-1,
|
|
'WARNING',
|
|
'MEM',
|
|
71.69530310265021,
|
|
71.69530310265021,
|
|
71.69530310265021,
|
|
71.69530310265021,
|
|
1,
|
|
[],
|
|
'',
|
|
'memory_percent']]
|
|
|
|
GET amps
|
|
--------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/amps
|
|
[{'count': 0,
|
|
'countmax': None,
|
|
'countmin': 1.0,
|
|
'key': 'name',
|
|
'name': 'Dropbox',
|
|
'refresh': 3.0,
|
|
'regex': True,
|
|
'result': None,
|
|
'timer': 0.16523957252502441},
|
|
{'count': 0,
|
|
'countmax': 20.0,
|
|
'countmin': None,
|
|
'key': 'name',
|
|
'name': 'Python',
|
|
'refresh': 3.0,
|
|
'regex': True,
|
|
'result': None,
|
|
'timer': 0.16511940956115723}]
|
|
|
|
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.16523957252502441}]}
|
|
|
|
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': 70.5,
|
|
'interrupts': 0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'nice': 0.0,
|
|
'soft_interrupts': 0,
|
|
'softirq': 3.8,
|
|
'steal': 0.0,
|
|
'syscalls': 0,
|
|
'system': 3.6,
|
|
'time_since_update': 1,
|
|
'total': 28.9,
|
|
'user': 22.1}
|
|
|
|
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*)
|
|
* **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.9}
|
|
|
|
GET diskio
|
|
----------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/diskio
|
|
[{'disk_name': 'sda',
|
|
'key': 'disk_name',
|
|
'read_bytes': 0,
|
|
'read_count': 0,
|
|
'time_since_update': 1,
|
|
'write_bytes': 0,
|
|
'write_count': 0},
|
|
{'disk_name': 'sda1',
|
|
'key': 'disk_name',
|
|
'read_bytes': 0,
|
|
'read_count': 0,
|
|
'time_since_update': 1,
|
|
'write_bytes': 0,
|
|
'write_count': 0}]
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/diskio/disk_name
|
|
{'disk_name': ['sda', 'sda1', 'sda2', 'sda5', 'dm-0', 'dm-1']}
|
|
|
|
Get a specific item when field matchs the given value::
|
|
|
|
# curl http://localhost:61208/api/3/diskio/disk_name/sda
|
|
{'sda': [{'disk_name': 'sda',
|
|
'key': 'disk_name',
|
|
'read_bytes': 0,
|
|
'read_count': 0,
|
|
'time_since_update': 1,
|
|
'write_bytes': 0,
|
|
'write_count': 0}]}
|
|
|
|
GET fs
|
|
------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/fs
|
|
[{'device_name': '/dev/mapper/ubuntu--gnome--vg-root',
|
|
'free': 33024262144,
|
|
'fs_type': 'ext4',
|
|
'key': 'mnt_point',
|
|
'mnt_point': '/',
|
|
'percent': 85.7,
|
|
'size': 243396149248,
|
|
'used': 197984432128}]
|
|
|
|
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': 33024262144,
|
|
'fs_type': 'ext4',
|
|
'key': 'mnt_point',
|
|
'mnt_point': '/',
|
|
'percent': 85.7,
|
|
'size': 243396149248,
|
|
'used': 197984432128}]}
|
|
|
|
GET ip
|
|
------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/ip
|
|
{'address': '192.168.0.49',
|
|
'gateway': '192.168.0.254',
|
|
'mask': '255.255.255.0',
|
|
'mask_cidr': 24,
|
|
'public_address': '88.165.169.242'}
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/ip/address
|
|
{'address': '192.168.0.49'}
|
|
|
|
GET load
|
|
--------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/load
|
|
{'cpucore': 4, 'min1': 1.18, 'min15': 1.3, 'min5': 1.45}
|
|
|
|
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.18}
|
|
|
|
GET mem
|
|
-------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/mem
|
|
{'active': 5186936832,
|
|
'available': 2221641728,
|
|
'buffers': 728940544,
|
|
'cached': 2317426688,
|
|
'free': 2221641728,
|
|
'inactive': 1455177728,
|
|
'percent': 71.7,
|
|
'shared': 778702848,
|
|
'total': 7849021440,
|
|
'used': 5627379712}
|
|
|
|
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': 7849021440}
|
|
|
|
GET memswap
|
|
-----------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/memswap
|
|
{'free': 7204769792,
|
|
'percent': 10.9,
|
|
'sin': 445259776,
|
|
'sout': 1804820480,
|
|
'time_since_update': 1,
|
|
'total': 8082419712,
|
|
'used': 877649920}
|
|
|
|
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': 3698139,
|
|
'cumulative_rx': 40807,
|
|
'cumulative_tx': 3657332,
|
|
'cx': 0,
|
|
'interface_name': 'docker0',
|
|
'is_up': False,
|
|
'key': 'interface_name',
|
|
'rx': 0,
|
|
'speed': 0,
|
|
'time_since_update': 1,
|
|
'tx': 0},
|
|
{'alias': None,
|
|
'cumulative_cx': 0,
|
|
'cumulative_rx': 0,
|
|
'cumulative_tx': 0,
|
|
'cx': 0,
|
|
'interface_name': 'mpqemubr0',
|
|
'is_up': False,
|
|
'key': 'interface_name',
|
|
'rx': 0,
|
|
'speed': 0,
|
|
'time_since_update': 1,
|
|
'tx': 0}]
|
|
|
|
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': ['docker0',
|
|
'mpqemubr0',
|
|
'lo',
|
|
'br-119e6ee04e05',
|
|
'wlp2s0',
|
|
'br-87386b77b676']}
|
|
|
|
Get a specific item when field matchs the given value::
|
|
|
|
# curl http://localhost:61208/api/3/network/interface_name/docker0
|
|
{'docker0': [{'alias': None,
|
|
'cumulative_cx': 3698139,
|
|
'cumulative_rx': 40807,
|
|
'cumulative_tx': 3657332,
|
|
'cx': 0,
|
|
'interface_name': 'docker0',
|
|
'is_up': False,
|
|
'key': 'interface_name',
|
|
'rx': 0,
|
|
'speed': 0,
|
|
'time_since_update': 1,
|
|
'tx': 0}]}
|
|
|
|
GET now
|
|
-------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/now
|
|
'2021-11-11 10:46:13 CET'
|
|
|
|
GET percpu
|
|
----------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/percpu
|
|
[{'cpu_number': 0,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 15.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 0.0,
|
|
'softirq': 0.0,
|
|
'steal': 0.0,
|
|
'system': 2.0,
|
|
'total': 85.0,
|
|
'user': 57.0},
|
|
{'cpu_number': 1,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 63.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 0.0,
|
|
'softirq': 0.0,
|
|
'steal': 0.0,
|
|
'system': 3.0,
|
|
'total': 37.0,
|
|
'user': 9.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.005204,
|
|
'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.005204,
|
|
'timeout': 3}]}
|
|
|
|
GET processcount
|
|
----------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/processcount
|
|
{'pid_max': 0, 'running': 1, 'sleeping': 275, 'thread': 1340, 'total': 334}
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/processcount/total
|
|
{'total': 334}
|
|
|
|
GET processlist
|
|
---------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/processlist
|
|
[{'cmdline': ['/usr/lib/firefox/firefox', '-new-window'],
|
|
'cpu_percent': 0.0,
|
|
'cpu_times': pcputimes(user=9544.16, system=3246.47, children_user=6410.27, children_system=1105.83, iowait=2.92),
|
|
'gids': pgids(real=1000, effective=1000, saved=1000),
|
|
'io_counters': [2831810560, 11189903360, 0, 0, 0],
|
|
'key': 'pid',
|
|
'memory_info': pmem(rss=656961536, vms=5053366272, shared=190525440, text=626688, lib=0, data=1272360960, dirty=0),
|
|
'memory_percent': 8.36998014366489,
|
|
'name': 'firefox',
|
|
'nice': 0,
|
|
'num_threads': 143,
|
|
'pid': 5637,
|
|
'ppid': 3847,
|
|
'status': 'S',
|
|
'time_since_update': 1,
|
|
'username': 'nicolargo'},
|
|
{'cmdline': ['/usr/lib/firefox/firefox',
|
|
'-contentproc',
|
|
'-childID',
|
|
'2',
|
|
'-isForBrowser',
|
|
'-prefsLen',
|
|
'96',
|
|
'-prefMapSize',
|
|
'254038',
|
|
'-jsInit',
|
|
'285716',
|
|
'-parentBuildID',
|
|
'20210823123856',
|
|
'-appdir',
|
|
'/usr/lib/firefox/browser',
|
|
'5637',
|
|
'true',
|
|
'tab'],
|
|
'cpu_percent': 0.0,
|
|
'cpu_times': pcputimes(user=1902.3, system=443.03, children_user=0.0, children_system=0.0, iowait=1.6),
|
|
'gids': pgids(real=1000, effective=1000, saved=1000),
|
|
'io_counters': [78823424, 0, 0, 0, 0],
|
|
'key': 'pid',
|
|
'memory_info': pmem(rss=522686464, vms=3613749248, shared=78860288, text=626688, lib=0, data=845529088, dirty=0),
|
|
'memory_percent': 6.659256418084138,
|
|
'name': 'Web Content',
|
|
'nice': 0,
|
|
'num_threads': 24,
|
|
'pid': 5755,
|
|
'ppid': 5637,
|
|
'status': 'S',
|
|
'time_since_update': 1,
|
|
'username': 'nicolargo'}]
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/processlist/pid
|
|
{'pid': [5637,
|
|
5755,
|
|
5895,
|
|
5946,
|
|
239588,
|
|
239766,
|
|
4092,
|
|
239606,
|
|
243259,
|
|
159796,
|
|
238897,
|
|
239897,
|
|
243853,
|
|
207471,
|
|
238993,
|
|
238929,
|
|
244353,
|
|
239618,
|
|
203033,
|
|
178587,
|
|
5798,
|
|
227849,
|
|
244524,
|
|
239660,
|
|
239023,
|
|
3934,
|
|
238947,
|
|
2259,
|
|
3336,
|
|
18486,
|
|
238901,
|
|
238900,
|
|
207747,
|
|
237994,
|
|
248427,
|
|
3913,
|
|
3855,
|
|
138395,
|
|
211213,
|
|
4374,
|
|
68322,
|
|
150281,
|
|
4181,
|
|
348,
|
|
242171,
|
|
2430,
|
|
6053,
|
|
3853,
|
|
213050,
|
|
4928,
|
|
242169,
|
|
4241,
|
|
4265,
|
|
1139,
|
|
4152,
|
|
4261,
|
|
4266,
|
|
4287,
|
|
1,
|
|
4143,
|
|
4264,
|
|
4284,
|
|
4121,
|
|
4196,
|
|
2216,
|
|
226115,
|
|
172714,
|
|
1158,
|
|
4123,
|
|
1180,
|
|
1285,
|
|
226113,
|
|
2394,
|
|
4116,
|
|
4274,
|
|
3847,
|
|
4078,
|
|
3764,
|
|
4262,
|
|
1008,
|
|
2208,
|
|
4164,
|
|
3863,
|
|
3890,
|
|
4267,
|
|
238903,
|
|
4343,
|
|
1575,
|
|
234622,
|
|
1153,
|
|
4279,
|
|
5587,
|
|
240887,
|
|
4339,
|
|
239661,
|
|
4129,
|
|
1176,
|
|
4332,
|
|
3959,
|
|
1354,
|
|
1324,
|
|
1178,
|
|
4252,
|
|
1121,
|
|
1181,
|
|
4263,
|
|
5573,
|
|
1138,
|
|
1300,
|
|
3921,
|
|
187870,
|
|
3896,
|
|
4281,
|
|
4276,
|
|
3868,
|
|
4340,
|
|
4160,
|
|
3858,
|
|
3932,
|
|
3908,
|
|
4048,
|
|
4120,
|
|
1173,
|
|
4273,
|
|
1147,
|
|
3927,
|
|
18537,
|
|
4272,
|
|
2406,
|
|
4285,
|
|
4260,
|
|
207437,
|
|
240886,
|
|
4137,
|
|
3883,
|
|
1010,
|
|
4057,
|
|
3902,
|
|
67406,
|
|
1166,
|
|
1130,
|
|
37983,
|
|
1150,
|
|
4072,
|
|
4141,
|
|
37989,
|
|
1182,
|
|
1007,
|
|
6521,
|
|
1163,
|
|
3339,
|
|
1129,
|
|
2403,
|
|
4062,
|
|
37992,
|
|
1135,
|
|
138445,
|
|
1451,
|
|
248409,
|
|
1209,
|
|
2230,
|
|
37995,
|
|
2404,
|
|
4601,
|
|
1122,
|
|
248426,
|
|
2229,
|
|
2035,
|
|
213333,
|
|
1335,
|
|
3848,
|
|
2235,
|
|
997,
|
|
375,
|
|
1214,
|
|
4029,
|
|
1132,
|
|
2,
|
|
3,
|
|
4,
|
|
6,
|
|
9,
|
|
10,
|
|
11,
|
|
12,
|
|
13,
|
|
14,
|
|
15,
|
|
16,
|
|
17,
|
|
18,
|
|
21,
|
|
22,
|
|
23,
|
|
24,
|
|
27,
|
|
28,
|
|
29,
|
|
30,
|
|
32,
|
|
33,
|
|
34,
|
|
35,
|
|
36,
|
|
37,
|
|
38,
|
|
39,
|
|
40,
|
|
41,
|
|
42,
|
|
89,
|
|
90,
|
|
91,
|
|
94,
|
|
95,
|
|
97,
|
|
98,
|
|
99,
|
|
100,
|
|
102,
|
|
103,
|
|
105,
|
|
106,
|
|
107,
|
|
110,
|
|
119,
|
|
136,
|
|
187,
|
|
189,
|
|
190,
|
|
191,
|
|
192,
|
|
193,
|
|
194,
|
|
195,
|
|
196,
|
|
202,
|
|
203,
|
|
204,
|
|
207,
|
|
208,
|
|
237,
|
|
279,
|
|
280,
|
|
288,
|
|
289,
|
|
291,
|
|
359,
|
|
364,
|
|
398,
|
|
399,
|
|
400,
|
|
424,
|
|
425,
|
|
426,
|
|
431,
|
|
465,
|
|
495,
|
|
502,
|
|
765,
|
|
766,
|
|
767,
|
|
768,
|
|
774,
|
|
775,
|
|
776,
|
|
777,
|
|
778,
|
|
779,
|
|
780,
|
|
781,
|
|
903,
|
|
904,
|
|
905,
|
|
908,
|
|
915,
|
|
928,
|
|
932,
|
|
939,
|
|
947,
|
|
958,
|
|
1347,
|
|
1432,
|
|
1433,
|
|
1434,
|
|
1435,
|
|
1436,
|
|
1437,
|
|
1438,
|
|
1440,
|
|
2301,
|
|
2325,
|
|
3909,
|
|
24555,
|
|
24771,
|
|
25388,
|
|
57294,
|
|
57426,
|
|
57650,
|
|
57855,
|
|
86491,
|
|
86492,
|
|
86504,
|
|
86505,
|
|
86506,
|
|
86507,
|
|
86508,
|
|
86509,
|
|
125413,
|
|
125958,
|
|
126036,
|
|
200243,
|
|
210727,
|
|
210918,
|
|
211155,
|
|
211634,
|
|
211932,
|
|
212305,
|
|
212663,
|
|
217976,
|
|
240992,
|
|
242044,
|
|
242047,
|
|
243760,
|
|
244188,
|
|
244858,
|
|
244896,
|
|
245238,
|
|
246553,
|
|
246555,
|
|
246557,
|
|
246558,
|
|
248087,
|
|
248320]}
|
|
|
|
Get a specific item when field matchs the given value::
|
|
|
|
# curl http://localhost:61208/api/3/processlist/pid/5637
|
|
{'5637': [{'cmdline': ['/usr/lib/firefox/firefox', '-new-window'],
|
|
'cpu_percent': 0.0,
|
|
'cpu_times': [9544.16, 3246.47, 6410.27, 1105.83, 2.92],
|
|
'gids': [1000, 1000, 1000],
|
|
'io_counters': [2831810560, 11189903360, 0, 0, 0],
|
|
'key': 'pid',
|
|
'memory_info': [656961536,
|
|
5053366272,
|
|
190525440,
|
|
626688,
|
|
0,
|
|
1272360960,
|
|
0],
|
|
'memory_percent': 8.36998014366489,
|
|
'name': 'firefox',
|
|
'nice': 0,
|
|
'num_threads': 143,
|
|
'pid': 5637,
|
|
'ppid': 3847,
|
|
'status': 'S',
|
|
'time_since_update': 1,
|
|
'username': 'nicolargo'}]}
|
|
|
|
GET psutilversion
|
|
-----------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/psutilversion
|
|
(5, 8, 0)
|
|
|
|
GET quicklook
|
|
-------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/quicklook
|
|
{'cpu': 28.9,
|
|
'cpu_hz': 2025000000.0,
|
|
'cpu_hz_current': 1972059000.0,
|
|
'cpu_name': 'Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz',
|
|
'mem': 71.7,
|
|
'percpu': [{'cpu_number': 0,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 15.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 0.0,
|
|
'softirq': 0.0,
|
|
'steal': 0.0,
|
|
'system': 2.0,
|
|
'total': 85.0,
|
|
'user': 57.0},
|
|
{'cpu_number': 1,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 63.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 0.0,
|
|
'softirq': 0.0,
|
|
'steal': 0.0,
|
|
'system': 3.0,
|
|
'total': 37.0,
|
|
'user': 9.0},
|
|
{'cpu_number': 2,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 71.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 0.0,
|
|
'softirq': 1.0,
|
|
'steal': 0.0,
|
|
'system': 1.0,
|
|
'total': 29.0,
|
|
'user': 2.0},
|
|
{'cpu_number': 3,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 67.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 0.0,
|
|
'softirq': 9.0,
|
|
'steal': 0.0,
|
|
'system': 1.0,
|
|
'total': 33.0,
|
|
'user': 4.0}],
|
|
'swap': 10.9}
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/quicklook/cpu
|
|
{'cpu': 28.9}
|
|
|
|
GET sensors
|
|
-----------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/sensors
|
|
[{'critical': 105,
|
|
'key': 'label',
|
|
'label': 'acpitz 1',
|
|
'type': 'temperature_core',
|
|
'unit': 'C',
|
|
'value': 27,
|
|
'warning': 105},
|
|
{'critical': 105,
|
|
'key': 'label',
|
|
'label': 'acpitz 2',
|
|
'type': 'temperature_core',
|
|
'unit': 'C',
|
|
'value': 29,
|
|
'warning': 105}]
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/sensors/label
|
|
{'label': ['acpitz 1',
|
|
'acpitz 2',
|
|
'Package id 0',
|
|
'Core 0',
|
|
'Core 1',
|
|
'CPU',
|
|
'Ambient',
|
|
'SODIMM',
|
|
'BAT BAT0']}
|
|
|
|
Get a specific item when field matchs the given value::
|
|
|
|
# curl http://localhost:61208/api/3/sensors/label/acpitz 1
|
|
{'acpitz 1': [{'critical': 105,
|
|
'key': 'label',
|
|
'label': 'acpitz 1',
|
|
'type': 'temperature_core',
|
|
'unit': 'C',
|
|
'value': 27,
|
|
'warning': 105}]}
|
|
|
|
GET system
|
|
----------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/system
|
|
{'hostname': 'XPS13-9333',
|
|
'hr_name': 'Ubuntu 20.04 64bit',
|
|
'linux_distro': 'Ubuntu 20.04',
|
|
'os_name': 'Linux',
|
|
'os_version': '5.4.0-77-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': 5401845}
|
|
|
|
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': [['2021-11-11T10:46:14.029260', 3.6],
|
|
['2021-11-11T10:46:15.085920', 3.6],
|
|
['2021-11-11T10:46:16.237370', 1.4]],
|
|
'user': [['2021-11-11T10:46:14.029249', 22.1],
|
|
['2021-11-11T10:46:15.085914', 22.1],
|
|
['2021-11-11T10:46:16.237363', 3.7]]}
|
|
|
|
Limit history to last 2 values::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/history/2
|
|
{'system': [['2021-11-11T10:46:15.085920', 3.6],
|
|
['2021-11-11T10:46:16.237370', 1.4]],
|
|
'user': [['2021-11-11T10:46:15.085914', 22.1],
|
|
['2021-11-11T10:46:16.237363', 3.7]]}
|
|
|
|
History for a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/system/history
|
|
{'system': [['2021-11-11T10:46:14.029260', 3.6],
|
|
['2021-11-11T10:46:15.085920', 3.6],
|
|
['2021-11-11T10:46:16.237370', 1.4]]}
|
|
|
|
Limit history for a specific field to last 2 values::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/system/history
|
|
{'system': [['2021-11-11T10:46:15.085920', 3.6],
|
|
['2021-11-11T10:46:16.237370', 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},
|
|
'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, 'ip_disable': ['False']},
|
|
'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}}
|
|
|
|
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}
|
|
|