Merge pull request #134 from flask-dashboard/development

Development

Author: FlyingBird95

README.md

@@ -3,6 +3,7 @@
 [![Documentation Status](https://readthedocs.org/projects/flask-monitoringdashboard/badge/?version=latest)](http://flask-monitoringdashboard.readthedocs.io/en/latest/?badge=latest)
 [![codecov](https://codecov.io/gh/flask-dashboard/Flask-MonitoringDashboard/branch/master/graph/badge.svg)](https://codecov.io/gh/flask-dashboard/Flask-MonitoringDashboard)
 [![PyPI version](https://badge.fury.io/py/Flask-MonitoringDashboard.svg)](https://badge.fury.io/py/Flask-MonitoringDashboard)
+[![Gitter chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Flask-MonitoringDashboard/Lobby)
 [![Py-version](https://img.shields.io/pypi/pyversions/flask_monitoringdashboard.svg)](https://img.shields.io/pypi/pyversions/flask_monitoringdashboard.svg)
 [![Downloads](http://pepy.tech/badge/flask-monitoringdashboard)](http://pepy.tech/count/flask-monitoringdashboard)
 

docs/changelog.rst

@@ -6,16 +6,19 @@ This project adheres to `Semantic Versioning <http://semver.org/>`_.
 Please note that the changes before version 1.10.0 have not been documented.
 
 
-Unreleased
+v1.13.0
 ----------
 Changed
 
-- Added mean CPU
+- Added boxplot of CPU loads
 
-- Updated documentation
+- Updated naming scheme of all graphs
+
+- Implemented two configuration options: the local timezone and the option to automatically monitor new endpoints
 
 - Updated the Test-Monitoring initialization
 
+- Updated Database support for MySQL
 
 v1.12.0
 -------

docs/conf.py

@@ -28,7 +28,7 @@
 version = constants['version']
 
 release = version
-copyright = '{}, {}'.format(datetime.datetime.now().year, author)
+copyright = '{}, {}'.format(datetime.datetime.utcnow().year, author)
 
 # -- General configuration ---------------------------------------------------
 

docs/configuration.rst

@@ -54,13 +54,15 @@ contains the entry point of the app. The following things can be configured:
    APP_VERSION=1.0
    CUSTOM_LINK=dashboard
    DATABASE=sqlite:////<path to your project>/dashboard.db
+   DEFAULT_MONITOR=True
+   TIMEZONE='Europe/Amsterdam'
    USERNAME=admin
    PASSWORD=admin
    GUEST_USERNAME=guest
    GUEST_PASSWORD=['dashboardguest!', 'second_pw!']
    GIT=/<path to your project>/.git/
    OUTLIER_DETECTION_CONSTANT=2.5
-   DASHBOARD_ENABLED = True
+   DASHBOARD_ENABLED=True
    TEST_DIR=/<path to your project>/tests/
    COLORS={'main':'[0,97,255]',
            'static':'[255,153,0]'}
@@ -75,6 +77,19 @@ This might look a bit overwhelming, but the following list explains everything i
 - **DATABASE:** Suppose you have multiple projects where you're working on and want to separate the results.
   Then you can specify different database_names, such that the result of each project is stored in its own database.
 
+- **DEFAULT_MONITOR:** When this configuration is set to True, new endpoints are automatically monitored by the Dashboard.
+
+- **TIMEZONE:** The timezone for converting a UTC timestamp to a local timestamp. For a list of all
+  timezones, use the following:
+
+  .. code-block:: python
+
+     import pytz  # pip install pytz
+     print(pytz.all_timezones)
+
+  The dashboard saves the time of every request by default in a UTC-timestamp. However, if you want to display
+  it in a local timestamp, you need this property.
+
 - **USERNAME** and **PASSWORD:** Must be used for logging into the Dashboard.
   Thus both are required.
 

docs/contact.rst

@@ -6,21 +6,24 @@ Developing-team
 ---------------
 Currently, the team consists of three active developers:
 
-+------------+----------------------------------------------------------------------+
-| |Picture1| | | **Patrick Vogel**                                                  |
-|            | |                                                                    |
-|            | | Core developer                                                     |
-|            | |                                                                    |
-|            | | **E-mail:** `patrickvogel@live.nl <mailto:patrickvogel@live.nl>`_. |
-+------------+----------------------------------------------------------------------+
-| |Picture2| | | **Thijs Klooster**                                                 |
-|            | |                                                                    |
-|            | | Test Monitor Specialist                                            |
-+------------+----------------------------------------------------------------------+
-| |Picture3| | | **Bogdan Petre**                                                   |
-|            | |                                                                    |
-|            | | Outlier Specialist                                                 |
-+------------+----------------------------------------------------------------------+
+.. table::
+   :widths: 2, 7
+
+   +------------+----------------------------------------------------------------------+
+   | |Picture1| | | **Patrick Vogel**                                                  |
+   |            | |                                                                    |
+   |            | | Core developer                                                     |
+   |            | |                                                                    |
+   |            | | **E-mail:** `patrickvogel@live.nl <mailto:patrickvogel@live.nl>`_. |
+   +------------+----------------------------------------------------------------------+
+   | |Picture2| | | **Thijs Klooster**                                                 |
+   |            | |                                                                    |
+   |            | | Test Monitor Specialist                                            |
+   +------------+----------------------------------------------------------------------+
+   | |Picture3| | | **Bogdan Petre**                                                   |
+   |            | |                                                                    |
+   |            | | Outlier Specialist                                                 |
+   +------------+----------------------------------------------------------------------+
 
 .. |Picture1| image:: https://avatars2.githubusercontent.com/u/17162650?s=460&v=4
               ..:width: 100px

docs/developing.rst

@@ -44,15 +44,14 @@ and views. Together this forms a Model-View-Controller-pattern:
     - **fmd_dashboard/overview.html**: For rendering the `Overview-page`_.
     - **fmd_dashboard/graph.html**: For rendering the following graphs:
 
-      - Heatmap
+      - Hourly load
       - Version Usage
       - Requests per endpoint
-      - Time per version
       - Time per endpoint
 
     - **fmd_dashboard/graph-details.html**: For rendering the following graphs:
 
-      - Heatmap
+      - Hourly load
       - Time per version per user
       - Time per version per ip
       - Time per version
@@ -67,7 +66,7 @@ and views. Together this forms a Model-View-Controller-pattern:
     .. _`Configuration-page`: http://localhost:5000/dashboard/configuration
     .. _`Login-page`: http://localhost:5000/dashboard/login
     .. _`Rules-page`: http://localhost:5000/dashboard/rules
-    .. _`Overview-page`: http://localhost:5000/dashboard/measurements/overview
+    .. _`Overview-page`: http://localhost:5000/dashboard/overview
     .. _`Testmonitor-page`: http://localhost:5000/dashboard/testmonitor
 
   - **views**: Contains all Flask route-functions that the Dashboard defines.
@@ -84,7 +83,12 @@ The following tools are used for helping the development of the Dashboard:
     shown as the default branch on Github. The Master branch will approximately be updated every 
     week. Every push to the master will be combined with a new version that is released in 
     `PyPi <https://pypi.org/project/Flask-MonitoringDashboard>`_. This branch is also used to 
-    compute the `Code coverage`_ and build the documentation_.
+    compute the `Code coverage`_ and build the documentation_. In case of a PR from development
+    into master, take care of the following two things:
+
+    1. The version must be updated in flask_monitoringdashboard/constants.json
+
+    2. The changelog should be updated in docs/changelog.rst
 
     .. _`Code coverage`: https://codecov.io/gh/flask-dashboard/Flask-MonitoringDashboard
 

docs/functionality.rst

@@ -129,7 +129,10 @@ To enable Travis to run your unit tests and send the results to the Dashboard, t
 
     .. code-block:: bash
 
-       python -m flask_monitoringdashboard.collect_performance --test_folder=./tests --times=5 --url=https://yourdomain.org/dashboard
+       python -m flask_monitoringdashboard.collect_performance \
+       --test_folder=./tests \
+       --times=5 \
+       --url=https://yourdomain.org/dashboard
 
   The `test_folder` argument specifies where the performance collection process can find the unit tests to use.
   The `times` argument (optional, default: 5) specifies how many times to run each of the unit tests.
@@ -182,9 +185,9 @@ The 'Dashboard'-menu contains the following content:
 
 1. **Overview:** A table with the all the endpoints that are being monitored (or have been monitored in the past).
    This table provides information about when the endpoint is last being requested, how often it is requested and what 
-   the median execution time is. Furthermore, it has a 'Details' button on the right. This is explained further in (7.).
+   the median execution time is. Furthermore, it has a 'Details' button on the right. This is explained further in (6).
 
-2. **Heatmap:** This graph provides information for each hour of the day of how often the endpoint is being requested. In 
+2. **Hourly load:** This graph provides information for each hour of the day of how often the endpoint is being requested. In 
    this graph it is possible to detect popular hours during the day.
 
 3. **Version Usage**: This graph provides information about the distribution of the utilization of the requests per version.
@@ -193,17 +196,14 @@ The 'Dashboard'-menu contains the following content:
 4. **Requests per endpoint:** This graph provides a row of information per day. In this graph, you can find
    whether the total number of requests grows over days.
 
-5. **Time per version:** This graph provides a row of information per application-version. In this graph, you can
-   find whether the execution time for all requests grows over the versions of the application.
-
-6. **Time per endpoint:** This graph provides a row of information per endpoint. In that row, you can find all the
+5. **Time per endpoint:** This graph provides a row of information per endpoint. In that row, you can find all the
    requests for that endpoint. This provides information whether certain endpoints perform better (in terms of
    execution time) than other endpoints.
 
-7. For each endpoint, there is a 'Details'-button (alternatively, you can click on the row itself). This provides the following 
+6. For each endpoint, there is a 'Details'-button (alternatively, you can click on the row itself). This provides the following 
    information (thus, all information below is specific for a single endpoint):
 
-   - **Heatmap:** The same heatmap as explained in (2.), but this time it is focused on the data of that particular
+   - **Hourly load:** The same hourly load as explained in (2), but this time it is focused on the data of that particular
      endpoint only.
 
    - **Time per version per user:** A circle plot with the average execution time per user per version. Thus, this

flask_monitoringdashboard/__init__.py

@@ -55,7 +55,7 @@ def bind(app):
 
         @user_app.after_request
         def after_request(response):
-            hit_time_stamp = str(datetime.datetime.now())
+            hit_time_stamp = str(datetime.datetime.utcnow())
             home = os.path.expanduser("~")
             log = open(home + '/endpoint_hits.log', 'a')
             log.write('"{}","{}"\n'.format(hit_time_stamp, request.endpoint))

flask_monitoringdashboard/collect_performance.py

@@ -40,15 +40,15 @@
         for case in suite:
             for test in case:
                 test_result = None
-                start_time_stamp = str(datetime.datetime.now())
+                start_time_stamp = str(datetime.datetime.utcnow())
                 time_before = time.time()
                 test_result = test.run(test_result)
                 time_after = time.time()
-                end_time_stamp = str(datetime.datetime.now())
+                end_time_stamp = str(datetime.datetime.utcnow())
                 log.write('"{}","{}","{}"\n'.format(start_time_stamp, end_time_stamp, str(test)))
                 execution_time = (time_after - time_before) * 1000
                 data['test_runs'].append(
-                    {'name': str(test), 'exec_time': execution_time, 'time': str(datetime.datetime.now()),
+                    {'name': str(test), 'exec_time': execution_time, 'time': str(datetime.datetime.utcnow()),
                      'successful': test_result.wasSuccessful(), 'iter': iteration + 1})
 log.close()
 

flask_monitoringdashboard/constants.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.12.5",
+	"version": "1.13.0",
 	"author": "Patrick Vogel, Thijs Klooster & Bogdan Petre",
 	"email": "patrickvogel@live.nl"
 }