Metadata-Version: 1.1
Name: gottwall
Version: 0.4.2
Summary: GottWall is scalable realtime metrics collecting and aggregation platform and service
Home-page: https://github.com/GottWall/GottWall
Author: Alexandr Lispython
Author-email: alex@obout.ru
License: BSD
Description: Welcome to GottWall's documentation!
        ======================================
        
        GottWall is a scalable realtime metrics collecting and aggregation platform and service.
        This package, at its core, is just a simple aggregation server and
        beautiful customizable web dashboard for visualizing metrics with charts.
        
        It will handle authenticating clients (such as stati)
        and all of the logic behind storage and aggregation.
        
        
        .. image:: https://travis-ci.org/GottWall/GottWall.png
        	   :target: https://travis-ci.org/GottWall/GottWall
        
        .. image:: http://obout.ru/s/empty.gif
        	   :height: 1px
        	   :width: 1px
        
        Features
        --------
        
        - Beautiful customizable dashboard for visualizing metrics with charts.
        - Data aggregation
        - Data collection
        - Embedded charts (`HTML <http://demo.gottwall.com/api/embedded/hash.html>`_, iframe, `javascript <http://demo.gottwall.com/api/mbedded/hash.js>`_, `JSON <http://demo.gottwall.com/api/embedded/hash.json>`_)
        
        Demo
        ----
        
        You can try free demo charts on `demo.gottwall.com <http://demo.gottwall.com>`_.
        Login opened for all users.
        
        
        Screenshots
        -----------
        
        Dashboard
        ^^^^^^^^^
        
        .. image:: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_6_thumb.png
        	   :target: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_6.png
        
        .. image:: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_7_thumb.png
        	   :target: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_7.png
        
        Custom graph type and title
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        .. image:: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_8_thumb.png
        	   :target: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_8.png
        
        .. image:: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_11_thumb.png
        	   :target: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_11.png
        
        
        Simple chart charing
        ^^^^^^^^^^^^^^^^^^^^
        
        .. image:: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_9_thumb.png
        	   :target: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_9.png
        
        .. image:: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_10_thumb.png
        	   :target: https://raw.github.com/GottWall/GottWall/master/docs/source/images/GottWall_10.png
        
        
        Installation
        ------------
        
        To use gottwall  use `pip` or `easy_install`::
        
          pip install gottwall
        
        or ::
        
          easy_install gottwall
        
        or you can use official `gottwall chef cookbook <https://github.com/GottWall/gottwall-cookbook>`_
        for automatic setup on system.
        
        
        Configuration
        -------------
        
        See gottwall/examples/config.py
        
        
        Usage
        -----
        
        GottWall have 2 independent parts. Web interface application and aggregator application (application that process data).
        
        Starting web dashboard
        ^^^^^^^^^^^^^^^^^^^^^^
        
        To run web application execute command::
        
          gottwall --config="examples/config.py" server start
        
        
        Starting aggregator
        ^^^^^^^^^^^^^^^^^^^
        
        To run aggregator application execute command::
        
          gottwall --config="examples/config.py" aggregator start
        
        
        Available storages
        ------------------
        
        Storages that store metrics:
        
        - Memory storage (for tests only)
        - Redis storage (fast for counters increment, but time complexity O(N) for data range select)
        - TODO: mongodb
        - TODO: SQL
        
        
        Available transport backends
        ----------------------------
        
        The following transport available:
        
        - Redis transport backend
        - TCP/IP transport backend
        - TODO: UDP transport backend
        - HTTP transport backend
        
        
        .. _available-clients:
        
        Available clients
        -----------------
        
        The following clients are officially recognized as production-ready, and support the current GottWall protocol:
        
        - stati-http-python (`stati-http-python <http://github.com/GottWall/stati-http-python`_) with json http transport.
        - stati-redis-python (`stati-redis-python <http://github.com/GottWall/stati-redis-python>`_) with redis transport.
        
        
        CONTRIBUTE
        ----------
        
        We need you help.
        
        #. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
           There is a Contributor Friendly tag for issues that should be ideal for people who are not very familiar with the codebase yet.
        #. Fork `the repository`_ on Github to start making your changes to the **develop** branch (or branch off of it).
        #. Write a test which shows that the bug was fixed or that the feature works as expected.
        #. Send a pull request and bug the maintainer until it gets merged and published.
        
        .. _`the repository`: https://github.com/GottWall/GottWall/
        
        
        ETC
        ---
        
        * Graphs widgets rendered with `rickshaw <http://code.shutterstock.com/rickshaw/>`_ (HTML5 + SVG and `d3.js <http://d3js.org/>`_) library.
        
Platform: Linux
Platform: Mac
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Development Status :: 4 - Beta
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: System :: Installation/Setup
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Networking
Classifier: Intended Audience :: Customer Service
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Internet :: Log Analysis
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Networking :: Monitoring
