Merge branch 'database-pruning-schedule' of https://github.com/flask-…

…dashboard/Flask-MonitoringDashboard into database-pruning-schedule
flask-dashboard · Dec 13, 2023 · 075ae8b · 075ae8b
2 parents 7c27cdb + 15aeaf7
commit 075ae8b
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 9 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -5,6 +5,12 @@ 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.3.0
+----------
+Changed
+
+- Added database pruning feature
+
 v3.2.2
 ----------
 Changed

diff --git a/docs/functionality.rst b/docs/functionality.rst
@@ -311,7 +311,7 @@ about which you can read more `in the corresponding documentation page <apschedu
 
 
 Adding database cleaning schedule
------------------
+----------------------------------
 
 As your application grows, so will the amount of data stored in the database.
 To prevent it from growing too large, you can set up a schedule to clean the database.
@@ -358,6 +358,8 @@ What:
 
 4. **Table size:** In order to determine how fast the data accumulates, we collect the size of the database and its tables.
 
+5. **Route visits:** We collect which routes you use in the dashboard.
+
 How:
 
 We post the data anonymously to a remote server. This way we can monitor which functionalities are being used the most, and which functionalities are not being used at all. We are a small research team and this way we can focus our efforts on what actually matters.

diff --git a/flask_monitoringdashboard/constants.json b/flask_monitoringdashboard/constants.json
@@ -1,5 +1,5 @@
 {
-    "version": "3.2.2",
+    "version": "3.3.0",
     "author": "Krzysztof Wielicki, Johannes Lind Christiansen",
     "email": "flask.monitoringdashboard@gmail.com"
 }
diff --git a/flask_monitoringdashboard/frontend/js/controllers/databaseManagementController.js b/flask_monitoringdashboard/frontend/js/controllers/databaseManagementController.js
@@ -59,7 +59,6 @@ export function DatabaseManagementController($scope, $http, menuService, endpoin
             .then(function (response) {
                 $scope.pruningSchedule = response.data;
             }, function (error) {
-                console.error('Error fetching pruning schedule:', error.data);
             });
     };
     $scope.getPruningSchedule();

diff --git a/flask_monitoringdashboard/frontend/js/controllers/telemetryController.js b/flask_monitoringdashboard/frontend/js/controllers/telemetryController.js
@@ -4,7 +4,7 @@ export function TelemetryController($scope, $http, $window) {
     const telemetryAnswered = $window.localStorage.getItem('telemetryAnswered') === 'true';
 
     // Control the visibility of the telemetry prompt based on previous response
-    $scope.telemetryShow = !telemetryAnswered   ;
+    $scope.telemetryShow = !telemetryAnswered;
     $scope.followUpShow = false;
 
     // Function to fetch telemetry consent status from database 

diff --git a/flask_monitoringdashboard/frontend/package.json b/flask_monitoringdashboard/frontend/package.json
@@ -20,7 +20,6 @@
     "angular-datatables": "^16.0.0",
     "angular-route": "^1.8.0",
     "bootstrap": "^5.3.2",
-    "chartjs-plugin-datalabels": "^2.2.0",
     "css-loader": "^6.8.1",
     "d3": "^7.8.5",
     "datatables": "^1.10.18",

diff --git a/flask_monitoringdashboard/static/js/app.js b/flask_monitoringdashboard/static/js/app.js
diff --git a/flask_monitoringdashboard/static/pages/database_management.html b/flask_monitoringdashboard/static/pages/database_management.html
@@ -75,4 +75,12 @@ <h5 class="mt-3">Schedule Details:</h5>
             </div>
         </div>
     </div>
-</div>
+
+    <div class="card-body">
+        <p>For maintaining optimal performance by regularly cleaning old data as your application scales, visit the <a
+                href="https://flask-monitoringdashboard.readthedocs.io/en/latest/functionality.html#adding-database-cleaning-schedule"
+                target="_blank">documentation</a> to learn about setting up and automating a
+            database pruning schedule.</p>
+    </div>
+
+</div>
diff --git a/flask_monitoringdashboard/static/pages/telemetry.html b/flask_monitoringdashboard/static/pages/telemetry.html
@@ -5,7 +5,7 @@
         features that are not useful. You have <u>full</u> control and can modify your choice at any time in the
         "Configuration" section.</p>
     If you can't help us with usage information, you can maybe help us with
-    adopting and fixing some <a href=https://github.com/flask-dashboard/Flask-MonitoringDashboard/issues">issues</a>? We are an open-source project! <br>
+    adopting and fixing some <a href="https://github.com/flask-dashboard/Flask-MonitoringDashboard/issues">issues</a>? We are an open-source project! <br>
 
     Want to know more?
     <a href="https://flask-monitoringdashboard.readthedocs.io/en/latest/functionality.html#telemetry">Learn about what