Metadata-Version: 1.2
Name: Flask-Monitoring
Version: 1.1.2
Summary: Automatically monitor the evolving performance of Flask/Python web services.
Home-page: https://github.com/phamngocquy/Flask-MonitoringDashboard
Author: Quy Ngoc Pham
Author-email: phamngocquy97@gmail.com
License: UNKNOWN
Project-URL: PyPi, https://pypi.org/project/Flask-MonitoringDashboard/
Project-URL: Documentation, http://flask-monitoringdashboard.readthedocs.io/
Project-URL: Bug Reports, https://github.com/phamngocquy/Flask-MonitoringDashboard/issues
Project-URL: Source, https://github.com/flask-dashboard/Flask-MonitoringDashboard/
Description: Flask Monitoring Dashboard
        ==========================
        
        A dashboard for automatic monitoring of Flask (http://flask.pocoo.org/) web-services.
        
        Key Features
        ------------
        The Flask Monitoring Dashboard is an extension for Flask applications that offers four main functionalities with little effort from the Flask developer:
        
        - **Monitor the performance and utilization:**
          The Dashboard allows you to see which endpoints process a lot of requests and how fast.
          Additionally, it provides information about the evolving performance of an endpoint throughout different versions if you're using git.
        
        - **Profile requests and endpoints:**
          The execution path of every request is tracked and stored into the database. This allows you to gain
          insight over which functions in your code take the most time to execute. Since all requests for an
          endpoint are also merged together, the Dashboard provides an overview of which functions are used in
          which endpoint.
        
        - **Collect extra information about outliers:**
          Outliers are requests that take much longer to process than regular requests.
          The Dashboard automatically detects that a request is an outlier and stores extra information about it (stack trace, request values, Request headers, Request environment).
        
        - **Collect additional information about your Flask-application:**
          Suppose you have an User-table and you want to know how many users are registered on your Flask-application.
          Then, you can run the following query: 'SELECT Count(*) FROM USERS;'. But this is just annoying to do regularly.
          Therefore, you can configure this in the Flask-MonitoringDashboard, which will provide you this information per day (or other time interval).
        
        
        The dashboard is automatically added to your existing Flask application.
        You can view the results by default using the default endpoint (this can be configured to another route):
        
           http://localhost:5000/dashboard
        
        For more advanced documentation, take a look at the information
        on `this site`_
        
        .. _this site: _http://flask-monitoringdashboard.readthedocs.io/en/latest/functionality.html
        
        
        How to use
        ============
        
        Installation
        ------------
        
        To install from source, download the source code, then run this:
        
            python setup.py install
        
        Or install with pip:
        
            pip install flask_monitoringdashboard
        
        Setup
        ------------
        Adding the extension to your Flask app is simple:
        
            from flask import Flask
            import flask_monitoringdashboard as dashboard
        
            app = Flask(__name__)
            dashboard.bind(app)
        
        Live Demo
        ------------
        To view a live deployment of the Flask-MonitoringDashboard, `check this site`_
        
        .. _`check this site`: https://flask-monitoringdashboard.herokuapp.com/
        
        Use the credentials u:`admin`, p:`admin` to log in.
        
        Feedback
        ------------
        In order to improve our Flask-MonitoringDashboard, we would like to hear from you! Therefore, we made a questionnaire
        with a few questions. Filling in this form takes less than 3 minutes. You can find the form `here
        <https://goo.gl/forms/IqRrjGDDXe44q5ZV2>`_.
        
        Alternatively, feel free to write to `our email-address
        <mailto:flask.monitoringdashboard@gmail.com>`_.
        
        Documentation
        -------------
        For more advanced documentation, `see this site
        <http://flask-monitoringdashboard.readthedocs.io>`_
        If you run into trouble migrating from version 1.X.X to version 2.0.0, this site will help you solve this too.
        The migration from 2.X.X to 3.0.0 should be easier.
        
        
        License
        ------------
        This project is licensed under the MIT License - see the LICENSE file for details.
        
        v1.1.2
        ----------
        Thank to https://github.com/flask-dashboard/Flask-MonitoringDashboard
        
        Changed
        
        - Customize UI
        - Update sync response code
Platform: Any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Framework :: Flask
