Metadata-Version: 2.0
Name: Flask-Stats
Version: 0.1.0
Summary: A flask plugin to keep stats about your application
Home-page: https://github.com/solarnz/Flask-Stats
Author: Chris Trotman
Author-email: chris@trotman.io
License: BSD
Keywords: Flask-Stats
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-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
Requires-Dist: Flask
Requires-Dist: statsd

===========
Flask-Stats
===========

.. module:: flask.ext.stats

This flask extension automatically provides paging timing and http status code
statistics to statsd.

It will send page timings to `<APP_NAME>.<BLUEPRINT>.<FUNCTION>`, and status
codes to `<APP_NAME>.<BLUEPRINT>.<FUNCTION>.http_XXX`, where XXX is the status
code, i.e 403.

Installation
------------

Install by installing it from the Python Package Index.

.. code-block:: console

    $ pip install Flask-Stats

Configuration
-------------

Flask-Stats uses the following configuration values.

.. tabularcolumns:: |p{6.5cm}|p{8.5cm}|


=============================== ========================================================
`STATS_HOSTNAME`                Specifies the host to send statsd values to. Defaults to
                                localhost.
`STATS_PORT`                    Specified the port to send statsd values to. Defaults to
                                8125.
`STATS_BASE_KEY`                The base key to send the stats to. Defaults to the
                                application name.
=============================== ========================================================

Changelog
---------

Todo
----

- Unit tests

API Documentation
-----------------

.. automodule:: flask_stats
    :members:
    :undoc-members:
    :show-inheritance:


