@gazzehamine/armada-watch-agent 1.4.7 → 1.4.9

package/README.md

@@ -10,6 +10,35 @@ Lightweight monitoring agent for EC2 instances. Collects and sends system metric
 npm install -g @gazzehamine/armada-watch-agent
 ```
 
+### Automated Setup (Easiest)
+
+After installing the agent, run the setup wizard:
+
+```bash
+armada-watch-setup
+```
+
+This interactive script will:
+- ✅ Verify Node.js and PM2 installation
+- ✅ Configure the agent (.env file)
+- ✅ Start the agent with PM2
+- ✅ Optionally configure Nginx monitoring
+- ✅ Optionally configure SSL certificate monitoring
+- ✅ Optionally configure security monitoring
+- ✅ Set up PM2 auto-start on boot
+
+**Note:** For SSL monitoring to work, you need to restart PM2 daemon after setup:
+```bash
+pm2 kill
+cd ~/armada-watch-agent
+pm2 start armada-watch-agent --name armada-watch
+pm2 save
+```
+
+## Manual Setup
+
+If you prefer to configure manually:
+
 ## Quick Start
 
 ### 1. Set Environment Variables

package/dist/index.js

@@ -21,6 +21,11 @@ try {
 catch (error) {
     console.warn("Could not read agent version from package.json");
 }
+// Handle --version flag
+if (process.argv.includes("--version") || process.argv.includes("-v")) {
+    console.log(AGENT_VERSION);
+    process.exit(0);
+}
 const SERVER_URL = process.env.SERVER_URL || "http://localhost:4000";
 const INSTANCE_NAME = process.env.INSTANCE_NAME || os_1.default.hostname();
 const REGION = process.env.REGION || "unknown";

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@gazzehamine/armada-watch-agent",
-  "version": "1.4.7",
+  "version": "1.4.9",
   "description": "Monitoring agent for Armada Watch - EC2 instance monitoring with SSL, PM2, Nginx, Systemd, and Security monitoring",
   "main": "dist/index.js",
   "bin": {
-    "armada-watch-agent": "dist/index.js"
+    "armada-watch-agent": "dist/index.js",
+    "armada-watch-setup": "setup.sh"
   },
   "scripts": {
     "build": "tsc",
@@ -30,7 +31,8 @@
   "files": [
     "dist",
     "README.md",
-    ".env.example"
+    ".env.example",
+    "setup.sh"
   ],
   "dependencies": {
     "axios": "^1.6.0",

package/setup.sh

@@ -0,0 +1,560 @@
+#!/bin/bash
+
+################################################################################
+# Armada Watch Agent - Automated Installation Script
+# 
+# This script automates the complete installation and configuration of the
+# Armada Watch monitoring agent on EC2 instances.
+#
+# Supports: Ubuntu 20.04+, Amazon Linux 2, Amazon Linux 2023
+################################################################################
+
+set -e  # Exit on error
+
+# Color codes for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+# Helper functions
+print_success() {
+    echo -e "${GREEN}✅ $1${NC}"
+}
+
+print_error() {
+    echo -e "${RED}❌ $1${NC}"
+}
+
+print_warning() {
+    echo -e "${YELLOW}⚠️  $1${NC}"
+}
+
+print_info() {
+    echo -e "${BLUE}ℹ️  $1${NC}"
+}
+
+print_header() {
+    echo -e "\n${BLUE}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
+    echo -e "${BLUE}$1${NC}"
+    echo -e "${BLUE}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}\n"
+}
+
+# Check if running with sudo
+if [ "$EUID" -eq 0 ]; then
+    print_error "Please do not run this script as root or with sudo"
+    print_info "Run as: ./setup-agent.sh"
+    exit 1
+fi
+
+# Clear screen and show banner
+clear
+echo -e "${GREEN}"
+cat << "EOF"
+   _                          _        __        __    _       _     
+  / \   _ __ _ __ ___   __ _  | |       \ \      / /_ _| |_ ___| |__  
+ / _ \ | '__| '_ ` _ \ / _` | | |   _____\ \ /\ / / _` | __/ __| '_ \ 
+/ ___ \| |  | | | | | | (_| | | |__|_____\ V  V / (_| | || (__| | | |
+/_/   \_\_|  |_| |_| |_|\__,_| |___|      \_/\_/ \__,_|\__\___|_| |_|
+
+          Automated Agent Installation Script
+                                                                        
+EOF
+echo -e "${NC}"
+
+print_info "This script will install and configure the Armada Watch monitoring agent"
+echo ""
+
+################################################################################
+# Step 1: System Detection
+################################################################################
+
+print_header "📋 Step 1: System Detection"
+
+# Detect OS
+if [ -f /etc/os-release ]; then
+    . /etc/os-release
+    OS=$ID
+    OS_VERSION=$VERSION_ID
+    print_success "Operating System: $PRETTY_NAME"
+else
+    print_error "Cannot detect operating system"
+    exit 1
+fi
+
+# Check if OS is supported
+if [[ "$OS" != "ubuntu" && "$OS" != "amzn" ]]; then
+    print_error "Unsupported OS: $OS"
+    print_info "Supported: Ubuntu 20.04+, Amazon Linux 2, Amazon Linux 2023"
+    exit 1
+fi
+
+# Detect current user
+CURRENT_USER=$(whoami)
+print_success "Running as user: $CURRENT_USER"
+
+# Check for sudo access
+if sudo -n true 2>/dev/null; then
+    print_success "Sudo access: Available"
+else
+    print_warning "Sudo access may require password"
+fi
+
+# Try to detect instance metadata (if running on EC2)
+print_info "Attempting to detect EC2 instance metadata..."
+
+# Get IMDSv2 token
+TOKEN=$(curl -X PUT "http://169.254.169.254/latest/api/token" \
+    -H "X-aws-ec2-metadata-token-ttl-seconds: 21600" \
+    --max-time 2 --silent 2>/dev/null) || true
+
+if [ -n "$TOKEN" ]; then
+    AUTO_INSTANCE_ID=$(curl -H "X-aws-ec2-metadata-token: $TOKEN" \
+        http://169.254.169.254/latest/meta-data/instance-id \
+        --max-time 2 --silent 2>/dev/null) || true
+    
+    AUTO_REGION=$(curl -H "X-aws-ec2-metadata-token: $TOKEN" \
+        http://169.254.169.254/latest/meta-data/placement/region \
+        --max-time 2 --silent 2>/dev/null) || true
+    
+    AUTO_HOSTNAME=$(curl -H "X-aws-ec2-metadata-token: $TOKEN" \
+        http://169.254.169.254/latest/meta-data/hostname \
+        --max-time 2 --silent 2>/dev/null) || true
+    
+    if [ -n "$AUTO_INSTANCE_ID" ]; then
+        print_success "Detected Instance ID: $AUTO_INSTANCE_ID"
+        print_success "Detected Region: $AUTO_REGION"
+    fi
+else
+    print_warning "Could not detect EC2 metadata (not running on EC2?)"
+    AUTO_INSTANCE_ID=$(hostname)
+    AUTO_REGION="us-east-1"
+fi
+
+################################################################################
+# Step 2: Node.js Installation
+################################################################################
+
+print_header "📥 Step 2: Node.js Installation"
+
+# Check if Node.js is already installed
+if command -v node &> /dev/null; then
+    NODE_VERSION=$(node -v | cut -d'v' -f2 | cut -d'.' -f1)
+    print_info "Node.js $(node -v) is already installed"
+    
+    if [ "$NODE_VERSION" -ge 16 ]; then
+        print_success "Node.js version is sufficient (v16+)"
+        SKIP_NODE_INSTALL=true
+    else
+        print_warning "Node.js version is too old (requires v16+)"
+        read -p "Do you want to upgrade Node.js to v20? (y/n): " UPGRADE_NODE
+        if [[ "$UPGRADE_NODE" =~ ^[Yy]$ ]]; then
+            SKIP_NODE_INSTALL=false
+        else
+            print_error "Cannot proceed without Node.js 16+"
+            exit 1
+        fi
+    fi
+else
+    print_info "Node.js not found"
+    SKIP_NODE_INSTALL=false
+fi
+
+if [ "$SKIP_NODE_INSTALL" != "true" ]; then
+    print_info "Installing Node.js 20.x..."
+    
+    if [ "$OS" == "ubuntu" ]; then
+        # Ubuntu installation
+        sudo apt-get update -qq
+        sudo apt-get install -y -qq ca-certificates curl gnupg
+        curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
+        sudo apt-get install -y -qq nodejs
+    elif [ "$OS" == "amzn" ]; then
+        # Amazon Linux installation
+        curl -fsSL https://rpm.nodesource.com/setup_20.x | sudo bash -
+        sudo yum install -y nodejs
+    fi
+    
+    if command -v node &> /dev/null; then
+        print_success "Node.js $(node -v) installed successfully"
+        print_success "NPM $(npm -v) installed successfully"
+    else
+        print_error "Node.js installation failed"
+        exit 1
+    fi
+fi
+
+################################################################################
+# Step 3: Agent Verification
+################################################################################
+
+print_header "📦 Step 3: Armada Watch Agent Verification"
+
+# Debug: Show current PATH
+print_info "Checking PATH..."
+echo "Current PATH: $PATH"
+
+# Ensure npm user-local directory is in PATH
+if [[ ":$PATH:" != *":$HOME/.npm-global/bin:"* ]]; then
+    print_info "Adding ~/.npm-global/bin to PATH"
+    export PATH="$HOME/.npm-global/bin:$PATH"
+else
+    print_info "~/.npm-global/bin already in PATH"
+fi
+
+# Debug: Check if armada-watch-agent exists
+print_info "Searching for armada-watch-agent..."
+AGENT_LOCATION=$(which armada-watch-agent 2>/dev/null || echo "not found")
+echo "Agent location: $AGENT_LOCATION"
+
+# Check if agent is installed
+if [ "$AGENT_LOCATION" != "not found" ]; then
+    print_info "Checking agent version..."
+    AGENT_VERSION=$(armada-watch-agent --version 2>/dev/null || echo "unknown")
+    print_success "Agent found: $AGENT_VERSION"
+else
+    print_error "Agent is not installed!"
+    echo ""
+    print_info "Please install the agent first using:"
+    echo ""
+    echo "  # Option 1: User-local install (recommended)"
+    echo "  mkdir -p ~/.npm-global"
+    echo "  npm config set prefix '~/.npm-global'"
+    echo "  export PATH=\"\$HOME/.npm-global/bin:\$PATH\""
+    echo "  npm install -g @gazzehamine/armada-watch-agent@latest"
+    echo ""
+    echo "  # Option 2: System-wide install"  
+    echo "  sudo npm install -g @gazzehamine/armada-watch-agent@latest"
+    echo ""
+    print_info "Then run this script again."
+    exit 1
+fi
+
+################################################################################
+# Step 4: Configuration
+################################################################################
+
+print_header "⚙️  Step 4: Agent Configuration"
+
+# Create agent directory
+AGENT_DIR="$HOME/armada-watch-agent"
+mkdir -p "$AGENT_DIR"
+cd "$AGENT_DIR"
+
+print_info "Configuration will be saved to: $AGENT_DIR/.env"
+echo ""
+
+# Prompt for SERVER_URL
+read -p "Enter SERVER_URL (e.g., http://your-server:4000): " SERVER_URL
+while [ -z "$SERVER_URL" ]; do
+    print_warning "SERVER_URL is required"
+    read -p "Enter SERVER_URL: " SERVER_URL
+done
+
+# Prompt for INSTANCE_NAME
+if [ -n "$AUTO_HOSTNAME" ]; then
+    read -p "Enter INSTANCE_NAME [default: $AUTO_HOSTNAME]: " INSTANCE_NAME
+    INSTANCE_NAME=${INSTANCE_NAME:-$AUTO_HOSTNAME}
+else
+    read -p "Enter INSTANCE_NAME (e.g., Production Web Server): " INSTANCE_NAME
+    while [ -z "$INSTANCE_NAME" ]; do
+        print_warning "INSTANCE_NAME is required"
+        read -p "Enter INSTANCE_NAME: " INSTANCE_NAME
+    done
+fi
+
+# Prompt for REGION
+if [ -n "$AUTO_REGION" ]; then
+    read -p "Enter REGION [default: $AUTO_REGION]: " REGION
+    REGION=${REGION:-$AUTO_REGION}
+else
+    read -p "Enter REGION (e.g., us-east-1): " REGION
+    while [ -z "$REGION" ]; do
+        print_warning "REGION is required"
+        read -p "Enter REGION: " REGION
+    done
+fi
+
+# Prompt for INSTANCE_ID
+if [ -n "$AUTO_INSTANCE_ID" ]; then
+    read -p "Enter INSTANCE_ID [default: $AUTO_INSTANCE_ID]: " INSTANCE_ID
+    INSTANCE_ID=${INSTANCE_ID:-$AUTO_INSTANCE_ID}
+else
+    read -p "Enter INSTANCE_ID (e.g., i-0abc123def): " INSTANCE_ID
+    while [ -z "$INSTANCE_ID" ]
+    do
+        print_warning "INSTANCE_ID is required"
+        read -p "Enter INSTANCE_ID: " INSTANCE_ID
+    done
+fi
+
+# Prompt for COLLECTION_INTERVAL
+read -p "Enter COLLECTION_INTERVAL in seconds [default: 10]: " COLLECTION_INTERVAL
+COLLECTION_INTERVAL=${COLLECTION_INTERVAL:-10}
+
+# Create .env file
+cat > .env <<EOF
+SERVER_URL=$SERVER_URL
+INSTANCE_NAME=$INSTANCE_NAME
+REGION=$REGION
+INSTANCE_ID=$INSTANCE_ID
+COLLECTION_INTERVAL=$COLLECTION_INTERVAL
+EOF
+
+print_success "Configuration saved to .env"
+
+# Display configuration
+echo ""
+print_info "Configuration Summary:"
+echo "  SERVER_URL: $SERVER_URL"
+echo "  INSTANCE_NAME: $INSTANCE_NAME"
+echo "  REGION: $REGION"
+echo "  INSTANCE_ID: $INSTANCE_ID"
+echo "  COLLECTION_INTERVAL: ${COLLECTION_INTERVAL}s"
+echo ""
+
+################################################################################
+# Step 5: PM2 Installation and Setup
+################################################################################
+
+print_header "🚀 Step 5: PM2 Process Manager"
+
+# Check if PM2 is installed
+if command -v pm2 &> /dev/null; then
+    print_success "PM2 is already installed: $(pm2 -v)"
+else
+    print_info "Installing PM2..."
+    if sudo npm install -g pm2 --silent; then
+        print_success "PM2 installed successfully: $(pm2 -v)"
+    else
+        print_error "PM2 installation failed"
+        exit 1
+    fi
+fi
+
+# Check if agent is already running in PM2
+if pm2 list | grep -q "armada-watch"; then
+    print_warning "Agent is already running in PM2"
+    read -p "Do you want to restart it? (y/n): " RESTART_PM2
+    if [[ "$RESTART_PM2" =~ ^[Yy]$ ]]; then
+        pm2 delete armada-watch 2>/dev/null || true
+        pm2 start armada-watch-agent --name armada-watch
+        print_success "Agent restarted in PM2"
+    fi
+else
+    print_info "Starting agent with PM2..."
+    cd "$AGENT_DIR"
+    if pm2 start armada-watch-agent --name armada-watch; then
+        print_success "Agent started successfully"
+    else
+        print_error "Failed to start agent"
+        exit 1
+    fi
+fi
+
+# Save PM2 process list
+pm2 save >/dev/null 2>&1
+print_success "PM2 process list saved"
+
+# Generate PM2 startup script
+echo ""
+print_info "To enable PM2 auto-start on system boot, run this command:"
+echo ""
+pm2 startup 2>/dev/null | grep "sudo" || true
+echo ""
+print_warning "Copy and run the command above to enable auto-start"
+echo ""
+
+# Show PM2 status
+print_info "Current PM2 Status:"
+pm2 list
+
+################################################################################
+# Step 6: Optional Components
+################################################################################
+
+print_header "🔧 Step 6: Optional Components"
+
+read -p "Do you want to configure optional components (Nginx, SSL, Security)? (y/n): " CONFIGURE_OPTIONAL
+echo ""
+
+if [[ "$CONFIGURE_OPTIONAL" =~ ^[Yy]$ ]]; then
+    
+    # Nginx Monitoring
+    print_info "Checking for Nginx..."
+    if command -v nginx &> /dev/null; then
+        print_success "Nginx detected"
+        
+        # Check if stub_status is configured
+        if curl -s http://127.0.0.1/nginx_status >/dev/null 2>&1; then
+            print_success "Nginx stub_status is already configured"
+        else
+            print_warning "Nginx stub_status is not configured"
+            read -p "Do you want to automatically configure Nginx monitoring? (y/n): " CONFIGURE_NGINX
+            
+            if [[ "$CONFIGURE_NGINX" =~ ^[Yy]$ ]]; then
+                print_info "Configuring Nginx stub_status..."
+                
+                # Backup the config
+                sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.backup.$(date +%Y%m%d%H%M%S)
+                
+                # Add stub_status location block
+                sudo sed -i '/server {/a\    location /nginx_status {\n        stub_status on;\n        access_log off;\n        allow 127.0.0.1;\n        deny all;\n    }\n' /etc/nginx/sites-available/default
+                
+                # Test configuration
+                if sudo nginx -t >/dev/null 2>&1; then
+                    sudo systemctl reload nginx
+                    sleep 2
+                    
+                    # Verify it works
+                    if curl -s http://127.0.0.1/nginx_status >/dev/null 2>&1; then
+                        print_success "Nginx stub_status configured successfully"
+                    else
+                        print_warning "Configuration added but endpoint not responding"
+                    fi
+                else
+                    print_error "Nginx configuration test failed, reverting changes"
+                    sudo mv /etc/nginx/sites-available/default.backup.* /etc/nginx/sites-available/default 2>/dev/null || true
+                fi
+            else
+                print_info "Skipping Nginx configuration - you can add it manually later"
+            fi
+        fi
+    else
+        print_info "Nginx not detected - skipping"
+    fi
+    
+    echo ""
+    
+    # SSL Certificate Access
+    print_info "Checking for SSL certificates..."
+    if [ -d "/etc/letsencrypt/live" ]; then
+        print_success "Certbot/Let's Encrypt detected"
+        
+        # Grant read access to adm group (PM2 preserves this group)
+        print_info "Granting SSL certificate access to adm group..."
+        sudo chgrp -R adm /etc/letsencrypt
+        sudo chmod -R g+rX /etc/letsencrypt
+        print_success "SSL certificate access configured for adm group"
+        print_info "The agent will be able to monitor SSL certificates"
+        
+    elif [ -d "/etc/letsencrypt" ]; then
+        print_warning "Certbot directory exists but no certificates found"
+    else
+        print_info "Certbot not detected - skipping SSL monitoring"
+    fi
+    
+    echo ""
+    
+    # Security Monitoring
+    print_info "Configuring security monitoring..."
+    
+    # Add user to adm group for log access
+    if ! groups $CURRENT_USER | grep -q "\\badm\\b"; then
+        print_info "Adding $CURRENT_USER to adm group..."
+        sudo usermod -aG adm $CURRENT_USER
+        print_success "User added to adm group"
+    else
+        print_success "User already in adm group"
+    fi
+    
+    # Restart PM2 to apply new groups
+    print_info "Restarting PM2 to apply new group memberships..."
+    pm2 restart armada-watch >/dev/null 2>&1
+    print_success "PM2 restarted"
+    
+    echo ""
+    
+    # SSM Agent Check
+    print_info "Checking SSM Agent..."
+    if [ "$OS" == "ubuntu" ]; then
+        # Ubuntu uses snap
+        if snap list amazon-ssm-agent >/dev/null 2>&1; then
+            SSM_STATUS=$(sudo snap services amazon-ssm-agent | grep amazon-ssm-agent | awk '{print $3}')
+            if [ "$SSM_STATUS" == "active" ]; then
+                print_success "SSM Agent is running (snap)"
+            else
+                print_warning "SSM Agent is not active"
+                sudo snap restart amazon-ssm-agent 2>/dev/null || true
+            fi
+        else
+            print_info "SSM Agent not installed (snap)"
+        fi
+    elif [ "$OS" == "amzn" ]; then
+        # Amazon Linux uses systemd
+        if systemctl is-active --quiet amazon-ssm-agent; then
+            print_success "SSM Agent is running (systemd)"
+        else
+            print_warning "SSM Agent is not active"
+            sudo systemctl restart amazon-ssm-agent 2>/dev/null || true
+        fi
+    fi
+    
+else
+    print_info "Skipping optional components"
+fi
+
+################################################################################
+# Step 7: Final Verification
+################################################################################
+
+print_header "✅ Step 7: Final Verification"
+
+# Test server connectivity
+print_info "Testing connection to monitoring server..."
+if curl -s --max-time 5 "$SERVER_URL/health" >/dev/null 2>&1; then
+    print_success "Successfully connected to monitoring server"
+else
+    print_warning "Could not connect to monitoring server"
+    print_info "Make sure the server URL is correct and accessible"
+fi
+
+# Show PM2 status
+echo ""
+print_info "Agent Status:"
+pm2 show armada-watch 2>/dev/null || pm2 list
+
+# Show recent logs
+echo ""
+print_info "Recent Agent Logs:"
+pm2 logs armada-watch --lines 10 --nostream 2>/dev/null || echo "No logs available yet"
+
+################################################################################
+# Installation Complete
+################################################################################
+
+echo ""
+print_header "🎉 Installation Complete!"
+
+echo ""
+print_success "Armada Watch Agent is now installed and running!"
+echo ""
+print_info "Useful Commands:"
+echo "  • View status:     pm2 list"
+echo "  • View logs:       pm2 logs armada-watch"
+echo "  • Restart agent:   pm2 restart armada-watch"
+echo "  • Stop agent:      pm2 stop armada-watch"
+echo ""
+print_info "Configuration file: $AGENT_DIR/.env"
+echo ""
+
+# Show SSL restart warning if SSL was configured
+if [ -d "/etc/letsencrypt/live" ] && [[ "$CONFIGURE_OPTIONAL" =~ ^[Yy]$ ]]; then
+    print_warning "⚠️  IMPORTANT: SSL Certificate Monitoring"
+    echo ""
+    echo "  To enable SSL monitoring, you must restart the PM2 daemon:"
+    echo ""
+    echo "  pm2 kill"
+    echo "  cd ~/armada-watch-agent"
+    echo "  pm2 start armada-watch-agent --name armada-watch"
+    echo "  pm2 save"
+    echo ""
+    print_info "  This allows PM2 to pick up the new SSL permissions."
+    echo ""
+fi
+
+print_info "Check your Armada Watch dashboard to verify the instance appears online."
+echo ""
+
+exit 0