{"id":25000552,"url":"https://github.com/gluster/gstatus","last_synced_at":"2025-08-31T11:48:04.921Z","repository":{"id":31448110,"uuid":"35011898","full_name":"gluster/gstatus","owner":"gluster","description":"gstatus is a command to view current health of a glusterfs cluster","archived":false,"fork":false,"pushed_at":"2024-02-15T13:18:11.000Z","size":1016,"stargazers_count":57,"open_issues_count":9,"forks_count":32,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-04-12T08:52:20.292Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gluster.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-05-04T03:24:05.000Z","updated_at":"2025-03-08T08:32:13.000Z","dependencies_parsed_at":"2025-02-04T19:35:51.862Z","dependency_job_id":"801eeeda-175d-4c7a-8039-3a7aa42e58e0","html_url":"https://github.com/gluster/gstatus","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/gluster/gstatus","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluster%2Fgstatus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluster%2Fgstatus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluster%2Fgstatus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluster%2Fgstatus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gluster","download_url":"https://codeload.github.com/gluster/gstatus/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gluster%2Fgstatus/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272976883,"owners_count":25025041,"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","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-02-04T19:35:44.274Z","updated_at":"2025-08-31T11:48:04.876Z","avatar_url":"https://github.com/gluster.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"gstatus\n=======\n\nOverview\n========\ngstatus is a commandline utility to report the health and other statistics\nrelated to a GlusterFS cluster. gstatus consolidates the volume, brick, and peer\ninformation of a GlusterFS cluster.\n\nAt volume level, gstatus reports detailed infromation on quota usage, snapshots,\nself-heal and rebalance status.\n\nMotivation\n==========\nA gluster trusted storage pool (aka cluster), consists of several key\ncomponents viz. nodes, volumes, and bricks. In glusterfs, there isn't a single\ncommand that can provide an overview of the cluster's health. This means that\nadministrators currently assess the cluster health by looking at several\ncommands to piece together a picture of the cluster's state.\n\nThis isn't ideal - so 'gstatus' is an attempt to provide an easy to use,\nreliable, highlevel view of a cluster's health through a single command. The\ntool gathers information by calling the glustercli library\n(https://github.com/gluster/glustercli-python) and displays on the screen.\n\nDependencies\n============\n- python 3.0 or above\n- gluster version 3.12 or above\n- gluster CLI\n\nInstall\n=======\nDownload the latest release with the command\n\n```\n$ curl -fsSL https://github.com/gluster/gstatus/releases/latest/download/install.sh | sudo bash -x\n$ gstatus --version\n```\n\nInstallating from source\n========================\n* Installing glustercli-python\n\n```\ngit clone https://github.com/gluster/glustercli-python.git\ncd glustercli-python\npython3 setup.py install\n```\n\nInstalling the gstatus tool:\n* Using python-setuptools\n\n```\ngit clone https://github.com/gluster/gstatus.git\ncd gstatus\nVERSION=1.0.6 make gen-version\npython3 setup.py install\n```\n\nRunning the tool\n================\n\nNOTE: The tool has to be run as root or sudo \u003ccmd\u003e. This requirement is\n      imposed by gluster than gstatus. Since gstatus internally calls the\n      gluster command, running as superuser is a necessity.\n\n```\nroot@master-node:~# gstatus -h\nUsage: gstatus [options]\n\nOptions:\n  --version             show program's version number and exit\n  -h, --help            show this help message and exit\n  -v, --volume          volume info (default is ALL, or supply a volume name)\n  -a, --all             Print all available details on volumes\n  -b, --bricks          Print the list of bricks\n  -q, --quota           Print the quota information\n  -s, --snapshots       Print the snapshot information\n  -u UNITS, --units=UNITS\n                        display storage size in given units\n  -o OUTPUT_MODE, --output-mode=OUTPUT_MODE\n                        Output mode, only json is supported currently. Default\n                        is to print to console.\nroot@master-node:~#\n```\n      \nListing Volumes\n---------------\n\nBy default gstatus prints an overview of all the volumes available in the\ncluster. However, user can filter the volumes by specifying -v \u003cvolname\u003e, more\nthan one volume can be specified by repeated invocation of -v. Or a regular\nexpression can be provided with -v option. For example:\n\ngstatus -v '.*perf'\n\nEnsure to use single quotes around the pattern, else shell file globbing will\ninclude unnecessary input. The above pattern fetches all the volumes whose name\nends with perf. Any standard regular expression can be provided.\n\nUser can request more detailed volume information by providing the -a\noption. Other volume options include -b, -q, -s which provides brick, quota, and\nsnapshot details respectively.\n\nQuota\n-----\n\nBy default gstatus reports `Quota: on' if quota is set. With options -a or -q\nthe list of all quota entries, size, and usage is reported.\n\n\nUnderstanding the output\n========================\n\ngstatus output is made up of two parts:\n\na. Cluster infromation.\nb. Volume information.\n\n(There will be more as we add self-heal, rebalance, geo-replication ...)\n\na. Cluster information\n\nCluster information provides the health of the cluster and reports the number of\nnodes reachable, the number of volumes in the cluster and the number of volumes\nwhich are up.\n\nb. Volume Information\n\nThere are three columns in the volume section namely volume name, volume type\n(Replicate, Distribute, Distributed-Disperse, Disperse), and additional volume\nrelated information. The third column provides wealth of volume information\nwhich includes:\n\n1. Status - (Started/Stopped)\n2. Health (Displayed only when volume is started):\n          i) UP       - All bricks are up and volume is healthy.\n         ii) DOWN     - All bricks are down (needs immediate attention).\n        iii) PARTIAL  - Only some of the bricks are up. (volume is functional).\n         iv) DEGRADED - Some of the sub-volumes are down. (In case of distribute\n                        data might not be accessible)\n3. Capacity  - Volume capacity. Displayed units can be controlled by -u switch.\n4. Snapshots - By default only snapshot count is shown. Detailed information can\n               be viewed by using -s or -a switch to gstatus.\n5. Bricks    - Brick list is not shown by default. Can be viewed by using -b or -a\n               switch.\n6. Quota     - List of directories on which quota is set can be viewed by\n               running gstatus with -q or -a switch. By default just the quota\n               status is shown which is on/off.\n\nOutput formats\n==============\nBy default output is displayed on screen in a pretty printed format.\nAlternatively, user can generate JSON output by passing -o json to gstatus\ncommand.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgluster%2Fgstatus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgluster%2Fgstatus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgluster%2Fgstatus/lists"}