{"id":13523419,"url":"https://nicolargo.github.io/glances/","last_synced_at":"2025-04-01T00:31:42.083Z","repository":{"id":1977849,"uuid":"2909429","full_name":"nicolargo/glances","owner":"nicolargo","description":"Glances an Eye on your system. A top/htop alternative for GNU/Linux, BSD, Mac OS and Windows operating systems.","archived":false,"fork":false,"pushed_at":"2024-10-28T11:09:00.000Z","size":42769,"stargazers_count":26702,"open_issues_count":177,"forks_count":1529,"subscribers_count":502,"default_branch":"develop","last_synced_at":"2024-10-28T16:29:20.353Z","etag":null,"topics":["monitoring","multi-platform","python","restful","restful-api","system","terminal","web"],"latest_commit_sha":null,"homepage":"http://nicolargo.github.io/glances/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"pingcap/tidb","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nicolargo.png","metadata":{"files":{"readme":"README.rst","changelog":"NEWS.rst","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"COPYING","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":"docs/support.rst","governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"nicolargo"}},"created_at":"2011-12-04T08:49:15.000Z","updated_at":"2024-10-28T15:29:13.000Z","dependencies_parsed_at":"2023-11-18T03:29:37.852Z","dependency_job_id":"ddb96096-87d0-4859-8001-bb0d5a3e06e4","html_url":"https://github.com/nicolargo/glances","commit_stats":{"total_commits":4128,"total_committers":183,"mean_commits":"22.557377049180328","dds":0.3655523255813954,"last_synced_commit":"a88f41f25ea53a4a5a722d341727705cd52c2a59"},"previous_names":[],"tags_count":121,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicolargo%2Fglances","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicolargo%2Fglances/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicolargo%2Fglances/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicolargo%2Fglances/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nicolargo","download_url":"https://codeload.github.com/nicolargo/glances/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222688173,"owners_count":17023297,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["monitoring","multi-platform","python","restful","restful-api","system","terminal","web"],"created_at":"2024-08-01T06:00:59.927Z","updated_at":"2025-04-01T00:31:42.069Z","avatar_url":"https://github.com/nicolargo.png","language":"Python","funding_links":["https://github.com/sponsors/nicolargo"],"categories":["Utilities","Monitoring","Container Operations","Uncategorized","开源工具","Software","Applications","\u003ca name=\"monitor\"\u003e\u003c/a\u003eSystem monitoring","System Monitoring"],"sub_categories":["System Interaction Utilities","TOPs","Monitoring","Uncategorized","命令行工具","Console-based Applications and Tools","Console-based Applications","Monitoring \u0026 Status Pages"],"readme":"===============================\nGlances - An eye on your system\n===============================\n\n|  |pypi| |test| |contributors| |quality|\n|  |starts| |docker| |pypistat| |ossrank|\n|  |sponsors| |twitter|\n\n.. |pypi| image:: https://img.shields.io/pypi/v/glances.svg\n    :target: https://pypi.python.org/pypi/Glances\n\n.. |starts| image:: https://img.shields.io/github/stars/nicolargo/glances.svg\n    :target: https://github.com/nicolargo/glances/\n    :alt: Github stars\n\n.. |docker| image:: https://img.shields.io/docker/pulls/nicolargo/glances\n    :target: https://hub.docker.com/r/nicolargo/glances/\n    :alt: Docker pull\n\n.. |pypistat| image:: https://pepy.tech/badge/glances/month\n    :target: https://pepy.tech/project/glances\n    :alt: Pypi downloads\n\n.. |ossrank| image:: https://shields.io/endpoint?url=https://ossrank.com/shield/3689\n    :target: https://ossrank.com/p/3689\n    :alt: OSSRank\n\n.. |test| image:: https://github.com/nicolargo/glances/actions/workflows/ci.yml/badge.svg?branch=develop\n    :target: https://github.com/nicolargo/glances/actions\n    :alt: Linux tests (GitHub Actions)\n\n.. |contributors| image:: https://img.shields.io/github/contributors/nicolargo/glances\n    :target: https://github.com/nicolargo/glances/issues?q=is%3Aissue+is%3Aopen+label%3A%22needs+contributor%22\n    :alt: Contributors\n\n.. |quality| image:: https://scrutinizer-ci.com/g/nicolargo/glances/badges/quality-score.png?b=develop\n    :target: https://scrutinizer-ci.com/g/nicolargo/glances/?branch=develop\n    :alt: Code quality\n\n.. |sponsors| image:: https://img.shields.io/github/sponsors/nicolargo\n    :target: https://github.com/sponsors/nicolargo\n    :alt: Sponsors\n\n.. |twitter| image:: https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social\u0026label=Follow%20%40nicolargo\n    :target: https://twitter.com/nicolargo\n    :alt: @nicolargo\n\nSummary\n=======\n\n**Glances** is an open-source system cross-platform monitoring tool.\nIt allows real-time monitoring of various aspects of your system such as\nCPU, memory, disk, network usage etc. It also allows monitoring of running processes,\nlogged in users, temperatures, voltages, fan speeds etc.\nIt also supports container monitoring, it supports different container management\nsystems such as Docker, LXC. The information is presented in an easy to read dashboard\nand can also be used for remote monitoring of systems via a web interface or command\nline interface. It is easy to install and use and can be customized to show only\nthe information that you are interested in.\n\n.. image:: https://raw.githubusercontent.com/nicolargo/glances/develop/docs/_static/glances-summary.png\n\nIn client/server mode, remote monitoring could be done via terminal,\nWeb interface or API (XML-RPC and RESTful).\nStats can also be exported to files or external time/value databases, CSV or direct\noutput to STDOUT.\n\n.. image:: https://raw.githubusercontent.com/nicolargo/glances/develop/docs/_static/glances-responsive-webdesign.png\n\nGlances is written in Python and uses libraries to grab information from\nyour system. It is based on an open architecture where developers can\nadd new plugins or exports modules.\n\nProject sponsorship\n===================\n\nYou can help me to achieve my goals of improving this open-source project\nor just say \"thank you\" by:\n\n- sponsor me using one-time or monthly tier Github sponsors_ page\n- send me some pieces of bitcoin: 185KN9FCix3svJYp7JQM7hRMfSKyeaJR4X\n- buy me a gift on my wishlist_ page\n\nAny and all contributions are greatly appreciated.\n\nRequirements\n============\n\nGlances is developed in Python. A minimal Python version 3.9 or higher\nshould be installed on your system.\n\n*Note for Python 2 users*\n\nGlances version 4 or higher do not support Python 2 (and Python 3 \u003c 3.9).\nPlease uses Glances version 3.4.x if you need Python 2 support.\n\nDependencies:\n\n- ``psutil`` (better with latest version)\n- ``defusedxml`` (in order to monkey patch xmlrpc)\n- ``packaging`` (for the version comparison)\n- ``windows-curses`` (Windows Curses implementation) [Windows-only]\n\nOptional dependencies:\n\n- ``batinfo`` (for battery monitoring)\n- ``bernhard`` (for the Riemann export module)\n- ``cassandra-driver`` (for the Cassandra export module)\n- ``chevron`` (for the action script feature)\n- ``docker`` (for the Containers Docker monitoring support)\n- ``elasticsearch`` (for the Elastic Search export module)\n- ``FastAPI`` and ``Uvicorn`` (for Web server mode)\n- ``graphitesender`` (For the Graphite export module)\n- ``hddtemp`` (for HDD temperature monitoring support) [Linux-only]\n- ``influxdb`` (for the InfluxDB version 1 export module)\n- ``influxdb-client``  (for the InfluxDB version 2 export module)\n- ``jinja2`` (for templating, used under the hood by FastAPI)\n- ``kafka-python`` (for the Kafka export module)\n- ``netifaces2`` (for the IP plugin)\n- ``nvidia-ml-py`` (for the GPU plugin)\n- ``pycouchdb`` (for the CouchDB export module)\n- ``pika`` (for the RabbitMQ/ActiveMQ export module)\n- ``podman`` (for the Containers Podman monitoring support)\n- ``potsdb`` (for the OpenTSDB export module)\n- ``prometheus_client`` (for the Prometheus export module)\n- ``pygal`` (for the graph export module)\n- ``pymdstat`` (for RAID support) [Linux-only]\n- ``pymongo`` (for the MongoDB export module)\n- ``pysnmp-lextudio`` (for SNMP support)\n- ``pySMART.smartx`` (for HDD Smart support) [Linux-only]\n- ``pyzmq`` (for the ZeroMQ export module)\n- ``requests`` (for the Ports, Cloud plugins and RESTful export module)\n- ``sparklines`` (for the Quick Plugin sparklines option)\n- ``statsd`` (for the StatsD export module)\n- ``wifi`` (for the wifi plugin) [Linux-only]\n- ``zeroconf`` (for the autodiscover mode)\n\nInstallation\n============\n\nThere are several methods to test/install Glances on your system. Choose your weapon!\n\nPyPI: Pip, the standard way\n---------------------------\n\nGlances is on ``PyPI``. By using PyPI, you will be using the latest\nstable version.\n\nTo install Glances, simply use the ``pip`` command line.\n\nWarning: on modern Linux operating systems, you may have an externally-managed-environment\nerror message when you try to use ``pip``. In this case, go to the the PipX section below.\n\n.. code-block:: console\n\n    pip install --user glances\n\n*Note*: Python headers are required to install `psutil`_, a Glances\ndependency. For example, on Debian/Ubuntu **the simplest** is\n``apt install python3-psutil`` or alternatively need to install first\nthe *python-dev* package and gcc (*python-devel* on Fedora/CentOS/RHEL).\nFor Windows, just install psutil from the binary installation file.\n\nBy default, Glances is installed **without** the Web interface dependencies.\nTo install it, use the following command:\n\n.. code-block:: console\n\n    pip install --user 'glances[web]'\n\nFor a full installation (with all features, see features list bellow):\n\n.. code-block:: console\n\n    pip install --user 'glances[all]'\n\nFeatures list:\n\n- all: install dependencies for all features\n- action: install dependencies for action feature\n- browser: install dependencies for Glances centram browser\n- cloud: install dependencies for cloud plugin\n- containers: install dependencies for container plugin\n- export: install dependencies for all exports modules\n- gpu: install dependencies for GPU plugin\n- graph: install dependencies for graph export\n- ip: install dependencies for IP public option\n- raid: install dependencies for RAID plugin\n- sensors: install dependencies for sensors plugin\n- smart: install dependencies for smart plugin\n- snmp: install dependencies for SNMP\n- sparklines: install dependencies for sparklines option\n- web: install dependencies for Webserver (WebUI) and Web API\n- wifi: install dependencies for Wifi plugin\n\nTo upgrade Glances to the latest version:\n\n.. code-block:: console\n\n    pip install --user --upgrade glances\n\nThe current develop branch is published to the test.pypi.org package index.\nIf you want to test the develop version (could be instable), enter:\n\n.. code-block:: console\n\n    pip install --user -i https://test.pypi.org/simple/ Glances\n\nPyPI: PipX, the alternative way\n-------------------------------\n\nInstall PipX on your system (apt install pipx on Ubuntu).\n\nInstall Glances (with all features):\n\n.. code-block:: console\n\n    pipx install 'glances[all]'\n\nThe glances script will be installed in the ~/.local/bin folder.\n\nDocker: the cloudy way\n----------------------\n\nGlances Docker images are available. You can use it to monitor your\nserver and all your containers !\n\nGet the Glances container:\n\n.. code-block:: console\n\n    docker pull nicolargo/glances:latest-full\n\nThe following tags are available:\n\n- *latest-full* for a full Alpine Glances image (latest release) with all dependencies\n- *latest* for a basic Alpine Glances (latest release) version with minimal dependencies (FastAPI and Docker)\n- *dev* for a basic Alpine Glances image (based on development branch) with all dependencies (Warning: may be instable)\n- *ubuntu-latest-full* for a full Ubuntu Glances image (latest release) with all dependencies\n- *ubuntu-latest* for a basic Ubuntu Glances (latest release) version with minimal dependencies (FastAPI and Docker)\n- *ubuntu-dev* for a basic Ubuntu Glances image (based on development branch) with all dependencies (Warning: may be instable)\n\nRun last version of Glances container in *console mode*:\n\n.. code-block:: console\n\n    docker run --rm -e TZ=\"${TZ}\" -v /var/run/docker.sock:/var/run/docker.sock:ro -v /run/user/1000/podman/podman.sock:/run/user/1000/podman/podman.sock:ro --pid host --network host -it nicolargo/glances:latest-full\n\nBy default, the /etc/glances/glances.conf file is used (based on docker-compose/glances.conf).\n\nAdditionally, if you want to use your own glances.conf file, you can\ncreate your own Dockerfile:\n\n.. code-block:: console\n\n    FROM nicolargo/glances:latest\n    COPY glances.conf /root/.config/glances/glances.conf\n    CMD python -m glances -C /root/.config/glances/glances.conf $GLANCES_OPT\n\nAlternatively, you can specify something along the same lines with\ndocker run options (notice the `GLANCES_OPT` environment\nvariable setting parameters for the glances startup command):\n\n.. code-block:: console\n\n    docker run -e TZ=\"${TZ}\" -v $HOME/.config/glances/glances.conf:/glances.conf:ro -v /var/run/docker.sock:/var/run/docker.sock:ro -v /run/user/1000/podman/podman.sock:/run/user/1000/podman/podman.sock:ro --pid host -e GLANCES_OPT=\"-C /glances.conf\" -it nicolargo/glances:latest-full\n\nWhere $HOME/.config/glances/glances.conf is a local directory containing your glances.conf file.\n\nRun the container in *Web server mode*:\n\n.. code-block:: console\n\n    docker run -d --restart=\"always\" -p 61208-61209:61208-61209 -e TZ=\"${TZ}\" -e GLANCES_OPT=\"-w\" -v /var/run/docker.sock:/var/run/docker.sock:ro -v /run/user/1000/podman/podman.sock:/run/user/1000/podman/podman.sock:ro --pid host nicolargo/glances:latest-full\n\nFor a full list of options, see the Glances `Docker`_ documentation page.\n\nGNU/Linux package\n-----------------\n\n`Glances` is available on many Linux distributions, so you should be\nable to install it using your favorite package manager. Be aware that\nwhen you use this method the operating system `package`_ for `Glances`\nmay not be the latest version and only basics plugins are enabled.\n\nNote: The Debian package (and all other Debian-based distributions) do\nnot include anymore the JS statics files used by the Web interface\n(see ``issue2021``). If you want to add it to your Glances installation,\nfollow the instructions: ``issue2021comment``. In Glances version 4 and\nhigher, the path to the statics file is configurable (see ``issue2612``).\n\nFreeBSD\n-------\n\nTo install the binary package:\n\n.. code-block:: console\n\n    # pkg install py39-glances\n\nTo install Glances from ports:\n\n.. code-block:: console\n\n    # cd /usr/ports/sysutils/py-glances/\n    # make install clean\n\nmacOS\n-----\n\nIf you do not want to use the glancesautoinstall script, follow this procedure.\n\nmacOS users can install Glances using ``Homebrew`` or ``MacPorts``.\n\nHomebrew\n````````\n\n.. code-block:: console\n\n    $ brew install glances\n\nMacPorts\n````````\n\n.. code-block:: console\n\n    $ sudo port install glances\n\nWindows\n-------\n\nInstall `Python`_ for Windows (Python 3.4+ ship with pip) and\nthen run the following command:\n\n.. code-block:: console\n\n    $ pip install glances\n\nAndroid\n-------\n\nYou need a rooted device and the `Termux`_ application (available on the\nGoogle Play Store).\n\nStart Termux on your device and enter:\n\n.. code-block:: console\n\n    $ apt update\n    $ apt upgrade\n    $ apt install clang python\n    $ pip install fastapi uvicorn jinja2\n    $ pip install glances\n\nAnd start Glances:\n\n.. code-block:: console\n\n    $ glances\n\nYou can also run Glances in server mode (-s or -w) in order to remotely\nmonitor your Android device.\n\nSource\n------\n\nTo install Glances from source:\n\n.. code-block:: console\n\n    $ pip install https://github.com/nicolargo/glances/archive/vX.Y.tar.gz\n\n*Note*: Python headers are required to install psutil.\n\nChef\n----\n\nAn awesome ``Chef`` cookbook is available to monitor your infrastructure:\nhttps://supermarket.chef.io/cookbooks/glances (thanks to Antoine Rouyer)\n\nPuppet\n------\n\nYou can install Glances using ``Puppet``: https://github.com/rverchere/puppet-glances\n\nAnsible\n-------\n\nA Glances ``Ansible`` role is available: https://galaxy.ansible.com/zaxos/glances-ansible-role/\n\nUsage\n=====\n\nFor the standalone mode, just run:\n\n.. code-block:: console\n\n    $ glances\n\nFor the Web server mode, run:\n\n.. code-block:: console\n\n    $ glances -w\n\nand enter the URL ``http://\u003cip\u003e:61208`` in your favorite web browser.\n\nFor the client/server mode, run:\n\n.. code-block:: console\n\n    $ glances -s\n\non the server side and run:\n\n.. code-block:: console\n\n    $ glances -c \u003cip\u003e\n\non the client one.\n\nYou can also detect and display all Glances servers available on your\nnetwork or defined in the configuration file:\n\n.. code-block:: console\n\n    $ glances --browser\n\nYou can also display raw stats on stdout:\n\n.. code-block:: console\n\n    $ glances --stdout cpu.user,mem.used,load\n    cpu.user: 30.7\n    mem.used: 3278204928\n    load: {'cpucore': 4, 'min1': 0.21, 'min5': 0.4, 'min15': 0.27}\n    cpu.user: 3.4\n    mem.used: 3275251712\n    load: {'cpucore': 4, 'min1': 0.19, 'min5': 0.39, 'min15': 0.27}\n    ...\n\nor in a CSV format thanks to the stdout-csv option:\n\n.. code-block:: console\n\n    $ glances --stdout-csv now,cpu.user,mem.used,load\n    now,cpu.user,mem.used,load.cpucore,load.min1,load.min5,load.min15\n    2018-12-08 22:04:20 CEST,7.3,5948149760,4,1.04,0.99,1.04\n    2018-12-08 22:04:23 CEST,5.4,5949136896,4,1.04,0.99,1.04\n    ...\n\nor in a JSON format thanks to the stdout-json option (attribute not supported in this mode in order to have a real JSON object in output):\n\n.. code-block:: console\n\n    $ glances --stdout-json cpu,mem\n    cpu: {\"total\": 29.0, \"user\": 24.7, \"nice\": 0.0, \"system\": 3.8, \"idle\": 71.4, \"iowait\": 0.0, \"irq\": 0.0, \"softirq\": 0.0, \"steal\": 0.0, \"guest\": 0.0, \"guest_nice\": 0.0, \"time_since_update\": 1, \"cpucore\": 4, \"ctx_switches\": 0, \"interrupts\": 0, \"soft_interrupts\": 0, \"syscalls\": 0}\n    mem: {\"total\": 7837949952, \"available\": 2919079936, \"percent\": 62.8, \"used\": 4918870016, \"free\": 2919079936, \"active\": 2841214976, \"inactive\": 3340550144, \"buffers\": 546799616, \"cached\": 3068141568, \"shared\": 788156416}\n    ...\n\nand RTFM, always.\n\nDocumentation\n=============\n\nFor complete documentation have a look at the readthedocs_ website.\n\nIf you have any question (after RTFM!), please post it on the official Q\u0026A `forum`_.\n\nGateway to other services\n=========================\n\nGlances can export stats to: ``CSV`` file, ``JSON`` file, ``InfluxDB``, ``Cassandra``, ``CouchDB``,\n``OpenTSDB``, ``Prometheus``, ``StatsD``, ``ElasticSearch``, ``RabbitMQ/ActiveMQ``,\n``ZeroMQ``, ``Kafka``, ``Riemann``, ``Graphite`` and ``RESTful`` server.\n\nHow to contribute ?\n===================\n\nIf you want to contribute to the Glances project, read this `wiki`_ page.\n\nThere is also a chat dedicated to the Glances developers:\n\n.. image:: https://badges.gitter.im/Join%20Chat.svg\n        :target: https://gitter.im/nicolargo/glances?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge\n\nAuthor\n======\n\nNicolas Hennion (@nicolargo) \u003cnicolas@nicolargo.com\u003e\n\n.. image:: https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social\u0026label=Follow%20%40nicolargo\n    :target: https://twitter.com/nicolargo\n\nLicense\n=======\n\nGlances is distributed under the LGPL version 3 license. See ``COPYING`` for more details.\n\n.. _psutil: https://github.com/giampaolo/psutil\n.. _glancesautoinstall: https://github.com/nicolargo/glancesautoinstall\n.. _Python: https://www.python.org/getit/\n.. _Termux: https://play.google.com/store/apps/details?id=com.termux\n.. _readthedocs: https://glances.readthedocs.io/\n.. _forum: https://groups.google.com/forum/?hl=en#!forum/glances-users\n.. _wiki: https://github.com/nicolargo/glances/wiki/How-to-contribute-to-Glances-%3F\n.. _package: https://repology.org/project/glances/versions\n.. _sponsors: https://github.com/sponsors/nicolargo\n.. _wishlist: https://www.amazon.fr/hz/wishlist/ls/BWAAQKWFR3FI?ref_=wl_share\n.. _issue2021: https://github.com/nicolargo/glances/issues/2021\n.. _issue2021comment: https://github.com/nicolargo/glances/issues/2021#issuecomment-1197831157\n.. _issue2612: https://github.com/nicolargo/glances/issues/2612\n.. _Docker: https://github.com/nicolargo/glances/blob/develop/docs/docker.rst\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/nicolargo.github.io%2Fglances%2F","html_url":"https://awesome.ecosyste.ms/projects/nicolargo.github.io%2Fglances%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/nicolargo.github.io%2Fglances%2F/lists"}