From 6e844f3c8b34c4a5f859c6694c462bbf97129403 Mon Sep 17 00:00:00 2001 From: nicolargo Date: Fri, 2 Jan 2026 18:10:00 +0100 Subject: [PATCH] Update doc --- all-requirements.txt | 54 +- dev-requirements.txt | 227 ++---- docker-requirements.txt | 10 +- docs/api/openapi.json | 924 +---------------------- docs/api/python.rst | 394 +++++----- docs/api/restful.rst | 673 ++++++----------- docs/man/glances.1 | 4 +- glances/outputs/static/package-lock.json | 7 +- requirements.txt | 2 +- 9 files changed, 531 insertions(+), 1764 deletions(-) diff --git a/all-requirements.txt b/all-requirements.txt index 1490938c..443e69f2 100644 --- a/all-requirements.txt +++ b/all-requirements.txt @@ -40,23 +40,17 @@ cryptography==46.0.3 # via pysnmpcrypto defusedxml==0.7.1 # via glances -dnspython==2.7.0 ; python_full_version < '3.10' - # via pymongo -dnspython==2.8.0 ; python_full_version >= '3.10' +dnspython==2.8.0 # via pymongo docker==7.1.0 # via glances -elastic-transport==9.1.0 ; python_full_version < '3.10' +elastic-transport==9.2.1 # via elasticsearch -elastic-transport==9.2.0 ; python_full_version >= '3.10' - # via elasticsearch -elasticsearch==9.1.2 ; python_full_version < '3.10' - # via glances -elasticsearch==9.2.0 ; python_full_version >= '3.10' +elasticsearch==9.2.1 # via glances exceptiongroup==1.2.2 ; python_full_version < '3.11' # via anyio -fastapi==0.125.0 +fastapi==0.128.0 # via glances geomet==1.1.0 # via cassandra-driver @@ -68,9 +62,7 @@ humanfriendly==10.0 # via pysmart ibm-cloud-sdk-core==3.24.2 # via ibmcloudant -ibmcloudant==0.11.0 ; python_full_version < '3.10' - # via glances -ibmcloudant==0.11.2 ; python_full_version >= '3.10' +ibmcloudant==0.11.2 # via glances idna==3.11 # via @@ -78,9 +70,7 @@ idna==3.11 # requests ifaddr==0.2.0 # via zeroconf -importlib-metadata==7.1.0 ; python_full_version < '3.10' - # via pygal -importlib-metadata==8.7.0 ; python_full_version >= '3.10' +importlib-metadata==8.7.1 # via pygal influxdb==5.3.2 # via glances @@ -98,6 +88,8 @@ markupsafe==3.0.3 # via jinja2 msgpack==1.1.2 # via influxdb +nats-py==2.12.0 + # via glances netifaces2==0.0.22 # via glances nvidia-ml-py==13.590.44 @@ -118,23 +110,15 @@ potsdb==1.0.3 # via glances prometheus-client==0.23.1 # via glances -protobuf==4.25.8 ; python_full_version < '3.10' +protobuf==6.33.2 # via bernhard -protobuf==6.33.2 ; python_full_version >= '3.10' - # via bernhard -psutil==7.1.3 +psutil==7.2.1 # via glances -psycopg==3.2.13 ; python_full_version < '3.10' +psycopg==3.3.2 # via glances -psycopg==3.3.2 ; python_full_version >= '3.10' - # via glances -psycopg-binary==3.2.13 ; python_full_version < '3.10' and implementation_name != 'pypy' +psycopg-binary==3.3.2 ; implementation_name != 'pypy' # via psycopg -psycopg-binary==3.3.2 ; python_full_version >= '3.10' and implementation_name != 'pypy' - # via psycopg -pyarrow==21.0.0 ; python_full_version < '3.10' - # via influxdb3-python -pyarrow==22.0.0 ; python_full_version >= '3.10' +pyarrow==22.0.0 # via influxdb3-python pyasn1==0.6.1 # via pysnmp-lextudio @@ -203,21 +187,17 @@ six==1.17.0 # glances # influxdb # python-dateutil -sniffio==1.3.1 ; python_full_version >= '3.10' +sniffio==1.3.1 # via # elastic-transport # elasticsearch sparklines==0.7.0 # via glances -starlette==0.49.3 ; python_full_version < '3.10' - # via fastapi -starlette==0.50.0 ; python_full_version >= '3.10' +starlette==0.50.0 # via fastapi statsd==4.0.1 # via glances -termcolor==3.1.0 ; python_full_version < '3.10' - # via sparklines -termcolor==3.2.0 ; python_full_version >= '3.10' +termcolor==3.3.0 # via sparklines tomli==2.0.2 ; python_full_version < '3.11' # via podman @@ -247,7 +227,7 @@ urllib3==2.6.2 # influxdb3-python # podman # requests -uvicorn==0.38.0 +uvicorn==0.40.0 # via glances wifi==0.3.8 # via glances diff --git a/dev-requirements.txt b/dev-requirements.txt index bb88d3e3..2ed09c62 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -1,12 +1,10 @@ # This file was autogenerated by uv via the following command: # uv export --no-hashes --only-dev --output-file dev-requirements.txt -alabaster==0.7.16 ; python_full_version < '3.10' - # via sphinx -alabaster==1.0.0 ; python_full_version >= '3.10' +alabaster==1.0.0 # via sphinx annotated-types==0.7.0 # via pydantic -anyio==4.12.0 ; python_full_version >= '3.10' +anyio==4.12.0 # via # httpx # mcp @@ -23,17 +21,13 @@ attrs==25.4.0 # trio babel==2.17.0 # via sphinx -binaryornot==0.4.4 ; python_full_version < '3.10' - # via reuse boltons==21.0.0 # via # face # glom # semgrep boolean-py==5.0 - # via - # license-expression - # reuse + # via license-expression bracex==2.6 # via wcmatch certifi==2025.11.12 @@ -42,16 +36,12 @@ certifi==2025.11.12 # httpx # requests # selenium -cffi==2.0.0 ; (python_full_version >= '3.10' and implementation_name == 'pypy' and platform_python_implementation != 'PyPy') or (python_full_version >= '3.10' and os_name != 'nt' and platform_python_implementation != 'PyPy') or (implementation_name != 'pypy' and os_name == 'nt') +cffi==2.0.0 ; (implementation_name != 'pypy' and os_name == 'nt') or platform_python_implementation != 'PyPy' # via # cryptography # trio -cfgv==3.4.0 ; python_full_version < '3.10' +cfgv==3.5.0 # via pre-commit -cfgv==3.5.0 ; python_full_version >= '3.10' - # via pre-commit -chardet==5.2.0 ; python_full_version < '3.10' - # via binaryornot charset-normalizer==3.4.4 # via # python-debian @@ -72,22 +62,14 @@ colorama==0.4.6 # pytest # semgrep # sphinx -contourpy==1.3.0 ; python_full_version < '3.10' - # via matplotlib -contourpy==1.3.2 ; python_full_version == '3.10.*' +contourpy==1.3.2 ; python_full_version < '3.11' # via matplotlib contourpy==1.3.3 ; python_full_version >= '3.11' # via matplotlib -cryptography==46.0.3 ; python_full_version >= '3.10' +cryptography==46.0.3 # via pyjwt cycler==0.12.1 # via matplotlib -defusedxml==0.7.1 ; python_full_version < '3.10' - # via semgrep -deprecated==1.3.1 ; python_full_version < '3.10' - # via - # opentelemetry-api - # opentelemetry-exporter-otlp-proto-http distlib==0.4.0 # via virtualenv docutils==0.21.2 @@ -104,13 +86,9 @@ exceptiongroup==1.2.2 # trio-websocket face==24.0.0 # via glom -filelock==3.19.1 ; python_full_version < '3.10' +filelock==3.20.2 # via virtualenv -filelock==3.20.1 ; python_full_version >= '3.10' - # via virtualenv -fonttools==4.60.2 ; python_full_version < '3.10' - # via matplotlib -fonttools==4.61.1 ; python_full_version >= '3.10' +fonttools==4.61.1 # via matplotlib glom==22.1.0 # via semgrep @@ -122,11 +100,11 @@ h11==0.16.0 # httpcore # uvicorn # wsproto -httpcore==1.0.9 ; python_full_version >= '3.10' +httpcore==1.0.9 # via httpx -httpx==0.28.1 ; python_full_version >= '3.10' +httpx==0.28.1 # via mcp -httpx-sse==0.4.3 ; python_full_version >= '3.10' +httpx-sse==0.4.3 # via mcp identify==2.6.15 # via pre-commit @@ -138,17 +116,9 @@ idna==3.11 # trio imagesize==1.4.1 # via sphinx -importlib-metadata==7.1.0 ; python_full_version < '3.10' - # via - # opentelemetry-api - # sphinx -importlib-metadata==8.7.0 ; python_full_version >= '3.10' +importlib-metadata==8.7.1 # via opentelemetry-api -importlib-resources==6.5.2 ; python_full_version < '3.10' - # via matplotlib -iniconfig==2.1.0 ; python_full_version < '3.10' - # via pytest -iniconfig==2.3.0 ; python_full_version >= '3.10' +iniconfig==2.3.0 # via pytest jinja2==3.1.6 # via @@ -160,42 +130,33 @@ jsonschema==4.25.1 # semgrep jsonschema-specifications==2025.9.1 # via jsonschema -kiwisolver==1.4.7 ; python_full_version < '3.10' - # via matplotlib -kiwisolver==1.4.9 ; python_full_version >= '3.10' +kiwisolver==1.4.9 # via matplotlib license-expression==30.4.4 # via reuse -markdown-it-py==3.0.0 ; python_full_version < '3.10' - # via rich -markdown-it-py==4.0.0 ; python_full_version >= '3.10' +markdown-it-py==4.0.0 # via rich markupsafe==3.0.3 # via jinja2 -matplotlib==3.9.4 ; python_full_version < '3.10' -matplotlib==3.10.8 ; python_full_version >= '3.10' -mcp==1.23.3 ; python_full_version >= '3.10' +matplotlib==3.10.8 +mcp==1.23.3 # via semgrep mdurl==0.1.2 # via markdown-it-py memory-profiler==0.61.0 -nodeenv==1.9.1 +nodeenv==1.10.0 # via # pre-commit # pyright -numpy==2.0.2 ; python_full_version < '3.10' +numpy==2.2.6 ; python_full_version < '3.11' # via # contourpy # matplotlib -numpy==2.2.6 ; python_full_version == '3.10.*' +numpy==2.4.0 ; python_full_version >= '3.11' # via # contourpy # matplotlib -numpy==2.3.5 ; python_full_version >= '3.11' - # via - # contourpy - # matplotlib -opentelemetry-api==1.25.0 ; python_full_version < '3.10' +opentelemetry-api==1.37.0 # via # opentelemetry-exporter-otlp-proto-http # opentelemetry-instrumentation @@ -203,58 +164,28 @@ opentelemetry-api==1.25.0 ; python_full_version < '3.10' # opentelemetry-sdk # opentelemetry-semantic-conventions # semgrep -opentelemetry-api==1.37.0 ; python_full_version >= '3.10' - # via - # opentelemetry-exporter-otlp-proto-http - # opentelemetry-instrumentation - # opentelemetry-instrumentation-requests - # opentelemetry-sdk - # opentelemetry-semantic-conventions - # semgrep -opentelemetry-exporter-otlp-proto-common==1.25.0 ; python_full_version < '3.10' +opentelemetry-exporter-otlp-proto-common==1.37.0 # via opentelemetry-exporter-otlp-proto-http -opentelemetry-exporter-otlp-proto-common==1.37.0 ; python_full_version >= '3.10' - # via opentelemetry-exporter-otlp-proto-http -opentelemetry-exporter-otlp-proto-http==1.25.0 ; python_full_version < '3.10' +opentelemetry-exporter-otlp-proto-http==1.37.0 # via semgrep -opentelemetry-exporter-otlp-proto-http==1.37.0 ; python_full_version >= '3.10' - # via semgrep -opentelemetry-instrumentation==0.46b0 ; python_full_version < '3.10' +opentelemetry-instrumentation==0.58b0 # via opentelemetry-instrumentation-requests -opentelemetry-instrumentation==0.58b0 ; python_full_version >= '3.10' - # via opentelemetry-instrumentation-requests -opentelemetry-instrumentation-requests==0.46b0 ; python_full_version < '3.10' +opentelemetry-instrumentation-requests==0.58b0 # via semgrep -opentelemetry-instrumentation-requests==0.58b0 ; python_full_version >= '3.10' - # via semgrep -opentelemetry-proto==1.25.0 ; python_full_version < '3.10' +opentelemetry-proto==1.37.0 # via # opentelemetry-exporter-otlp-proto-common # opentelemetry-exporter-otlp-proto-http -opentelemetry-proto==1.37.0 ; python_full_version >= '3.10' - # via - # opentelemetry-exporter-otlp-proto-common - # opentelemetry-exporter-otlp-proto-http -opentelemetry-sdk==1.25.0 ; python_full_version < '3.10' +opentelemetry-sdk==1.37.0 # via # opentelemetry-exporter-otlp-proto-http # semgrep -opentelemetry-sdk==1.37.0 ; python_full_version >= '3.10' - # via - # opentelemetry-exporter-otlp-proto-http - # semgrep -opentelemetry-semantic-conventions==0.46b0 ; python_full_version < '3.10' - # via - # opentelemetry-instrumentation-requests - # opentelemetry-sdk -opentelemetry-semantic-conventions==0.58b0 ; python_full_version >= '3.10' +opentelemetry-semantic-conventions==0.58b0 # via # opentelemetry-instrumentation # opentelemetry-instrumentation-requests # opentelemetry-sdk -opentelemetry-util-http==0.46b0 ; python_full_version < '3.10' - # via opentelemetry-instrumentation-requests -opentelemetry-util-http==0.58b0 ; python_full_version >= '3.10' +opentelemetry-util-http==0.58b0 # via opentelemetry-instrumentation-requests outcome==1.3.0.post0 # via @@ -271,30 +202,21 @@ packaging==25.0 # webdriver-manager peewee==3.18.3 # via semgrep -pillow==11.3.0 ; python_full_version < '3.10' +pillow==12.1.0 # via matplotlib -pillow==12.0.0 ; python_full_version >= '3.10' - # via matplotlib -platformdirs==4.4.0 ; python_full_version < '3.10' - # via virtualenv -platformdirs==4.5.1 ; python_full_version >= '3.10' +platformdirs==4.5.1 # via virtualenv pluggy==1.6.0 # via pytest -pre-commit==4.3.0 ; python_full_version < '3.10' -pre-commit==4.5.1 ; python_full_version >= '3.10' +pre-commit==4.5.1 +protobuf==6.33.2 # via # googleapis-common-protos # opentelemetry-proto -protobuf==6.33.2 ; python_full_version >= '3.10' -protobuf==4.25.8 ; python_full_version < '3.10' - # via - # googleapis-common-protos - # opentelemetry-proto -psutil==7.1.3 +psutil==7.2.1 # via memory-profiler py-spy==0.4.1 -pycparser==2.23 ; (python_full_version >= '3.10' and implementation_name != 'PyPy' and os_name != 'nt' and platform_python_implementation != 'PyPy') or (python_full_version >= '3.10' and implementation_name == 'pypy' and os_name == 'nt' and platform_python_implementation != 'PyPy') or (implementation_name != 'PyPy' and implementation_name != 'pypy' and os_name == 'nt') +pycparser==2.23 ; (implementation_name != 'PyPy' and implementation_name != 'pypy' and os_name == 'nt') or (implementation_name != 'PyPy' and platform_python_implementation != 'PyPy') # via cffi pydantic==2.12.5 # via @@ -303,7 +225,7 @@ pydantic==2.12.5 # rstcheck-core pydantic-core==2.41.5 # via pydantic -pydantic-settings==2.12.0 ; python_full_version >= '3.10' +pydantic-settings==2.12.0 # via mcp pygments==2.19.2 # via @@ -311,15 +233,14 @@ pygments==2.19.2 # rich # sphinx pyinstrument==5.1.1 -pyjwt==2.10.1 ; python_full_version >= '3.10' +pyjwt==2.10.1 # via mcp -pyparsing==3.2.5 +pyparsing==3.3.1 # via matplotlib pyright==1.1.407 pysocks==1.7.1 # via urllib3 -pytest==8.4.2 ; python_full_version < '3.10' -pytest==9.0.2 ; python_full_version >= '3.10' +pytest==9.0.2 python-dateutil==2.9.0.post0 # via matplotlib python-debian==1.0.1 @@ -328,21 +249,17 @@ python-dotenv==1.2.1 # via # pydantic-settings # webdriver-manager -python-magic==0.4.27 ; python_full_version >= '3.10' +python-magic==0.4.27 # via reuse -python-multipart==0.0.21 ; python_full_version >= '3.10' +python-multipart==0.0.21 # via mcp -pywin32==311 ; python_full_version >= '3.10' and sys_platform == 'win32' +pywin32==311 ; sys_platform == 'win32' # via # mcp # semgrep pyyaml==6.0.3 # via pre-commit -referencing==0.36.2 ; python_full_version < '3.10' - # via - # jsonschema - # jsonschema-specifications -referencing==0.37.0 ; python_full_version >= '3.10' +referencing==0.37.0 # via # jsonschema # jsonschema-specifications @@ -353,8 +270,7 @@ requests==2.32.5 # sphinx # webdriver-manager requirements-parser==0.13.0 -reuse==5.1.1 ; python_full_version < '3.10' -reuse==6.2.0 ; python_full_version >= '3.10' +reuse==6.2.0 rich==13.5.3 # via # semgrep @@ -363,30 +279,21 @@ roman-numerals==4.1.0 ; python_full_version >= '3.11' # via roman-numerals-py roman-numerals-py==4.1.0 ; python_full_version >= '3.11' # via sphinx -rpds-py==0.27.1 ; python_full_version < '3.10' - # via - # jsonschema - # referencing -rpds-py==0.30.0 ; python_full_version >= '3.10' +rpds-py==0.30.0 # via # jsonschema # referencing rstcheck==6.2.5 rstcheck-core==1.2.2 # via rstcheck -ruamel-yaml==0.18.16 +ruamel-yaml==0.19.1 + # via semgrep +ruamel-yaml-clib==0.2.14 # via semgrep -ruamel-yaml-clib==0.2.14 ; python_full_version >= '3.10' or platform_python_implementation == 'CPython' - # via - # ruamel-yaml - # semgrep ruff==0.14.10 -selenium==4.36.0 ; python_full_version < '3.10' -selenium==4.39.0 ; python_full_version >= '3.10' -semgrep==1.136.0 ; python_full_version < '3.10' -semgrep==1.146.0 ; python_full_version >= '3.10' +selenium==4.39.0 +semgrep==1.146.0 setuptools==80.9.0 - # via opentelemetry-instrumentation shellingham==1.5.4 # via typer six==1.17.0 @@ -397,11 +304,7 @@ snowballstemmer==3.0.1 # via sphinx sortedcontainers==2.4.0 # via trio -sphinx==7.4.7 ; python_full_version < '3.10' - # via - # sphinx-rtd-theme - # sphinxcontrib-jquery -sphinx==8.1.3 ; python_full_version == '3.10.*' +sphinx==8.1.3 ; python_full_version < '3.11' # via # sphinx-rtd-theme # sphinxcontrib-jquery @@ -424,9 +327,9 @@ sphinxcontrib-qthelp==2.0.0 # via sphinx sphinxcontrib-serializinghtml==2.0.0 # via sphinx -sse-starlette==3.0.4 ; python_full_version >= '3.10' +sse-starlette==3.1.2 # via mcp -starlette==0.50.0 ; python_full_version >= '3.10' +starlette==0.50.0 # via # mcp # sse-starlette @@ -437,17 +340,13 @@ tomli==2.0.2 # sphinx tomlkit==0.13.3 # via reuse -trio==0.31.0 ; python_full_version < '3.10' - # via - # selenium - # trio-websocket -trio==0.32.0 ; python_full_version >= '3.10' +trio==0.32.0 # via # selenium # trio-websocket trio-websocket==0.12.2 # via selenium -typer==0.20.1 +typer==0.21.0 # via rstcheck typing-extensions==4.15.0 # via @@ -479,7 +378,7 @@ urllib3==2.6.2 # requests # selenium # semgrep -uvicorn==0.38.0 ; python_full_version >= '3.10' and sys_platform != 'emscripten' +uvicorn==0.40.0 ; sys_platform != 'emscripten' # via mcp virtualenv==20.35.4 # via pre-commit @@ -489,14 +388,8 @@ webdriver-manager==4.0.2 websocket-client==1.9.0 # via selenium wrapt==1.17.3 - # via - # deprecated - # opentelemetry-instrumentation -wsproto==1.2.0 ; python_full_version < '3.10' - # via trio-websocket -wsproto==1.3.2 ; python_full_version >= '3.10' + # via opentelemetry-instrumentation +wsproto==1.3.2 # via trio-websocket zipp==3.23.0 - # via - # importlib-metadata - # importlib-resources + # via importlib-metadata diff --git a/docker-requirements.txt b/docker-requirements.txt index b719a96f..ab2fb801 100644 --- a/docker-requirements.txt +++ b/docker-requirements.txt @@ -20,7 +20,7 @@ docker==7.1.0 # via glances exceptiongroup==1.2.2 ; python_full_version < '3.11' # via anyio -fastapi==0.125.0 +fastapi==0.128.0 # via glances h11==0.16.0 # via uvicorn @@ -36,7 +36,7 @@ packaging==25.0 # via glances podman==5.6.0 # via glances -psutil==7.1.3 +psutil==7.2.1 # via glances pydantic==2.12.5 # via fastapi @@ -57,9 +57,7 @@ six==1.17.0 # via # glances # python-dateutil -starlette==0.49.3 ; python_full_version < '3.10' - # via fastapi -starlette==0.50.0 ; python_full_version >= '3.10' +starlette==0.50.0 # via fastapi tomli==2.0.2 ; python_full_version < '3.11' # via podman @@ -79,7 +77,7 @@ urllib3==2.6.2 # docker # podman # requests -uvicorn==0.38.0 +uvicorn==0.40.0 # via glances windows-curses==2.4.1 ; sys_platform == 'win32' # via glances diff --git a/docs/api/openapi.json b/docs/api/openapi.json index 7d252361..ac06893f 100644 --- a/docs/api/openapi.json +++ b/docs/api/openapi.json @@ -1,923 +1 @@ -{ - "openapi": "3.0.2", - "info": { "title": "FastAPI", "version": "0.1.0" }, - "paths": { - "/api/4/status": { - "get": { - "summary": " Api Status", - "description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\nThis entry point should be used to check the API health.\n\nSee related issue: Web server health check endpoint #1988", - "operationId": "_api_status_api_4_status_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - }, - "head": { - "summary": " Api Status", - "description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\nThis entry point should be used to check the API health.\n\nSee related issue: Web server health check endpoint #1988", - "operationId": "_api_status_api_4_status_head", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/events/clear/warning": { - "post": { - "summary": " Events Clear Warning", - "description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\n\nIt's a post message to clean warning events", - "operationId": "_events_clear_warning_api_4_events_clear_warning_post", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/events/clear/all": { - "post": { - "summary": " Events Clear All", - "description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\n\nIt's a post message to clean all events", - "operationId": "_events_clear_all_api_4_events_clear_all_post", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/processes/extended/disable": { - "post": { - "summary": " Api Disable Extended Processes", - "description": "Glances API RESTful implementation.\n\nDisable extended process stats\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error", - "operationId": "_api_disable_extended_processes_api_4_processes_extended_disable_post", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/processes/extended/{pid}": { - "post": { - "summary": " Api Set Extended Processes", - "description": "Glances API RESTful implementation.\n\nSet the extended process stats for the given PID\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error", - "operationId": "_api_set_extended_processes_api_4_processes_extended__pid__post", - "parameters": [ - { - "name": "pid", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Pid" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/config": { - "get": { - "summary": " Api Config", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances configuration file\nHTTP/200 if OK\nHTTP/404 if others error", - "operationId": "_api_config_api_4_config_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/config/{section}": { - "get": { - "summary": " Api Config Section", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances configuration section\nHTTP/200 if OK\nHTTP/400 if item is not found\nHTTP/404 if others error", - "operationId": "_api_config_section_api_4_config__section__get", - "parameters": [ - { - "name": "section", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Section" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/config/{section}/{item}": { - "get": { - "summary": " Api Config Section Item", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances configuration section/item\nHTTP/200 if OK\nHTTP/400 if item is not found\nHTTP/404 if others error", - "operationId": "_api_config_section_item_api_4_config__section___item__get", - "parameters": [ - { - "name": "section", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Section" } - }, - { - "name": "item", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Item" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/args": { - "get": { - "summary": " Api Args", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances command line arguments\nHTTP/200 if OK\nHTTP/404 if others error", - "operationId": "_api_args_api_4_args_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/args/{item}": { - "get": { - "summary": " Api Args Item", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances command line arguments item\nHTTP/200 if OK\nHTTP/400 if item is not found\nHTTP/404 if others error", - "operationId": "_api_args_item_api_4_args__item__get", - "parameters": [ - { - "name": "item", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Item" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/help": { - "get": { - "summary": " Api Help", - "description": "Glances API RESTful implementation.\n\nReturn the help data or 404 error.", - "operationId": "_api_help_api_4_help_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/all": { - "get": { - "summary": " Api All", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of all the plugins\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_all_api_4_all_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/all/limits": { - "get": { - "summary": " Api All Limits", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of all the plugins limits\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_all_limits_api_4_all_limits_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/all/views": { - "get": { - "summary": " Api All Views", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of all the plugins views\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_all_views_api_4_all_views_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/pluginslist": { - "get": { - "summary": " Api Plugins", - "description": "Glances API RESTFul implementation.\n\n@api {get} /api/%s/pluginslist Get plugins list\n@apiVersion 2.0\n@apiName pluginslist\n@apiGroup plugin\n\n@apiSuccess {String[]} Plugins list.\n\n@apiSuccessExample Success-Response:\n HTTP/1.1 200 OK\n [\n \"load\",\n \"help\",\n \"ip\",\n \"memswap\",\n \"processlist\",\n ...\n ]\n\n @apiError Cannot get plugin list.\n\n @apiErrorExample Error-Response:\n HTTP/1.1 404 Not Found", - "operationId": "_api_plugins_api_4_pluginslist_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/serverslist": { - "get": { - "summary": " Api Servers List", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the servers list (for browser mode)\nHTTP/200 if OK", - "operationId": "_api_servers_list_api_4_serverslist_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/processes/extended": { - "get": { - "summary": " Api Get Extended Processes", - "description": "Glances API RESTful implementation.\n\nGet the extended process stats (if set before)\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error", - "operationId": "_api_get_extended_processes_api_4_processes_extended_get", - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - } - } - } - }, - "/api/4/processes/{pid}": { - "get": { - "summary": " Api Get Processes", - "description": "Glances API RESTful implementation.\n\nGet the process stats for the given PID\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error", - "operationId": "_api_get_processes_api_4_processes__pid__get", - "parameters": [ - { - "name": "pid", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Pid" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}": { - "get": { - "summary": " Api", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_api_4__plugin__get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/history": { - "get": { - "summary": " Api History", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin history\nLimit to the last nb items (all if nb=0)\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_history_api_4__plugin__history_get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "nb", - "in": "query", - "required": false, - "schema": { "type": "integer", "default": 0, "title": "Nb" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/history/{nb}": { - "get": { - "summary": " Api History", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin history\nLimit to the last nb items (all if nb=0)\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_history_api_4__plugin__history__nb__get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "nb", - "in": "path", - "required": true, - "schema": { "type": "integer", "title": "Nb" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/top/{nb}": { - "get": { - "summary": " Api Top", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin limited to the top nb items.\nIt is used to reduce the payload of the HTTP response (example: processlist).\n\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_top_api_4__plugin__top__nb__get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "nb", - "in": "path", - "required": true, - "schema": { "type": "integer", "title": "Nb" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/limits": { - "get": { - "summary": " Api Limits", - "description": "Glances API RESTful implementation.\n\nReturn the JSON limits of a given plugin\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_limits_api_4__plugin__limits_get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/views": { - "get": { - "summary": " Api Views", - "description": "Glances API RESTful implementation.\n\nReturn the JSON views of a given plugin\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_views_api_4__plugin__views_get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/{item}": { - "get": { - "summary": " Api Item", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_item_api_4__plugin___item__get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "item", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Item" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/{item}/views": { - "get": { - "summary": " Api Item Views", - "description": "Glances API RESTful implementation.\n\nReturn the JSON view representation of the couple plugin/item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_item_views_api_4__plugin___item__views_get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "item", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Item" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/{item}/history": { - "get": { - "summary": " Api Item History", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/history of item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_item_history_api_4__plugin___item__history_get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "item", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Item" } - }, - { - "name": "nb", - "in": "query", - "required": false, - "schema": { "type": "integer", "default": 0, "title": "Nb" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/{item}/history/{nb}": { - "get": { - "summary": " Api Item History", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/history of item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_item_history_api_4__plugin___item__history__nb__get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "item", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Item" } - }, - { - "name": "nb", - "in": "path", - "required": true, - "schema": { "type": "integer", "title": "Nb" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/{item}/description": { - "get": { - "summary": " Api Item Description", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/item description\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_item_description_api_4__plugin___item__description_get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "item", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Item" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/{item}/unit": { - "get": { - "summary": " Api Item Unit", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/item unit\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_item_unit_api_4__plugin___item__unit_get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "item", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Item" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/{item}/value/{value}": { - "get": { - "summary": " Api Value", - "description": "Glances API RESTful implementation.\n\nReturn the process stats (dict) for the given item=value\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_value_api_4__plugin___item__value__value__get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "item", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Item" } - }, - { - "name": "value", - "in": "path", - "required": true, - "schema": { - "anyOf": [ - { "type": "string" }, - { "type": "integer" }, - { "type": "number" } - ], - "title": "Value" - } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/{item}/{key}": { - "get": { - "summary": " Api Key", - "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of plugin/item/key\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_key_api_4__plugin___item___key__get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "item", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Item" } - }, - { - "name": "key", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Key" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/api/4/{plugin}/{item}/{key}/views": { - "get": { - "summary": " Api Key Views", - "description": "Glances API RESTful implementation.\n\nReturn the JSON view representation of plugin/item/key\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", - "operationId": "_api_key_views_api_4__plugin___item___key__views_get", - "parameters": [ - { - "name": "plugin", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Plugin" } - }, - { - "name": "item", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Item" } - }, - { - "name": "key", - "in": "path", - "required": true, - "schema": { "type": "string", "title": "Key" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { "application/json": { "schema": {} } } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } - } - } - } - } - } - }, - "/": { - "get": { - "summary": " Index", - "description": "Return main index.html (/) file.\n\nParameters are available through the request object.\nExample: http://localhost:61208/?refresh=5\n\nNote: This function is only called the first time the page is loaded.", - "operationId": "_index__get", - "responses": { - "200": { - "description": "Successful Response", - "content": { "text/html": { "schema": { "type": "string" } } } - } - } - } - } - }, - "components": { - "schemas": { - "HTTPValidationError": { - "properties": { - "detail": { - "items": { "$ref": "#/components/schemas/ValidationError" }, - "type": "array", - "title": "Detail" - } - }, - "type": "object", - "title": "HTTPValidationError" - }, - "ValidationError": { - "properties": { - "loc": { - "items": { "anyOf": [{ "type": "string" }, { "type": "integer" }] }, - "type": "array", - "title": "Location" - }, - "msg": { "type": "string", "title": "Message" }, - "type": { "type": "string", "title": "Error Type" } - }, - "type": "object", - "required": ["loc", "msg", "type"], - "title": "ValidationError" - } - } - } -} +{"openapi": "3.0.2", "info": {"title": "FastAPI", "version": "0.1.0"}, "paths": {"/api/4/status": {"get": {"summary": " Api Status", "description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\nThis entry point should be used to check the API health.\n\nSee related issue: Web server health check endpoint #1988", "operationId": "_api_status_api_4_status_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}, "head": {"summary": " Api Status", "description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\nThis entry point should be used to check the API health.\n\nSee related issue: Web server health check endpoint #1988", "operationId": "_api_status_api_4_status_head", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/events/clear/warning": {"post": {"summary": " Events Clear Warning", "description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\n\nIt's a post message to clean warning events", "operationId": "_events_clear_warning_api_4_events_clear_warning_post", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/events/clear/all": {"post": {"summary": " Events Clear All", "description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\n\nIt's a post message to clean all events", "operationId": "_events_clear_all_api_4_events_clear_all_post", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/processes/extended/disable": {"post": {"summary": " Api Disable Extended Processes", "description": "Glances API RESTful implementation.\n\nDisable extended process stats\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error", "operationId": "_api_disable_extended_processes_api_4_processes_extended_disable_post", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/processes/extended/{pid}": {"post": {"summary": " Api Set Extended Processes", "description": "Glances API RESTful implementation.\n\nSet the extended process stats for the given PID\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error", "operationId": "_api_set_extended_processes_api_4_processes_extended__pid__post", "parameters": [{"name": "pid", "in": "path", "required": true, "schema": {"type": "string", "title": "Pid"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/config": {"get": {"summary": " Api Config", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances configuration file\nHTTP/200 if OK\nHTTP/404 if others error", "operationId": "_api_config_api_4_config_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/config/{section}": {"get": {"summary": " Api Config Section", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances configuration section\nHTTP/200 if OK\nHTTP/400 if item is not found\nHTTP/404 if others error", "operationId": "_api_config_section_api_4_config__section__get", "parameters": [{"name": "section", "in": "path", "required": true, "schema": {"type": "string", "title": "Section"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/config/{section}/{item}": {"get": {"summary": " Api Config Section Item", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances configuration section/item\nHTTP/200 if OK\nHTTP/400 if item is not found\nHTTP/404 if others error", "operationId": "_api_config_section_item_api_4_config__section___item__get", "parameters": [{"name": "section", "in": "path", "required": true, "schema": {"type": "string", "title": "Section"}}, {"name": "item", "in": "path", "required": true, "schema": {"type": "string", "title": "Item"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/args": {"get": {"summary": " Api Args", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances command line arguments\nHTTP/200 if OK\nHTTP/404 if others error", "operationId": "_api_args_api_4_args_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/args/{item}": {"get": {"summary": " Api Args Item", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances command line arguments item\nHTTP/200 if OK\nHTTP/400 if item is not found\nHTTP/404 if others error", "operationId": "_api_args_item_api_4_args__item__get", "parameters": [{"name": "item", "in": "path", "required": true, "schema": {"type": "string", "title": "Item"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/help": {"get": {"summary": " Api Help", "description": "Glances API RESTful implementation.\n\nReturn the help data or 404 error.", "operationId": "_api_help_api_4_help_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/all": {"get": {"summary": " Api All", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of all the plugins\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_all_api_4_all_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/all/limits": {"get": {"summary": " Api All Limits", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of all the plugins limits\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_all_limits_api_4_all_limits_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/all/views": {"get": {"summary": " Api All Views", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of all the plugins views\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_all_views_api_4_all_views_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/pluginslist": {"get": {"summary": " Api Plugins", "description": "Glances API RESTFul implementation.\n\n@api {get} /api/%s/pluginslist Get plugins list\n@apiVersion 2.0\n@apiName pluginslist\n@apiGroup plugin\n\n@apiSuccess {String[]} Plugins list.\n\n@apiSuccessExample Success-Response:\n HTTP/1.1 200 OK\n [\n \"load\",\n \"help\",\n \"ip\",\n \"memswap\",\n \"processlist\",\n ...\n ]\n\n @apiError Cannot get plugin list.\n\n @apiErrorExample Error-Response:\n HTTP/1.1 404 Not Found", "operationId": "_api_plugins_api_4_pluginslist_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/serverslist": {"get": {"summary": " Api Servers List", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the servers list (for browser mode)\nHTTP/200 if OK", "operationId": "_api_servers_list_api_4_serverslist_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/processes/extended": {"get": {"summary": " Api Get Extended Processes", "description": "Glances API RESTful implementation.\n\nGet the extended process stats (if set before)\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error", "operationId": "_api_get_extended_processes_api_4_processes_extended_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/4/processes/{pid}": {"get": {"summary": " Api Get Processes", "description": "Glances API RESTful implementation.\n\nGet the process stats for the given PID\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error", "operationId": "_api_get_processes_api_4_processes__pid__get", "parameters": [{"name": "pid", "in": "path", "required": true, "schema": {"type": "string", "title": "Pid"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}": {"get": {"summary": " Api", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_api_4__plugin__get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/history": {"get": {"summary": " Api History", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin history\nLimit to the last nb items (all if nb=0)\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_history_api_4__plugin__history_get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "nb", "in": "query", "required": false, "schema": {"type": "integer", "default": 0, "title": "Nb"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/history/{nb}": {"get": {"summary": " Api History", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin history\nLimit to the last nb items (all if nb=0)\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_history_api_4__plugin__history__nb__get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "nb", "in": "path", "required": true, "schema": {"type": "integer", "title": "Nb"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/top/{nb}": {"get": {"summary": " Api Top", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin limited to the top nb items.\nIt is used to reduce the payload of the HTTP response (example: processlist).\n\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_top_api_4__plugin__top__nb__get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "nb", "in": "path", "required": true, "schema": {"type": "integer", "title": "Nb"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/limits": {"get": {"summary": " Api Limits", "description": "Glances API RESTful implementation.\n\nReturn the JSON limits of a given plugin\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_limits_api_4__plugin__limits_get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/views": {"get": {"summary": " Api Views", "description": "Glances API RESTful implementation.\n\nReturn the JSON views of a given plugin\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_views_api_4__plugin__views_get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/{item}": {"get": {"summary": " Api Item", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_item_api_4__plugin___item__get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "item", "in": "path", "required": true, "schema": {"type": "string", "title": "Item"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/{item}/views": {"get": {"summary": " Api Item Views", "description": "Glances API RESTful implementation.\n\nReturn the JSON view representation of the couple plugin/item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_item_views_api_4__plugin___item__views_get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "item", "in": "path", "required": true, "schema": {"type": "string", "title": "Item"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/{item}/history": {"get": {"summary": " Api Item History", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/history of item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_item_history_api_4__plugin___item__history_get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "item", "in": "path", "required": true, "schema": {"type": "string", "title": "Item"}}, {"name": "nb", "in": "query", "required": false, "schema": {"type": "integer", "default": 0, "title": "Nb"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/{item}/history/{nb}": {"get": {"summary": " Api Item History", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/history of item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_item_history_api_4__plugin___item__history__nb__get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "item", "in": "path", "required": true, "schema": {"type": "string", "title": "Item"}}, {"name": "nb", "in": "path", "required": true, "schema": {"type": "integer", "title": "Nb"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/{item}/description": {"get": {"summary": " Api Item Description", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/item description\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_item_description_api_4__plugin___item__description_get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "item", "in": "path", "required": true, "schema": {"type": "string", "title": "Item"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/{item}/unit": {"get": {"summary": " Api Item Unit", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/item unit\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_item_unit_api_4__plugin___item__unit_get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "item", "in": "path", "required": true, "schema": {"type": "string", "title": "Item"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/{item}/value/{value}": {"get": {"summary": " Api Value", "description": "Glances API RESTful implementation.\n\nReturn the process stats (dict) for the given item=value\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_value_api_4__plugin___item__value__value__get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "item", "in": "path", "required": true, "schema": {"type": "string", "title": "Item"}}, {"name": "value", "in": "path", "required": true, "schema": {"anyOf": [{"type": "string"}, {"type": "integer"}, {"type": "number"}], "title": "Value"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/{item}/{key}": {"get": {"summary": " Api Key", "description": "Glances API RESTful implementation.\n\nReturn the JSON representation of plugin/item/key\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_key_api_4__plugin___item___key__get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "item", "in": "path", "required": true, "schema": {"type": "string", "title": "Item"}}, {"name": "key", "in": "path", "required": true, "schema": {"type": "string", "title": "Key"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/4/{plugin}/{item}/{key}/views": {"get": {"summary": " Api Key Views", "description": "Glances API RESTful implementation.\n\nReturn the JSON view representation of plugin/item/key\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error", "operationId": "_api_key_views_api_4__plugin___item___key__views_get", "parameters": [{"name": "plugin", "in": "path", "required": true, "schema": {"type": "string", "title": "Plugin"}}, {"name": "item", "in": "path", "required": true, "schema": {"type": "string", "title": "Item"}}, {"name": "key", "in": "path", "required": true, "schema": {"type": "string", "title": "Key"}}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/": {"get": {"summary": " Index", "description": "Return main index.html (/) file.\n\nParameters are available through the request object.\nExample: http://localhost:61208/?refresh=5\n\nNote: This function is only called the first time the page is loaded.", "operationId": "_index__get", "responses": {"200": {"description": "Successful Response", "content": {"text/html": {"schema": {"type": "string"}}}}}}}}, "components": {"schemas": {"HTTPValidationError": {"properties": {"detail": {"items": {"$ref": "#/components/schemas/ValidationError"}, "type": "array", "title": "Detail"}}, "type": "object", "title": "HTTPValidationError"}, "ValidationError": {"properties": {"loc": {"items": {"anyOf": [{"type": "string"}, {"type": "integer"}]}, "type": "array", "title": "Location"}, "msg": {"type": "string", "title": "Message"}, "type": {"type": "string", "title": "Error Type"}}, "type": "object", "required": ["loc", "msg", "type"], "title": "ValidationError"}}}} \ No newline at end of file diff --git a/docs/api/python.rst b/docs/api/python.rst index 398e5bb9..90ba6a1d 100644 --- a/docs/api/python.rst +++ b/docs/api/python.rst @@ -22,25 +22,25 @@ use the following code: >>> gl = api.GlancesAPI() >>> gl.cpu {'cpucore': 16, - 'ctx_switches': 9270037, + 'ctx_switches': 392968698, 'guest': 0.0, - 'idle': 92.9, - 'interrupts': 6399251, - 'iowait': 0.2, + 'idle': 93.4, + 'interrupts': 347279201, + 'iowait': 0.5, 'irq': 0.0, 'nice': 0.0, - 'soft_interrupts': 2465459, + 'soft_interrupts': 146726416, 'steal': 0.0, 'syscalls': 0, - 'system': 4.5, - 'total': 6.6, - 'user': 2.3} + 'system': 4.4, + 'total': 5.9, + 'user': 1.7} >>> gl.cpu.get("total") - 6.6 + 5.9 >>> gl.mem.get("used") - 9278827984 + 12044965912 >>> gl.auto_unit(gl.mem.get("used")) - 8.64G + 11.2G If the stats return a list of items (like network interfaces or processes), you can access them by their name: @@ -51,19 +51,19 @@ access them by their name: ['wlp0s20f3'] >>> gl.network["wlp0s20f3"] {'alias': None, - 'bytes_all': 2046, - 'bytes_all_gauge': 1072158728, - 'bytes_all_rate_per_sec': 11750.0, - 'bytes_recv': 1424, - 'bytes_recv_gauge': 1055691424, - 'bytes_recv_rate_per_sec': 8178.0, - 'bytes_sent': 622, - 'bytes_sent_gauge': 16467304, - 'bytes_sent_rate_per_sec': 3572.0, + 'bytes_all': 1149, + 'bytes_all_gauge': 14756012143, + 'bytes_all_rate_per_sec': 7603.0, + 'bytes_recv': 608, + 'bytes_recv_gauge': 13741392863, + 'bytes_recv_rate_per_sec': 4023.0, + 'bytes_sent': 541, + 'bytes_sent_gauge': 1014619280, + 'bytes_sent_rate_per_sec': 3580.0, 'interface_name': 'wlp0s20f3', 'key': 'interface_name', 'speed': 0, - 'time_since_update': 0.1741182804107666} + 'time_since_update': 0.15111541748046875} Init Glances Python API ----------------------- @@ -95,7 +95,32 @@ Alert stats: >>> type(gl.alert) >>> gl.alert - [] + [{'avg': 96.85105977159478, + 'begin': 1767373692, + 'count': 2, + 'desc': '', + 'end': -1, + 'global_msg': 'High swap (paging) usage', + 'max': 96.85105977159478, + 'min': 96.85105977159478, + 'sort': 'memory_percent', + 'state': 'CRITICAL', + 'sum': 193.70211954318955, + 'top': ['code', 'firefox', 'code'], + 'type': 'MEMSWAP'}, + {'avg': 73.31673281888682, + 'begin': 1767373692, + 'count': 2, + 'desc': '', + 'end': -1, + 'global_msg': 'High swap (paging) usage', + 'max': 73.34283346687624, + 'min': 73.2906321708974, + 'sort': 'memory_percent', + 'state': 'WARNING', + 'sum': 146.63346563777364, + 'top': [], + 'type': 'MEM'}] Alert fields description: @@ -131,12 +156,12 @@ Ports stats: >>> gl.ports [{'description': 'DefaultGateway', - 'host': '192.168.1.1', + 'host': '192.168.0.254', 'indice': 'port_0', 'port': 0, 'refresh': 30, 'rtt_warning': None, - 'status': 0.005353, + 'status': 0.002841, 'timeout': 3}] Ports fields description: @@ -177,14 +202,14 @@ Diskio stats: >>> gl.diskio.get("nvme0n1") {'disk_name': 'nvme0n1', 'key': 'disk_name', - 'read_bytes': 6307091968, - 'read_count': 212136, + 'read_bytes': 26400656896, + 'read_count': 995162, 'read_latency': 0, - 'read_time': 25497, - 'write_bytes': 5472228352, - 'write_count': 237246, + 'read_time': 249396, + 'write_bytes': 39424275456, + 'write_count': 2633670, 'write_latency': 0, - 'write_time': 197091} + 'write_time': 2045785} Diskio fields description: @@ -269,11 +294,11 @@ Processcount stats: >>> type(gl.processcount) >>> gl.processcount - {'pid_max': 0, 'running': 1, 'sleeping': 406, 'thread': 1964, 'total': 559} + {'pid_max': 0, 'running': 1, 'sleeping': 444, 'thread': 2451, 'total': 593} >>> gl.processcount.keys() ['total', 'running', 'sleeping', 'thread', 'pid_max'] >>> gl.processcount.get("total") - 559 + 593 Processcount fields description: @@ -346,7 +371,7 @@ Percpu stats: 'dpc': None, 'guest': 0.0, 'guest_nice': 0.0, - 'idle': 28.0, + 'idle': 27.0, 'interrupt': None, 'iowait': 0.0, 'irq': 0.0, @@ -354,8 +379,8 @@ Percpu stats: 'nice': 0.0, 'softirq': 0.0, 'steal': 0.0, - 'system': 4.0, - 'total': 72.0, + 'system': 8.0, + 'total': 73.0, 'user': 0.0} Percpu fields description: @@ -404,10 +429,10 @@ System stats: >>> gl.system {'hostname': 'nicolargo-xps15', - 'hr_name': 'Ubuntu 24.04 64bit / Linux 6.14.0-35-generic', + 'hr_name': 'Ubuntu 24.04 64bit / Linux 6.14.0-37-generic', 'linux_distro': 'Ubuntu 24.04', 'os_name': 'Linux', - 'os_version': '6.14.0-35-generic', + 'os_version': '6.14.0-37-generic', 'platform': '64bit'} >>> gl.system.keys() ['os_name', 'hostname', 'platform', 'os_version', 'linux_distro', 'hr_name'] @@ -446,18 +471,18 @@ Network stats: >>> gl.network.get("wlp0s20f3") {'alias': None, 'bytes_all': 0, - 'bytes_all_gauge': 1072158728, + 'bytes_all_gauge': 14756012143, 'bytes_all_rate_per_sec': 0.0, 'bytes_recv': 0, - 'bytes_recv_gauge': 1055691424, + 'bytes_recv_gauge': 13741392863, 'bytes_recv_rate_per_sec': 0.0, 'bytes_sent': 0, - 'bytes_sent_gauge': 16467304, + 'bytes_sent_gauge': 1014619280, 'bytes_sent_rate_per_sec': 0.0, 'interface_name': 'wlp0s20f3', 'key': 'interface_name', 'speed': 0, - 'time_since_update': 0.0031774044036865234} + 'time_since_update': 0.0019180774688720703} Network fields description: @@ -498,23 +523,23 @@ Cpu stats: >>> gl.cpu {'cpucore': 16, - 'ctx_switches': 9270037, + 'ctx_switches': 392968698, 'guest': 0.0, - 'idle': 92.9, - 'interrupts': 6399251, - 'iowait': 0.2, + 'idle': 93.4, + 'interrupts': 347279201, + 'iowait': 0.5, 'irq': 0.0, 'nice': 0.0, - 'soft_interrupts': 2465459, + 'soft_interrupts': 146726416, 'steal': 0.0, 'syscalls': 0, - 'system': 4.5, - 'total': 6.6, - 'user': 2.3} + 'system': 4.4, + 'total': 5.9, + 'user': 1.7} >>> gl.cpu.keys() ['total', 'user', 'nice', 'system', 'idle', 'iowait', 'irq', 'steal', 'guest', 'ctx_switches', 'interrupts', 'soft_interrupts', 'syscalls', 'cpucore'] >>> gl.cpu.get("total") - 6.6 + 5.9 Cpu fields description: @@ -586,7 +611,7 @@ Amps stats: 'refresh': 3.0, 'regex': True, 'result': None, - 'timer': 0.1661975383758545} + 'timer': 0.18659353256225586} Amps fields description: @@ -617,38 +642,33 @@ Processlist stats: >>> gl.processlist Return a dict of dict with key= >>> gl.processlist.keys() - [30532, 129, 7722, 6446, 8756, 8852, 6423, 8840, 9543, 7548, 10383, 5247, 10239, 6971, 7838, 7562, 7550, 10672, 7715, 8639, 6711, 10143, 29150, 8081, 8853, 9153, 8794, 3018, 6207, 9171, 9629, 3613, 9374, 8333, 6244, 6219, 8711, 30172, 28756, 29409, 5453, 29262, 5991, 5363, 9409, 9408, 7371, 9406, 9407, 9402, 5677, 8641, 8642, 3031, 2669, 29063, 5812, 6722, 5815, 30529, 6689, 5605, 6684, 8156, 6124, 5724, 5575, 5375, 5826, 5878, 6763, 3025, 6242, 5409, 5412, 5355, 4271, 3609, 5386, 5437, 2776, 5394, 5189, 749, 4946, 2700, 5087, 2641, 1, 2704, 2703, 5627, 5803, 3087, 4924, 4943, 4948, 3495, 2509, 2649, 5388, 5381, 3621, 5429, 3004, 5418, 2858, 5479, 6050, 3596, 2797, 4904, 4950, 5435, 2974, 3685, 5634, 3496, 5783, 2688, 5432, 5462, 808, 5389, 5678, 2684, 2510, 2864, 2690, 2645, 5175, 2508, 5009, 5661, 5574, 5738, 5336, 5230, 2636, 5653, 5584, 5643, 5186, 5383, 5157, 8342, 2685, 4961, 5427, 5690, 2655, 5013, 5073, 2635, 5428, 5367, 8469, 4944, 2746, 9198, 9154, 5161, 2710, 5243, 2634, 2507, 4931, 2640, 3778, 6250, 8656, 6540, 30525, 2979, 2981, 3626, 3634, 3234, 3650, 5020, 3633, 3629, 3501, 30528, 2980, 2769, 3016, 3017, 3235, 3500, 2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 35, 36, 37, 38, 39, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 83, 84, 85, 86, 87, 89, 90, 91, 92, 93, 95, 96, 97, 98, 99, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 157, 164, 165, 166, 168, 169, 171, 176, 186, 188, 203, 212, 216, 218, 264, 270, 271, 272, 273, 274, 275, 276, 277, 278, 352, 355, 357, 358, 359, 360, 361, 362, 363, 364, 367, 369, 370, 447, 448, 450, 611, 616, 617, 618, 624, 651, 652, 653, 654, 657, 658, 659, 660, 661, 662, 683, 684, 738, 780, 781, 817, 1000, 1001, 1013, 1014, 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1255, 1303, 1366, 1369, 1370, 1371, 1387, 1388, 1389, 1390, 1439, 1440, 1443, 1444, 1525, 1529, 1896, 1897, 1898, 1899, 1900, 1901, 1902, 1903, 1904, 1905, 1906, 1907, 1908, 1909, 1938, 1939, 1941, 1942, 1943, 1944, 1945, 1946, 1947, 1978, 1979, 1980, 1981, 1982, 1983, 1984, 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 2026, 2027, 2028, 2029, 2030, 2031, 2032, 2044, 2045, 2050, 2051, 2052, 2053, 2054, 2055, 2056, 2057, 2058, 2059, 2061, 2063, 2064, 2066, 2068, 2071, 2072, 2075, 2322, 2323, 2326, 3558, 3559, 3560, 3561, 3562, 3660, 3706, 3707, 3708, 3709, 3710, 3711, 3712, 3713, 3949, 3956, 4080, 4725, 4859, 4877, 7686, 13970, 14398, 14514, 15908, 16227, 16410, 16721, 28674, 28676, 28726, 29096, 30133] - >>> gl.processlist.get("30532") - {'cmdline': ['/home/nicolargo/dev/glances/.venv/bin/python3', - '-m', - 'glances', - '-C', - 'conf/glances.conf', - '--api-doc'], - 'cpu_percent': 75.1, - 'cpu_times': {'children_system': 0.03, - 'children_user': 0.01, + [1, 2, 3, 4, 5, 6, 7, 8, 10, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 35, 36, 37, 38, 39, 41, 42, 43, 44, 45, 47, 48, 49, 50, 51, 53, 54, 55, 56, 57, 59, 60, 61, 62, 63, 65, 66, 67, 68, 69, 71, 72, 73, 74, 75, 77, 78, 79, 80, 81, 83, 84, 85, 86, 87, 89, 90, 91, 92, 93, 95, 96, 97, 98, 99, 101, 102, 103, 104, 105, 107, 108, 109, 110, 111, 113, 114, 115, 116, 117, 118, 121, 122, 123, 124, 125, 126, 127, 128, 133, 135, 136, 137, 138, 139, 140, 142, 143, 144, 145, 146, 147, 148, 150, 154, 156, 157, 158, 166, 179, 188, 189, 218, 219, 239, 240, 258, 267, 268, 269, 270, 271, 273, 279, 280, 364, 367, 369, 370, 371, 372, 373, 450, 452, 613, 618, 619, 620, 627, 659, 660, 726, 757, 758, 787, 795, 970, 971, 986, 1037, 1040, 1042, 1043, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1056, 1058, 1059, 1064, 1065, 1218, 1219, 1223, 1275, 1277, 1278, 1279, 1320, 1327, 1534, 1537, 1965, 1966, 1967, 1968, 1969, 1970, 1971, 1972, 1973, 1974, 1975, 1976, 1977, 1978, 2007, 2008, 2009, 2010, 2011, 2013, 2014, 2016, 2017, 2018, 2019, 2020, 2021, 2023, 2052, 2053, 2054, 2055, 2056, 2057, 2058, 2059, 2060, 2061, 2062, 2063, 2064, 2065, 2066, 2067, 2068, 2069, 2070, 2071, 2072, 2073, 2074, 2075, 2078, 2079, 2080, 2081, 2082, 2083, 2084, 2085, 2086, 2087, 2088, 2089, 2090, 2091, 2092, 2093, 2094, 2095, 2096, 2097, 2098, 2099, 2100, 2101, 2102, 2103, 2104, 2105, 2117, 2122, 2123, 2124, 2125, 2126, 2127, 2128, 2129, 2130, 2133, 2134, 2135, 2136, 2137, 2138, 2139, 2140, 2141, 2142, 2143, 2144, 2145, 2149, 2603, 2604, 2605, 2606, 2613, 2615, 2744, 2745, 2746, 2750, 2751, 2755, 2762, 2774, 2781, 2788, 2791, 2796, 2799, 2802, 2813, 2820, 2823, 2887, 2904, 2905, 2916, 3031, 3038, 3081, 3181, 3182, 3186, 3191, 3192, 3240, 3382, 3383, 3670, 3671, 3695, 3698, 3807, 3817, 3818, 3822, 3827, 3828, 3846, 3853, 3874, 3901, 3902, 3903, 3904, 3905, 3906, 3907, 3908, 3982, 4194, 4596, 5146, 5166, 5172, 5179, 5189, 5190, 5193, 5195, 5197, 5207, 5263, 5267, 5274, 5318, 5333, 5421, 5425, 5441, 5453, 5457, 5492, 5505, 5509, 5593, 5612, 5620, 5621, 5634, 5657, 5658, 5661, 5664, 5665, 5667, 5669, 5672, 5675, 5678, 5680, 5685, 5687, 5693, 5695, 5700, 5708, 5726, 5734, 5829, 5832, 5833, 5844, 5861, 5871, 5914, 5921, 5931, 5941, 5954, 5957, 6017, 6063, 6087, 6093, 6094, 6123, 6154, 6206, 6244, 6475, 6505, 6552, 6559, 6562, 7227, 8412, 8526, 9631, 9649, 9661, 9731, 9734, 11010, 12121, 12123, 12124, 12138, 12192, 12239, 12278, 12321, 12335, 12336, 12417, 12686, 12726, 12735, 12929, 12931, 12932, 12933, 12934, 13048, 13115, 13536, 13665, 36430, 40117, 53755, 53764, 62488, 62637, 72064, 72065, 72120, 72139, 102070, 340569, 358046, 388396, 413445, 444052, 444061, 471623, 471714, 471892, 471899, 471919, 471929, 471954, 472557, 472566, 472570, 472785, 472854, 472861, 473314, 481055, 498113, 513901, 514243, 514681, 515455, 518033, 520070, 524431, 524432, 524447, 524457, 524551, 530020, 531982, 531983, 532003, 532019, 532126, 532187, 532625, 542169, 542928, 545701, 546233, 546254, 547205, 547220, 547714, 547732, 548091, 548102, 548622, 550414, 555282, 557645, 557646, 557648, 561234, 564559, 567573, 572276, 572387, 572901, 574078, 581119, 581221, 581222, 582989, 583097, 583966, 585509, 585867, 586640, 586660, 586676, 586686, 588116, 588144, 588161, 588690, 589569, 589794, 591548, 591550, 591551, 591712, 591853, 592272, 593020, 593126, 594465, 595041, 595152, 596658, 596663, 596890, 597033, 598027, 598303, 598538, 598539, 598540, 598541, 598598, 598756, 599183, 599214, 599225, 600160, 600310, 601882, 601885, 601886, 601889] + >>> gl.processlist.get("1") + {'cmdline': ['/sbin/init', 'splash'], + 'cpu_percent': 0.0, + 'cpu_times': {'children_system': 287.89, + 'children_user': 5146.36, 'iowait': 0.0, - 'system': 0.4, - 'user': 0.4}, - 'gids': {'effective': 1000, 'real': 1000, 'saved': 1000}, - 'io_counters': [20688896, 86016, 8990720, 86016, 1], + 'system': 7.96, + 'user': 11.06}, + 'gids': {'effective': 0, 'real': 0, 'saved': 0}, + 'io_counters': [0, 0, 0, 0, 0, 0, 0, 0, 0, 0], 'key': 'pid', - 'memory_info': {'data': 100184064, + 'memory_info': {'data': 7282688, 'dirty': 0, 'lib': 0, - 'rss': 81117184, - 'shared': 18477056, - 'text': 31211520, - 'vms': 415424512}, - 'memory_percent': 0.49392852502078194, - 'name': 'python3', + 'rss': 14622720, + 'shared': 8175616, + 'text': 45056, + 'vms': 26632192}, + 'memory_percent': 0.0890389998301525, + 'name': 'systemd', 'nice': 0, - 'num_threads': 3, - 'pid': 30532, - 'status': 'R', - 'time_since_update': 0.45221495628356934, - 'username': 'nicolargo'} + 'num_threads': 1, + 'pid': 1, + 'status': 'S', + 'time_since_update': 0.39455604553222656, + 'username': 'root'} Processlist fields description: @@ -732,13 +752,13 @@ Load stats: >>> gl.load {'cpucore': 16, - 'min1': 1.77197265625, - 'min15': 0.69287109375, - 'min5': 1.29052734375} + 'min1': 0.52685546875, + 'min15': 0.517578125, + 'min5': 0.5439453125} >>> gl.load.keys() ['min1', 'min5', 'min15', 'cpucore'] >>> gl.load.get("min1") - 1.77197265625 + 0.52685546875 Load fields description: @@ -770,14 +790,14 @@ Sensors stats: >>> gl.sensors Return a dict of dict with key=