v3.0.7 - Merge pull request #301 from flask-dashboard/development

flask-dashboard · Feb 28, 2020 · 60c2bf6 · 60c2bf6
2 parents 7bc7296 + 60afa3f
commit 60c2bf6
Show file tree

Hide file tree

Showing 21 changed files with 67 additions and 35 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 This project adheres to `Semantic Versioning <http://semver.org/>`_.
 Please note that the changes before version 1.10.0 have not been documented.
 
+v3.0.7 
+----------
+Changed
+- Added a first version of the Reporting functionality
+- Improved usability of the overview table
+- Fixed issue #`295` <https://github.com/flask-dashboard/Flask-MonitoringDashboard/issues/295>`_.
+
+
 v3.0.6
 ----------
 Changed

diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -39,9 +39,9 @@ The line should then be:
 
 .. code-block:: python
 
-   dashboard.config.init_from(envvar='DASHBOARD_CONFIG')
+   dashboard.config.init_from(envvar='FLASK_MONITORING_DASHBOARD_CONFIG')
 
-This will configure the Dashboard based on the file provided in the environment variable called `DASHBOARD_CONFIG`.
+This will configure the Dashboard based on the file provided in the environment variable called `FLASK_MONITORING_DASHBOARD_CONFIG`.
 
 The content of the configuration file
 -------------------------------------

diff --git a/docs/contact.rst b/docs/contact.rst
@@ -26,13 +26,13 @@ Currently, the team consists of three active developers:
    +------------+----------------------------------------------------------------------+
 
 .. |Picture1| image:: https://avatars2.githubusercontent.com/u/17162650?s=460&v=4
-              ..:width: 100px
+			  ..:width: 100px
 
 .. |Picture2| image:: https://avatars2.githubusercontent.com/u/7281856?s=400&v=4
-              ..:width: 100px
+			  ..:width: 100px
 
 .. |Picture3| image:: https://avatars3.githubusercontent.com/u/17165311?s=400&v=4
-              ..:width: 100px
+			  ..:width: 100px
 
 
 Found a bug?

diff --git a/docs/functionality.rst b/docs/functionality.rst
@@ -214,6 +214,10 @@ at least 1) in the application can be found under the **Dashboard** menu:
    requests for that endpoint. This provides information whether certain endpoints perform better (in terms of
    execution time) than other endpoints.
 
+6. **Reporting:** A more experimental feature which aims to automatically
+   detect and report changes in performance for various intervals
+   (e.g. today vs. yesterday, this week vs. last week, etc).
+
 Endpoint
 ~~~~~~~~~~~~~~
 

diff --git a/flask_monitoringdashboard/constants.json b/flask_monitoringdashboard/constants.json
@@ -1,5 +1,5 @@
 {
-    "version": "3.0.6",
+    "version": "3.0.7",
     "author": "Patrick Vogel, Bogdan Petre",
     "email": "[email protected]"
 }
diff --git a/flask_monitoringdashboard/core/config/parser.py b/flask_monitoringdashboard/core/config/parser.py
@@ -23,9 +23,14 @@ def parse_version(parser, header, version):
             # The file is specified by: 'ref: <location>'
             git_file = (open(os.path.join(git, 'HEAD')).read().rsplit(': ', 1)[1]).rstrip()
             # read the git-version
-            version = open(git + '/' + git_file).read()
-            # cut version to at most 6 chars
-            return version[:6]
+            version_file = os.path.join(git , git_file)
+            if os.path.exists(version_file):
+                version = open(version_file).read()
+                # cut version to at most 6 chars
+                return version[:6]
+            else:
+                # Return "dummy" version in case of no git version file found
+                return version
         except IOError:
             log("Error reading one of the files to retrieve the current git-version.")
             raise

diff --git a/flask_monitoringdashboard/core/profiler/stacktraceProfiler.py b/flask_monitoringdashboard/core/profiler/stacktraceProfiler.py
@@ -37,6 +37,7 @@ def __init__(self, thread_to_monitor, endpoint, ip, group_by, outlier_profiler=N
         self._lines_body = []
         self._total = 0
         self._outlier_profiler = outlier_profiler
+        self._status_code = 404
 
     def run(self):
         """

diff --git a/flask_monitoringdashboard/core/reporting/questions/status_code_distribution.py b/flask_monitoringdashboard/core/reporting/questions/status_code_distribution.py
@@ -1,5 +1,3 @@
-from collections import defaultdict
-
 from flask_monitoringdashboard.controllers.requests import get_status_code_frequencies_in_interval
 from flask_monitoringdashboard.core.reporting.questions.report_question import Answer, ReportQuestion
 from flask_monitoringdashboard.database import session_scope

diff --git a/flask_monitoringdashboard/database/request.py b/flask_monitoringdashboard/database/request.py
@@ -2,7 +2,6 @@
 Contains all functions that access a Request object.
 """
 import time
-from random import sample
 
 from sqlalchemy import and_, func
 
@@ -56,7 +55,7 @@ def add_request(db_session, duration, endpoint_id, ip, group_by, status_code):
         status_code=status_code,
     )
     db_session.add(request)
