Metadata-Version: 1.1
Name: gluster-stats
Version: 1.1.0
Summary: Display gluster stats
Home-page: https://github.com/danrue/gluster_stats
Author: Dan Rue
Author-email: drue@therub.org
License: BSD
Description: ===============================
        Gluster Statistics
        ===============================
        
        .. image:: https://img.shields.io/pypi/v/gluster_stats.svg
                :target: https://pypi.python.org/pypi/gluster_stats
        
        .. image:: https://img.shields.io/travis/danrue/gluster_stats.svg
                :target: https://travis-ci.org/danrue/gluster_stats
        
        
        .. image:: https://img.shields.io/badge/license-BSD-blue.svg
                :target: LICENSE
        
        .. image:: https://img.shields.io/badge/python-2.6%20%7C%202.7%20%7C%203.3%20%7C%203.4%20%7C%203.5-green.svg
        
        gluster-stats is a command-line utility that generates health-related gluster
        statistics in json, for use in monitoring gluster.
        
        Installation
        ------------
        
        ``pip install gluster-stats``
        
        Usage
        -----
        
        Return gluster stats in json format.
        
        ``sudo gluster-stats``
        
        Alternatively, use ``gluster-stats --sudo`` to have gluster-stats call all of
        the gluster commands with sudo, instead of calling gluster-stats root access
        itself.
        
        Example output::
        
            {
             "brick_stats": {
              "preprodcomms": [
               {
                "disk_free": 982151646412, 
                "disk_total": 1064615018496, 
                "disk_usage_percent": "0.08", 
                "disk_used": 82463372084, 
                "inode_free": 206325202, 
                "inode_total": 208035840, 
                "inode_usage_percent": "0.01", 
                "inode_used": 1710638, 
                "online": 1
               }, 
               {
                "disk_free": 984191755878, 
                "disk_total": 1064615018496, 
                "disk_usage_percent": "0.08", 
                "disk_used": 80423262618, 
                "inode_free": 206325528, 
                "inode_total": 208035840, 
                "inode_usage_percent": "0.01", 
                "inode_used": 1710312, 
                "online": 1
               }, 
               {
                "disk_free": 985802368614, 
                "disk_total": 1064615018496, 
                "disk_usage_percent": "0.07", 
                "disk_used": 78812649882, 
                "inode_free": 206325083, 
                "inode_total": 208035840, 
                "inode_usage_percent": "0.01", 
                "inode_used": 1710757, 
                "online": 1
               }
              ]
             }, 
             "gluster_version": "3.7.8", 
             "glusterd": 1, 
             "glusterfsd": 1, 
             "peers": 2, 
             "split_brain_entries": {
              "preprodcomms": 0
             }, 
             "unhealed_entries": {
              "preprodcomms": 855
             }, 
             "volume_count": 1, 
             "volumes": [
              "preprodcomms"
             ]
            }
        
        Commands
        --------
        
        The following commands are run and parsed to generate the json output:
        
        - ``gluster --version``
        - ``gluster peer status``
        - ``gluster volume list``
        - ``pidof glusterd``
        - ``pidof glusterfsd``
        
        For each volume, the following commands are run:
        
        - ``gluster volume heal <volume> info``
        - ``gluster volume heal <volume> info split-brain``
        - ``gluster volume status <volume> detail``
        
        When run with --sudo, the gluster commands that require sudo access (all but
        --version) are run with sudo prepended. 
        
        Testing
        -------
        
        Run ``make test``
        
        Tests are run locally with generated mock response files. Run
        ``gluster-stats-generate`` to generate new mock response file. The file will be
        saved at gluster_stats_<gluster_version>.json.
        
        Versioning
        ----------
        
        gluster-stats uses semantic versioning. Backward incompatible changes to the
        json output (such as changing something from a list to a dict) require a major
        version bump. New values in a dictionary will come with a minor version bump.
        Bug fixes and patches will use a patch bump.
        
        Todo
        ----
        
        - Use the secret --xml option with ``gluster volume status`` - status was hard
          to parse and the parser is probably fragile. This will require new mock test
          files.
        - Additional health checks?
        
        
        =======
        History
        =======
        
        0.0.1 (2016-05-26)
        ------------------
        
        * First release
        
Keywords: gluster monitoring
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
