mirror of https://github.com/nicolargo/glances.git
1331 lines
39 KiB
ReStructuredText
1331 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 API status
|
|
--------------
|
|
|
|
This entry point should be used to check the API status.
|
|
It will return nothing but a 200 return code if everythin is OK.
|
|
|
|
Get the Rest API status::
|
|
|
|
# curl -I http://localhost:61208/api/3/status
|
|
'HTTP/1.0 200 OK'
|
|
|
|
GET plugins list
|
|
----------------
|
|
|
|
Get the plugins list::
|
|
|
|
# curl http://localhost:61208/api/3/pluginslist
|
|
['alert',
|
|
'amps',
|
|
'cloud',
|
|
'connections',
|
|
'core',
|
|
'cpu',
|
|
'diskio',
|
|
'docker',
|
|
'folders',
|
|
'fs',
|
|
'gpu',
|
|
'help',
|
|
'ip',
|
|
'irq',
|
|
'load',
|
|
'mem',
|
|
'memswap',
|
|
'network',
|
|
'now',
|
|
'percpu',
|
|
'ports',
|
|
'processcount',
|
|
'processlist',
|
|
'psutilversion',
|
|
'quicklook',
|
|
'raid',
|
|
'sensors',
|
|
'smart',
|
|
'system',
|
|
'uptime',
|
|
'wifi']
|
|
|
|
GET alert
|
|
---------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/alert
|
|
[[1649598627.0,
|
|
-1,
|
|
'WARNING',
|
|
'MEM',
|
|
87.0247252460522,
|
|
87.0247252460522,
|
|
87.0247252460522,
|
|
87.0247252460522,
|
|
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.1502704620361328},
|
|
{'count': 0,
|
|
'countmax': 20.0,
|
|
'countmin': None,
|
|
'key': 'name',
|
|
'name': 'Python',
|
|
'refresh': 3.0,
|
|
'regex': True,
|
|
'result': None,
|
|
'timer': 0.15010571479797363}]
|
|
|
|
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.1502704620361328}]}
|
|
|
|
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': 56.7,
|
|
'interrupts': 0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'nice': 0.5,
|
|
'soft_interrupts': 0,
|
|
'softirq': 0.0,
|
|
'steal': 0.0,
|
|
'syscalls': 0,
|
|
'system': 12.1,
|
|
'time_since_update': 1,
|
|
'total': 43.9,
|
|
'user': 30.7}
|
|
|
|
Fields descriptions:
|
|
|
|
* **total**: Sum of all CPU percentages (except idle) (unit is *percent*)
|
|
* **system**: percent time spent in kernel space. System CPU time is the time spent running code in the Operating System kernel (unit is *percent*)
|
|
* **user**: CPU percent time spent in user space. User CPU time is the time spent on the processor running your program's code (or code in libraries) (unit is *percent*)
|
|
* **iowait**: *(Linux)*: percent time spent by the CPU waiting for I/O operations to complete (unit is *percent*)
|
|
* **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': 43.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': 79636443136,
|
|
'fs_type': 'ext4',
|
|
'key': 'mnt_point',
|
|
'mnt_point': '/',
|
|
'percent': 65.5,
|
|
'size': 243396149248,
|
|
'used': 151372251136}]
|
|
|
|
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': 79636443136,
|
|
'fs_type': 'ext4',
|
|
'key': 'mnt_point',
|
|
'mnt_point': '/',
|
|
'percent': 65.5,
|
|
'size': 243396149248,
|
|
'used': 151372251136}]}
|
|
|
|
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': 0.85, 'min15': 1.7, 'min5': 1.39}
|
|
|
|
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': 0.85}
|
|
|
|
GET mem
|
|
-------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/mem
|
|
{'active': 3496165376,
|
|
'available': 1018429440,
|
|
'buffers': 201367552,
|
|
'cached': 1473327104,
|
|
'free': 1018429440,
|
|
'inactive': 1198579712,
|
|
'percent': 87.0,
|
|
'shared': 496037888,
|
|
'total': 7849000960,
|
|
'used': 6830571520}
|
|
|
|
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': 7849000960}
|
|
|
|
GET memswap
|
|
-----------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/memswap
|
|
{'free': 7899197440,
|
|
'percent': 2.3,
|
|
'sin': 17911808,
|
|
'sout': 202194944,
|
|
'time_since_update': 1,
|
|
'total': 8082419712,
|
|
'used': 183222272}
|
|
|
|
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': 243100,
|
|
'cumulative_rx': 6357,
|
|
'cumulative_tx': 236743,
|
|
'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': 102490,
|
|
'cumulative_rx': 0,
|
|
'cumulative_tx': 102490,
|
|
'cx': 0,
|
|
'interface_name': 'vboxnet0',
|
|
'is_up': True,
|
|
'key': 'interface_name',
|
|
'rx': 0,
|
|
'speed': 10485760,
|
|
'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',
|
|
'vboxnet0',
|
|
'br-87386b77b676',
|
|
'lo',
|
|
'br-119e6ee04e05',
|
|
'br_grafana',
|
|
'mpqemubr0',
|
|
'wlp2s0']}
|
|
|
|
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': 243100,
|
|
'cumulative_rx': 6357,
|
|
'cumulative_tx': 236743,
|
|
'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
|
|
'2022-04-10 15:50:27 CEST'
|
|
|
|
GET percpu
|
|
----------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/percpu
|
|
[{'cpu_number': 0,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 54.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 0.0,
|
|
'softirq': 0.0,
|
|
'steal': 0.0,
|
|
'system': 6.0,
|
|
'total': 46.0,
|
|
'user': 21.0},
|
|
{'cpu_number': 1,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 61.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 1.0,
|
|
'softirq': 0.0,
|
|
'steal': 0.0,
|
|
'system': 12.0,
|
|
'total': 39.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.006071,
|
|
'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.006071,
|
|
'timeout': 3}]}
|
|
|
|
GET processcount
|
|
----------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/processcount
|
|
{'pid_max': 0, 'running': 1, 'sleeping': 260, 'thread': 1307, 'total': 321}
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/processcount/total
|
|
{'total': 321}
|
|
|
|
GET processlist
|
|
---------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/processlist
|
|
[{'cmdline': ['/usr/lib/virtualbox/VBoxHeadless',
|
|
'--comment',
|
|
'minikube',
|
|
'--startvm',
|
|
'74869efd-ada3-41eb-98e3-b7d2901c8e39',
|
|
'--vrde',
|
|
'config'],
|
|
'cpu_percent': 0.0,
|
|
'cpu_times': pcputimes(user=82.82, system=951.49, children_user=0.0, children_system=0.0, iowait=0.0),
|
|
'gids': pgids(real=1000, effective=1000, saved=1000),
|
|
'io_counters': [0, 0, 0, 0, 0],
|
|
'key': 'pid',
|
|
'memory_info': pmem(rss=964993024, vms=4202561536, shared=926556160, text=53248, lib=0, data=98004992, dirty=0),
|
|
'memory_percent': 12.29446943525409,
|
|
'name': 'VBoxHeadless',
|
|
'nice': 0,
|
|
'num_threads': 28,
|
|
'pid': 9872,
|
|
'ppid': 9690,
|
|
'status': 'S',
|
|
'time_since_update': 1,
|
|
'username': 'nicolargo'},
|
|
{'cmdline': ['/usr/lib/firefox/firefox', '-new-window'],
|
|
'cpu_percent': 0.0,
|
|
'cpu_times': pcputimes(user=520.8, system=165.6, children_user=325.1, children_system=45.16, iowait=1.73),
|
|
'gids': pgids(real=1000, effective=1000, saved=1000),
|
|
'io_counters': [701751296, 859406336, 0, 0, 0],
|
|
'key': 'pid',
|
|
'memory_info': pmem(rss=450969600, vms=4304453632, shared=112594944, text=643072, lib=0, data=817766400, dirty=0),
|
|
'memory_percent': 5.745566885495705,
|
|
'name': 'GeckoMain',
|
|
'nice': 0,
|
|
'num_threads': 135,
|
|
'pid': 4964,
|
|
'ppid': 3777,
|
|
'status': 'S',
|
|
'time_since_update': 1,
|
|
'username': 'nicolargo'}]
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/processlist/pid
|
|
{'pid': [9872,
|
|
4964,
|
|
5235,
|
|
16062,
|
|
5294,
|
|
16229,
|
|
5305,
|
|
15998,
|
|
5894,
|
|
4033,
|
|
17438,
|
|
16038,
|
|
15933,
|
|
15053,
|
|
15966,
|
|
16111,
|
|
18604,
|
|
17492,
|
|
5648,
|
|
17565,
|
|
5060,
|
|
16075,
|
|
16242,
|
|
8850,
|
|
2185,
|
|
15983,
|
|
3875,
|
|
14178,
|
|
2410,
|
|
15938,
|
|
15937,
|
|
19004,
|
|
3789,
|
|
2233,
|
|
3846,
|
|
4305,
|
|
1332,
|
|
7066,
|
|
5595,
|
|
5563,
|
|
4119,
|
|
14256,
|
|
5024,
|
|
4193,
|
|
349,
|
|
9690,
|
|
1160,
|
|
4192,
|
|
2380,
|
|
4094,
|
|
3787,
|
|
4187,
|
|
1173,
|
|
4627,
|
|
1315,
|
|
1320,
|
|
2197,
|
|
4088,
|
|
4232,
|
|
14247,
|
|
1,
|
|
4130,
|
|
4191,
|
|
1199,
|
|
4213,
|
|
4167,
|
|
1175,
|
|
3531,
|
|
9684,
|
|
4064,
|
|
2189,
|
|
4308,
|
|
1039,
|
|
14266,
|
|
4062,
|
|
10484,
|
|
4589,
|
|
4019,
|
|
4188,
|
|
1584,
|
|
14265,
|
|
4198,
|
|
4194,
|
|
3777,
|
|
2386,
|
|
3762,
|
|
1326,
|
|
15940,
|
|
3824,
|
|
4105,
|
|
1365,
|
|
4057,
|
|
4276,
|
|
1196,
|
|
1142,
|
|
3900,
|
|
16135,
|
|
3831,
|
|
4203,
|
|
3813,
|
|
1195,
|
|
1158,
|
|
3855,
|
|
1201,
|
|
8860,
|
|
9177,
|
|
3797,
|
|
2384,
|
|
4209,
|
|
4190,
|
|
383,
|
|
4301,
|
|
4179,
|
|
1166,
|
|
4269,
|
|
4068,
|
|
1192,
|
|
3872,
|
|
4229,
|
|
4061,
|
|
4600,
|
|
4079,
|
|
3988,
|
|
2385,
|
|
4102,
|
|
1186,
|
|
4186,
|
|
3791,
|
|
4200,
|
|
3998,
|
|
3817,
|
|
3861,
|
|
3842,
|
|
3536,
|
|
1040,
|
|
4197,
|
|
3836,
|
|
4195,
|
|
1182,
|
|
1202,
|
|
16161,
|
|
1150,
|
|
1168,
|
|
1151,
|
|
1380,
|
|
4083,
|
|
4013,
|
|
4003,
|
|
1038,
|
|
1155,
|
|
1446,
|
|
1230,
|
|
18958,
|
|
3778,
|
|
4546,
|
|
1143,
|
|
19003,
|
|
2062,
|
|
2201,
|
|
2112,
|
|
2218,
|
|
2203,
|
|
1235,
|
|
1015,
|
|
377,
|
|
1153,
|
|
3970,
|
|
2,
|
|
3,
|
|
4,
|
|
6,
|
|
9,
|
|
10,
|
|
11,
|
|
12,
|
|
13,
|
|
14,
|
|
15,
|
|
16,
|
|
17,
|
|
18,
|
|
21,
|
|
22,
|
|
23,
|
|
24,
|
|
26,
|
|
27,
|
|
28,
|
|
29,
|
|
30,
|
|
32,
|
|
33,
|
|
34,
|
|
35,
|
|
36,
|
|
37,
|
|
38,
|
|
39,
|
|
40,
|
|
41,
|
|
42,
|
|
90,
|
|
91,
|
|
92,
|
|
93,
|
|
94,
|
|
95,
|
|
96,
|
|
97,
|
|
98,
|
|
102,
|
|
103,
|
|
105,
|
|
106,
|
|
108,
|
|
110,
|
|
119,
|
|
122,
|
|
137,
|
|
188,
|
|
189,
|
|
191,
|
|
192,
|
|
193,
|
|
194,
|
|
195,
|
|
196,
|
|
197,
|
|
202,
|
|
203,
|
|
204,
|
|
207,
|
|
208,
|
|
238,
|
|
280,
|
|
286,
|
|
289,
|
|
291,
|
|
307,
|
|
363,
|
|
368,
|
|
388,
|
|
396,
|
|
398,
|
|
399,
|
|
400,
|
|
401,
|
|
469,
|
|
495,
|
|
520,
|
|
636,
|
|
766,
|
|
767,
|
|
768,
|
|
769,
|
|
771,
|
|
772,
|
|
773,
|
|
774,
|
|
775,
|
|
776,
|
|
785,
|
|
786,
|
|
881,
|
|
910,
|
|
912,
|
|
913,
|
|
915,
|
|
917,
|
|
922,
|
|
929,
|
|
933,
|
|
935,
|
|
938,
|
|
942,
|
|
945,
|
|
951,
|
|
954,
|
|
956,
|
|
957,
|
|
965,
|
|
969,
|
|
973,
|
|
976,
|
|
978,
|
|
1384,
|
|
1458,
|
|
1459,
|
|
1461,
|
|
1462,
|
|
1464,
|
|
1465,
|
|
1466,
|
|
1467,
|
|
2257,
|
|
2279,
|
|
3847,
|
|
6489,
|
|
6712,
|
|
7008,
|
|
7325,
|
|
7549,
|
|
7739,
|
|
7999,
|
|
9904,
|
|
13281,
|
|
13643,
|
|
13786,
|
|
13855,
|
|
14103,
|
|
14107,
|
|
14128,
|
|
14134,
|
|
14135,
|
|
16158,
|
|
16256,
|
|
16973,
|
|
17132,
|
|
17385,
|
|
18159,
|
|
18550]}
|
|
|
|
Get a specific item when field matchs the given value::
|
|
|
|
# curl http://localhost:61208/api/3/processlist/pid/9872
|
|
{'9872': [{'cmdline': ['/usr/lib/virtualbox/VBoxHeadless',
|
|
'--comment',
|
|
'minikube',
|
|
'--startvm',
|
|
'74869efd-ada3-41eb-98e3-b7d2901c8e39',
|
|
'--vrde',
|
|
'config'],
|
|
'cpu_percent': 0.0,
|
|
'cpu_times': [82.82, 951.49, 0.0, 0.0, 0.0],
|
|
'gids': [1000, 1000, 1000],
|
|
'io_counters': [0, 0, 0, 0, 0],
|
|
'key': 'pid',
|
|
'memory_info': [964993024,
|
|
4202561536,
|
|
926556160,
|
|
53248,
|
|
0,
|
|
98004992,
|
|
0],
|
|
'memory_percent': 12.29446943525409,
|
|
'name': 'VBoxHeadless',
|
|
'nice': 0,
|
|
'num_threads': 28,
|
|
'pid': 9872,
|
|
'ppid': 9690,
|
|
'status': 'S',
|
|
'time_since_update': 1,
|
|
'username': 'nicolargo'}]}
|
|
|
|
GET psutilversion
|
|
-----------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/psutilversion
|
|
(5, 9, 0)
|
|
|
|
GET quicklook
|
|
-------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/quicklook
|
|
{'cpu': 43.9,
|
|
'cpu_hz': 3000000000.0,
|
|
'cpu_hz_current': 2582499.9999999995,
|
|
'cpu_name': 'Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz',
|
|
'mem': 87.0,
|
|
'percpu': [{'cpu_number': 0,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 54.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 0.0,
|
|
'softirq': 0.0,
|
|
'steal': 0.0,
|
|
'system': 6.0,
|
|
'total': 46.0,
|
|
'user': 21.0},
|
|
{'cpu_number': 1,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 61.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 1.0,
|
|
'softirq': 0.0,
|
|
'steal': 0.0,
|
|
'system': 12.0,
|
|
'total': 39.0,
|
|
'user': 9.0},
|
|
{'cpu_number': 2,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 43.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 0.0,
|
|
'softirq': 0.0,
|
|
'steal': 0.0,
|
|
'system': 11.0,
|
|
'total': 57.0,
|
|
'user': 27.0},
|
|
{'cpu_number': 3,
|
|
'guest': 0.0,
|
|
'guest_nice': 0.0,
|
|
'idle': 26.0,
|
|
'iowait': 0.0,
|
|
'irq': 0.0,
|
|
'key': 'cpu_number',
|
|
'nice': 1.0,
|
|
'softirq': 0.0,
|
|
'steal': 0.0,
|
|
'system': 7.0,
|
|
'total': 74.0,
|
|
'user': 49.0}],
|
|
'swap': 2.3}
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/quicklook/cpu
|
|
{'cpu': 43.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',
|
|
'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 20.04 64bit',
|
|
'linux_distro': 'Ubuntu 20.04',
|
|
'os_name': 'Linux',
|
|
'os_version': '5.4.0-91-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': 197853}
|
|
|
|
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-04-10T15:50:28.031262', 12.1],
|
|
['2022-04-10T15:50:29.075471', 12.1],
|
|
['2022-04-10T15:50:30.175356', 12.1]],
|
|
'user': [['2022-04-10T15:50:28.031256', 30.7],
|
|
['2022-04-10T15:50:29.075468', 30.7],
|
|
['2022-04-10T15:50:30.175351', 5.8]]}
|
|
|
|
Limit history to last 2 values::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/history/2
|
|
{'system': [['2022-04-10T15:50:29.075471', 12.1],
|
|
['2022-04-10T15:50:30.175356', 12.1]],
|
|
'user': [['2022-04-10T15:50:29.075468', 30.7],
|
|
['2022-04-10T15:50:30.175351', 5.8]]}
|
|
|
|
History for a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/system/history
|
|
{'system': [['2022-04-10T15:50:28.031262', 12.1],
|
|
['2022-04-10T15:50:29.075471', 12.1],
|
|
['2022-04-10T15:50:30.175356', 12.1]]}
|
|
|
|
Limit history for a specific field to last 2 values::
|
|
|
|
# curl http://localhost:61208/api/3/cpu/system/history
|
|
{'system': [['2022-04-10T15:50:29.075471', 12.1],
|
|
['2022-04-10T15:50:30.175356', 12.1]]}
|
|
|
|
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}
|
|
|