-    db_session.flush()
+    db_session.commit()
     return request.id
 
 

diff --git a/flask_monitoringdashboard/static/css/custom.css b/flask_monitoringdashboard/static/css/custom.css
@@ -497,4 +497,14 @@ footer.sticky-footer {
         transform: scaleY(1.0);
         -webkit-transform: scaleY(1.0);
     }
+}
+
+.greenText {color:green;}
+.redText {color:red;}
+
+.table_cell_with_error_count:after {
+    content:attr(error-count);
+    color: red;
+    vertical-align: super;
+    font-size: small;
 }
diff --git a/flask_monitoringdashboard/static/elements/endpointDetails.html b/flask_monitoringdashboard/static/elements/endpointDetails.html
@@ -26,7 +26,7 @@
                 <tr>
                     <td><b>Monitoring-level</b></td>
                     <td ng-click="$event.stopPropagation()">
-                        <monitorlevel name="endpoint.info.endpoint" value="endpoint.info['monitor-level']" />
+                        <monitorlevel name="endpoint.info.endpoint" value="endpoint.info['monitor-level']"></monitorlevel>
                     </td>
                 </tr>
                 <tr>

diff --git a/flask_monitoringdashboard/static/pages/grouped_profiler.html b/flask_monitoringdashboard/static/pages/grouped_profiler.html
@@ -61,5 +61,5 @@
         </div>
     </div>
 
-    <endpointdetails/>
+    <endpointdetails></endpointdetails>
 </div>
diff --git a/flask_monitoringdashboard/static/pages/outliers.html b/flask_monitoringdashboard/static/pages/outliers.html
@@ -18,7 +18,7 @@
         <div class="card-header"><h4>Outliers data</h4></div>
         <div class="card-body">
 
-            <pagination/>
+            <pagination></pagination>
 
             <div class="card" ng-repeat="row in table" style="margin-bottom: 10px;">
                 <div class="row">
@@ -73,9 +73,9 @@
                 </div>
             </div>
 
-            <pagination/>
+            <pagination></pagination>
 
         </div>
     </div>
-    <endpointdetails/>
+    <endpointdetails></endpointdetails>
 </div>
diff --git a/flask_monitoringdashboard/static/pages/overview.html b/flask_monitoringdashboard/static/pages/overview.html
@@ -44,30 +44,36 @@
                 <tbody>
                 <tr ng-repeat="row in table" style="cursor: pointer"
                     ng-click="go('/endpoint/' + row.id + '/hourly_load')">
+
                     <td style="background-color: {{ row.color }}"></td>
                     <td style="max-width: 200px;">{{ row.name }}</td>
 
-                    <td ng-show="isHits" style="text-align: right;">
+
+                    <td class="table_cell_with_error_count"
+                        ng-show="isHits"
+                        style="text-align: right;"
+                        ng-attr-error-count="{{ (row['hits-today-errors'] > 0) ? row['hits-today-errors'] : ''}}">
                         {{ row['hits-today'] | number }}
-                        <span ng-show="row['hits-today-errors'] > 0"
-                              style="color: red">({{ row['hits-today-errors'] }})</span>
                     </td>
-                    <td ng-show="isHits" style="text-align: right;">
-                        {{ row['hits-week'] | number }}
-                        <span ng-show="row['hits-week-errors'] > 0"
-                              style="color: red">({{ row['hits-week-errors'] }})</span>
 
+
+                    <td class="table_cell_with_error_count"
+                        ng-show="isHits" style="text-align: right;"
+                        ng-attr-error-count="{{ (row['hits-week-errors'] > 0) ? row['hits-week-errors'] : ''}}">
+                        {{ row['hits-week'] | number }}
                     </td>
