Refactor issue templates and README.md, and update prometheus.sh script

Author: codeperfectplus

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,31 +8,27 @@ assignees: ''
 ---
 
 **Describe the bug**
+
 A clear and concise description of what the bug is.
 
 **To Reproduce**
+
 Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
 
 **Expected behavior**
+
 A clear and concise description of what you expected to happen.
 
 **Screenshots**
+
 If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
+**(please complete the following information):**
+
  - OS: [e.g. iOS]
  - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+ - Systemguard version [e.g. 22]
 
 **Additional context**
+
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,13 +8,17 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
+
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
 **Describe the solution you'd like**
+
 A clear and concise description of what you want to happen.
 
 **Describe alternatives you've considered**
+
 A clear and concise description of any alternative solutions or features you've considered.
 
 **Additional context**
+
 Add any other context or screenshots about the feature request here.

README.md

@@ -2,6 +2,7 @@
 
 System Guard is a Flask app designed to monitor server stats such as CPU, Memory, Disk, and Network. It also provides real-time monitoring capabilities which can be useful for system administrators, developers, and DevOps engineers to keep track of their server's performance and troubleshoot issues. The app uses the `psutil` library to retrieve system stats and the `speedtest-cli` library to perform a network speed test.
 
+
 ## Features 🚀
 
 - Lightweight, open-source, and free to use with a straightforward installation process, out-of-the-box monitoring solution.
@@ -18,6 +19,16 @@ System Guard is a Flask app designed to monitor server stats such as CPU, Memory
 - Role-based dashboards tailored for Developer, Admin, IT Manager, and Manager roles (upcoming feature).
 - Update security updates with a single click or automatically update to the latest version to simplify maintenance.
 
+## Architecture 🏗️
+
+![SystemGuard-Architecture](/src/docs/images/SystemGuard-Architecture.jpg)
+
+## Tech Stack 🛠️
+
+- **Frontend**: JavaScript, Bootstrap, Chart.js, Grafana
+- **Backend**: Python, Flask, SQLAlchemy, SQLite, Prometheus, InfluxDB
+- **Monitoring**: psutil, speedtest-cli, nmap, netstat
+
 ## Get started 🛠️
 
 - Check the [Installation.md](/src/docs/installation.md) file for installation instructions.

src/docs/images/SystemGuard-Architecture.jpg

@@ -1,14 +1,33 @@
 #!/bin/bash
 
+# function to get the user name
+get_user_name() {
+    if [ "$(whoami)" = "root" ]; then
+        LOGNAME_USER=$(logname 2>/dev/null) # Redirect any error output to /dev/null
+        if [ $? -ne 0 ]; then               # Check if the exit status of the last command is not 0
+            USER_NAME=$(cat /etc/passwd | grep '/home' | cut -d: -f1 | tail -n 1)
+        else
+            USER_NAME=$LOGNAME_USER
+        fi
+    else
+        USER_NAME=$(whoami)
+    fi
+    echo "$USER_NAME"
+}
+
+USER_NAME=$(get_user_name)
 # Configuration
 NETWORK_NAME="flask-prometheus-net"
 CONTAINER_NAME="prometheus"
 PROMETHEUS_IMAGE="prom/prometheus"
 PROMETHEUS_PORT="9090"
 PROMETHEUS_CONFIG_DIR="$(pwd)/prometheus_config"
 PROMETHEUS_CONFIG_FILE="$PROMETHEUS_CONFIG_DIR/prometheus.yml"
+PROMETHEUS_DATA_DIR="/home/$USER_NAME/.database/prometheus"
 FLASK_APP_IP=$(hostname -I | cut -d' ' -f1)
 FLASK_APP_PORT="5050"
+SCRAPING_INTERVAL="10s"
+JOB_NAME='systemguard-metrics'
 
 # Logging function for better readability
 log() {
@@ -18,18 +37,22 @@ log() {
 # Ensure the config directory exists
 log "Creating Prometheus config directory if it doesn't exist."
 mkdir -p "$PROMETHEUS_CONFIG_DIR"
+mkdir -p "$PROMETHEUS_DATA_DIR"
 
 # Create the prometheus.yml configuration file
 log "Generating prometheus.yml configuration file."
 cat > "$PROMETHEUS_CONFIG_FILE" <<EOL
 global:
-  scrape_interval: 10s  # How often Prometheus scrapes the target
+  scrape_interval: $SCRAPING_INTERVAL
+  # how frequently to scrape targets from the target list
 
 scrape_configs:
-  - job_name: 'flask_app_metrics'  # Scraping metrics from Flask app
-    static_configs:  # first ip address in the local machine ip address list
+  - job_name: $JOB_NAME
+    static_configs:
       - targets: ['$FLASK_APP_IP:$FLASK_APP_PORT']
+
       # apeend more targets list to scrape metrics from multiple services, on central prometheus server
+      # first ip address in the local machine ip address list
 EOL
 
 # Check if Docker network exists
@@ -57,6 +80,7 @@ run_output=$(docker run -d \
   -p "$PROMETHEUS_PORT:$PROMETHEUS_PORT" \
   --restart always \
   -v "$PROMETHEUS_CONFIG_FILE:/etc/prometheus/prometheus.yml" \
+  -v "PROMETHEUS_DATA_DIR:/prometheus" \
   "$PROMETHEUS_IMAGE" 2>&1)  # Capture both stdout and stderr
 
 # Check if Prometheus started successfully