+
                     <td ng-show="isHits" style="text-align: right;">
                         {{ row['hits-overall'] | number }}
                     </td>
 
                     <td ng-show="isHits==false" style="text-align: right;">{{ row['median-today'] | duration_ms }}</td>
                     <td ng-show="isHits==false" style="text-align: right;">{{ row['median-week'] | duration_ms }}</td>
-                    <td ng-show="isHits==false" style="text-align: right;">{{ row['median-overall'] | duration_ms }}</td>
+                    <td ng-show="isHits==false"
+                        style="text-align: right;">{{ row['median-overall'] | duration_ms }}</td>
                     <td style="text-align: center;">{{ row['last-accessed'] | dateDifference }}</td>
                     <td ng-click="$event.stopPropagation()">
-                        <monitorlevel name="row.name" value="row.monitor" />
+                        <monitorlevel name="row.name" value="row.monitor"></monitorlevel>
                     </td>
                 </tr>
                 </tbody>

diff --git a/flask_monitoringdashboard/static/pages/plotly_graph.html b/flask_monitoringdashboard/static/pages/plotly_graph.html
@@ -53,5 +53,5 @@
         </div>
     </div>
 
-    <endpointdetails/>
+    <endpointdetails></endpointdetails>
 </div>
diff --git a/flask_monitoringdashboard/static/pages/profiler.html b/flask_monitoringdashboard/static/pages/profiler.html
@@ -11,7 +11,7 @@
                 <div class="rect5"></div>
             </div>
 
-            <pagination/>
+            <pagination></pagination>
             <div class="card" ng-repeat="request in table" style="margin-bottom: 10px;">
                 <div class="card-header">
                     <div class="row align-items-end">
@@ -50,9 +50,9 @@
                 </table>
             </div>
 
-            <pagination/>
+            <pagination></pagination>
         </div>
     </div>
 
-    <endpointdetails/>
+    <endpointdetails></endpointdetails>
 </div>
diff --git a/flask_monitoringdashboard/static/pages/reporting.html b/flask_monitoringdashboard/static/pages/reporting.html
@@ -107,7 +107,7 @@ <h1>{{ summary.endpoint_name }}</h1>
                             <li class="list-group-item" ng-show="answer.is_significant || !onlyShowInteresting">
                                 <div ng-switch="answer.type">
                                     <div ng-switch-when="AVERAGE_LATENCY" style="padding-bottom:15px">
-                                        <h4>Average latency
+                                        <h4 ng-class="answer.percentual_diff > 0 ? 'redText' : 'greenText'">Average latency
                                             {{ answer.percentual_diff > 0 ? 'increased' : 'decreased' }} by
                                             {{ answer.percentual_diff | abs | number : 0 }}%</h4>
                                         <p>From {{ answer.compared_to_average|number:0 }}ms to

diff --git a/flask_monitoringdashboard/test/views/test_status_code_tracking.py b/flask_monitoringdashboard/test/views/test_status_code_tracking.py
@@ -1,7 +1,7 @@
 import unittest
 from time import sleep
 
-from flask import Flask, json, jsonify
+from flask import Flask, jsonify
 from flask_monitoringdashboard.core.cache import EndpointInfo
 from flask_monitoringdashboard.database import session_scope, Request
 

diff --git a/flask_monitoringdashboard/views/reporting.py b/flask_monitoringdashboard/views/reporting.py
@@ -48,7 +48,7 @@ def make_report():
         compared_to_interval = DateInterval(datetime.fromtimestamp(int(arguments['compared_to_interval']['from'])),
                                             datetime.fromtimestamp(int(arguments['compared_to_interval']['to'])))
 
-    except Exception as err:
+    except Exception:
         return 'Invalid payload', 422
 
     endpoint_summaries = []

diff --git a/migration/migrate_v2_to_v3.py b/migration/migrate_v2_to_v3.py
@@ -7,7 +7,7 @@
 
 
 from sqlalchemy import create_engine
-from sqlalchemy.orm import sessionmaker, joinedload
+from sqlalchemy.orm import sessionmaker
 
 from sqlalchemy.ext.declarative import declarative_base
 

diff --git a/requirements.txt b/requirements.txt
@@ -1,6 +1,7 @@
 click
 apscheduler
 flask>=0.9            # for monitoring the web-service
+jinja2==2.11.1		  # pinning this to avoid flask pulling in a later one which breaks python3.6
 sqlalchemy>=1.1.9     # for database support
 configparser          # for parsing the config-file
 psutil                # for logging extra CPU-info