Initial Bot Creation (#1)

thisismygithubok · web-flow · commit 4fcd4246721e · 2025-06-09T20:31:53.000+10:00
* Initial commit - basic functionality

* Filter out /proc /sys and /dev from disk usage

* Update README

* Update README

* Remove config from dockerfile

* Add docker compose example

* Update README

* Remove settings from bot.py, not needed

* Fix errors in view-stats.py

* Fix errors in view-stats.py
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,4 @@
+* text=auto
+*.sh text eol=lf
+Dockerfile text eol=lf
+*.py text eol=lf
diff --git a/README.md b/README.md
@@ -1,2 +1,59 @@
 # DiscServerMonitor
 A docker-based discord bot to help monitor the host system.
+
+<a href="https://hub.docker.com/r/thisismynameok/disc-server-monitor"><img alt="Docker Image Size (tag)" src="https://img.shields.io/docker/image-size/thisismynameok/disc-server-monitor/latest?style=for-the-badge">
+<img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/thisismynameok/disc-server-monitor?style=for-the-badge"></a>
+<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/thisismygithubok/DiscServerMonitor?color=brightgreen&style=for-the-badge">
+<img alt="GitHub" src="https://img.shields.io/github/license/thisismygithubok/DiscServerMonitor?style=for-the-badge"></p>
+
+## Slash Command ##
+This bot is currently, a singular slash commands to use:
+- /view-stats
+
+## Docker Run ##
+```
+docker run -e DISCORD_GUILD_ID=<your_guild_id> -e DISCORD_BOT_TOKEN=<your_bot_token> -e TZ=<your_tz> -v /proc:/host_proc:ro thisismynameok/disc-server-monitor:latest
+```
+
+## Docker Compose ##
+You can find an example in [docker-compose-example.yml](https://github.com/thisismygithubok/DiscServerMonitor/blob/main/docker-compose-example.yml)
+
+## Environment Variables ##
+- REQUIRED
+    - DISCORD_GUILD_ID
+        - This is your discord server ID
+    - DISCORD_BOT_TOKEN
+        - This is your discord bot token
+        - If you need information on how to create a discord bot, please see the section below on [setting up a discord bot](#setting-up-a-discord-bot)
+
+- OPTIONAL
+    - TZ
+        - This is optional, but you can specify this for the container/logging output timezone
+        - Must use IANA standard timezones
+
+```
+environment:
+    DISCORD_BOT_TOKEN: ${DISCORD_BOT_TOKEN}
+    DISCORD_GUILD_ID: ${DISCORD_GUILD_ID}
+    TZ: ${TZ}
+```
+
+## Volumes ##
+You need to mount the host's /proc as a volume to the container to be able to see system stats. 
+If you'd like to see usage stats on other drives than the boot drive, you'll need to mount them as well.
+```
+volumes:
+    - /proc:/host_proc:ro
+```
+
+## Setting Up a Discord Bot ##
+1. Navigate to the [Discord Developer Portal](https://discord.com/developers/applications)
+2. Create a new application
+    - Name it whatever you'd like the app to be named, in this case I've used "DiscServerMonitor"
+3. On the "General Information" page, give it a name and description.
+4. On the "Installation" page, change the install link to "None"
+5. On the "Bot" page, disable "Public Bot", and enable "Message Content Intent"  
+    - On this same page, make sure to copy your TOKEN as you'll need to pass this to the container
+6. On the "OAuth2" page, in the OAuth2 URL Generator section, choose "bot".
+    - In the "Bot Permissions" section below this, in text permissions, choose "Send Messages" and "Manage Messages".
+    - Copy the generated URL at the bottom and paste it into your browser. This will open the add bot to discord screen IN DISCORD. Select the server you want to add the bot to, and viola!
diff --git a/docker-compose-example.yml b/docker-compose-example.yml
@@ -0,0 +1,11 @@
+services:
+  DiscServerMonitor:
+    image: thisismynameok/disc-server-monitor:latest
+    container_name: DiscServerMonitor
+    restart: always
+    environment:
+      DISCORD_BOT_TOKEN: $DISCORD_BOT_TOKEN
+      DISCORD_GUILD_ID: $DISCORD_GUILD_ID
+      TZ: $TZ
+    volumes:
+        - /proc:/host_proc:ro
diff --git a/dockerfile b/dockerfile
@@ -0,0 +1,25 @@
+FROM alpine:3
+
+WORKDIR /src
+RUN mkdir /config
+
+COPY src/ .
+COPY src/entrypoint.sh /entrypoint.sh
+
+RUN apk update && apk upgrade
+RUN apk add docker-cli python3 py3-pip tzdata gosu
+
+RUN python3 -m venv /opt/venv
+ENV PATH="/opt/venv/bin:$PATH"
+
+RUN pip3 install discord.py prettytable setuptools>=78.1.1
+
+# Non-Root Docker
+RUN addgroup -S -g 988 docker && \
+    adduser -S -D -H -h /src -s /sbin/nologin -G docker -u 1000 nonroot && \
+    adduser nonroot docker && \
+    chown -R nonroot:docker /src /entrypoint.sh && \
+    chmod -R 755 /src /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]
+CMD ["python3", "bot.py"]
diff --git a/src/bot.py b/src/bot.py
@@ -0,0 +1,58 @@
+import os
+import discord
+import logging
+from discord import app_commands
+from discord.ext import commands
+
+# Suppress the PyNaCl warning since voice functionality isn't needed.
+discord.VoiceClient.warn_nacl = False
+
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(asctime)s - %(levelname)s - %(message)s',
+    datefmt='%Y-%m-%d %H:%M:%S',
+    force=True
+)
+logger = logging.getLogger(__name__)
+
+DISCORD_BOT_TOKEN = os.environ.get('DISCORD_BOT_TOKEN')
+DISCORD_GUILD_ID = os.environ.get('DISCORD_GUILD_ID')
+
+intents = discord.Intents.default()
+intents.message_content = True
+intents.guilds = True
+
+bot = commands.Bot(command_prefix=lambda bot, message: [], intents=intents, command_tree_cls=app_commands.CommandTree)
+
+if not DISCORD_BOT_TOKEN:
+    logger.error("DISCORD_BOT_TOKEN is not set in the environment variables")
+    raise ValueError("DISCORD_BOT_TOKEN is required to run the bot")
+
+if not DISCORD_GUILD_ID:
+    logger.error("DISCORD_GUILD_ID is not set in the environment variables")
+    raise ValueError("DISCORD_GUILD_ID is required to run the bot")
+
+async def load_cogs():
+    for filename in os.listdir('./cogs'):
+        if filename.endswith('.py'):
+            await bot.load_extension(f'cogs.{filename[:-3]}')
+            logger.info(f'Loaded {filename} cog successfully')
+
+@bot.event
+async def on_ready():
+    logger.info(f'Bot is ready and logged in as {bot.user}')
+    try:        
+        await load_cogs()
+        logger.info("Cogs loaded successfully")
+
+        # Add command syncing
+        guild = discord.Object(id=DISCORD_GUILD_ID) # type: ignore
+        bot.tree.copy_global_to(guild=guild)
+        synced_commands = await bot.tree.sync(guild=guild)
+        logger.info(f'Synced {len(synced_commands)} commands')
+
+    except Exception as e:
+        logger.error(f'Error syncing commands: {e}')
+
+logger.info("Starting Discord bot...")
+bot.run(f'{DISCORD_BOT_TOKEN}')
diff --git a/src/cogs/ping.py b/src/cogs/ping.py
@@ -0,0 +1,22 @@
+import os
+import discord
+import logging
+from discord import app_commands
+from discord.ext import commands
+
+logger = logging.getLogger(__name__)
+
+DISCORD_GUILD_ID = os.environ.get('DISCORD_GUILD_ID')
+
+class Ping(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+
+    @app_commands.guilds(discord.Object(id=DISCORD_GUILD_ID)) # type: ignore
+    @app_commands.command(name='ping', description='Ping the bot to check if it is online')
+
+    async def ping(self, interaction: discord.Interaction):
+        await interaction.response.send_message(f'{interaction.user.mention} Pong!', ephemeral=True, delete_after=30)
+
+async def setup(bot):
+  await bot.add_cog(Ping(bot))
diff --git a/src/cogs/view-stats.py b/src/cogs/view-stats.py
@@ -0,0 +1,175 @@
+import os
+import asyncio
+import discord
+import logging
+import subprocess
+from discord import app_commands
+from discord.ext import commands
+from prettytable import PrettyTable
+
+logger = logging.getLogger(__name__)
+
+DISCORD_GUILD_ID = os.environ.get('DISCORD_GUILD_ID')
+
+class ViewStats(commands.Cog):
+    def __init__(self, bot: commands.Bot):
+        self.bot = bot
+
+    def get_meminfo(self, proc_root="/proc/meminfo"):
+        meminfo = {}
+        try:
+            with open(f"{proc_root}", "r") as f:
+                for line in f:
+                    if ":" in line:
+                        key, value = line.split(":", 1)
+                        meminfo[key.strip()] = value.strip()
+        except Exception as e:
+            meminfo['error'] = f"Error reading meminfo: {e}"
+        return meminfo
+
+    def get_cpu_stat(self, proc_root="/proc/stat"):
+        cpu_stats = {}
+        cpu_error = {}
+        try:
+            with open(f"{proc_root}", "r") as f:
+                for line in f:
+                    if line.startswith("cpu "):
+                        parts = line.split()
+                        cpu_stats = {
+                            "user": int(parts[1]),
+                            "nice": int(parts[2]),
+                            "system": int(parts[3]),
+                            "idle": int(parts[4]),
+                            "iowait": int(parts[5]) if len(parts) > 5 else 0,
+                            "irq": int(parts[6]) if len(parts) > 6 else 0,
+                            "softirq": int(parts[7]) if len(parts) > 7 else 0,
+                        }
+                        break
+        except Exception as e:
+            cpu_error['error'] = f"Error reading CPU stat: {e}"
+        return cpu_stats
+
+    async def get_current_cpu_usage(self, proc_root="/proc/stat") -> float:
+        # Get the first reading.
+        stat1 = self.get_cpu_stat(proc_root)
+        await asyncio.sleep(1)
+        # Get the second reading.
+        stat2 = self.get_cpu_stat(proc_root)
+
+        # Sum up all CPU times for each reading.
+        total1 = sum(stat1.get(k, 0) for k in ("user", "nice", "system", "idle", "iowait", "irq", "softirq"))
+        total2 = sum(stat2.get(k, 0) for k in ("user", "nice", "system", "idle", "iowait", "irq", "softirq"))
+        idle1 = stat1.get("idle", 0) + stat1.get("iowait", 0)
+        idle2 = stat2.get("idle", 0) + stat2.get("iowait", 0)
+
+        delta_total = total2 - total1
+        delta_idle = idle2 - idle1
+
+        if delta_total == 0:
+            return 0.0
+        # CPU usage during the interval.
+        current_usage = (delta_total - delta_idle) / delta_total * 100
+        return current_usage
+
+    def get_uptime(self, proc_root="/proc/uptime"):
+        try:
+            with open(f"{proc_root}", "r") as f:
+                uptime_info = f.read().strip().split()
+                return {
+                    "uptime_seconds": float(uptime_info[0]),
+                    "idle_seconds": float(uptime_info[1])
+                }
+        except Exception as e:
+            return {"error": f"Error reading uptime: {e}"}
+
+    def format_memory_usage(self, meminfo: dict) -> str:
+        try:
+            total_str = meminfo.get("MemTotal", "0 kB").split()[0]
+            avail_str = meminfo.get("MemAvailable", "0 kB").split()[0]
+            total_kb = int(total_str)
+            avail_kb = int(avail_str)
+            used_kb = total_kb - avail_kb
+            # Convert kilobytes to gigabytes (1 GB = 1024*1024 kB)
+            used_gb = used_kb / (1024 * 1024)
+            total_gb = total_kb / (1024 * 1024)
+            return f"{used_gb:.2f} GB / {total_gb:.2f} GB"
+        except Exception as e:
+            return f"Error: {e}"
+
+    def format_uptime(self, uptime_seconds: float) -> str:
+        try:
+            total_seconds = int(uptime_seconds)
+            days = total_seconds // 86400
+            hours = (total_seconds % 86400) // 3600
+            minutes = (total_seconds % 3600) // 60
+            seconds = total_seconds % 60
+            return f"{days:02d}d:{hours:02d}h:{minutes:02d}m:{seconds:02d}s"
+        except Exception as e:
+            return f"Error: {e}"
+        
+    def get_disk_usage(self) -> str:
+        try:
+            result = subprocess.run(["df", "-h"], capture_output=True, text=True, check=True)
+            lines = result.stdout.strip().splitlines()
+            if not lines:
+                return "No disk usage data available"
+            pt = PrettyTable(["Mounted On", "Used", "Available"])
+            # Skip the header line and process data rows.
+            for line in lines[1:]:
+                row = line.strip().split(None, 5)
+                if len(row) < 6:
+                    continue
+                mounted_on = row[5]
+                if mounted_on.startswith("/proc") or mounted_on.startswith("/sys") or mounted_on.startswith("/dev"):
+                    continue
+                used = row[2]
+                available = row[3]
+                pt.add_row([mounted_on, used, available])
+            return pt.get_string()
+        except subprocess.CalledProcessError as e:
+            logger.error("Error running 'df -h': %s", e)
+            return f"Error retrieving disk usage: {e}"
+
+    @app_commands.command(name='view-stats', description='See system stats on host')
+    @app_commands.guilds(discord.Object(id=DISCORD_GUILD_ID)) # type: ignore
+    async def view_stats(self, interaction: discord.Interaction):
+        proc_root_meminfo = "/proc/meminfo"
+        proc_root_stat = "/proc/stat"
+        proc_root_uptime = "/proc/uptime"
+        meminfo = self.get_meminfo(proc_root_meminfo)
+        uptime_info = self.get_uptime(proc_root_uptime)
+
+        # Format system metrics.
+        memory_usage = self.format_memory_usage(meminfo)
+        current_cpu = await self.get_current_cpu_usage(proc_root_stat)
+        formatted_uptime = self.format_uptime(float(uptime_info.get("uptime_seconds", 0)))
+
+        system_data = {
+            "Memory Usage": memory_usage,
+            "CPU Usage": f"{current_cpu:.2f}%",
+            "Uptime": formatted_uptime
+        }
+
+        pt_sys = PrettyTable(["Metric", "Value"])
+        for metric, value in system_data.items():
+            pt_sys.add_row([metric, value])
+        system_table_str = pt_sys.get_string()
+
+        disk_usage_str = self.get_disk_usage()
+
+        system_embed = discord.Embed(
+            title="System Stats",
+            description=f"```plaintext\n{system_table_str}\n```",
+            color=discord.Color.blue()
+        )
+
+        disk_embed = discord.Embed(
+            title="Disk Usage Stats",
+            description=f"```plaintext\n{disk_usage_str}\n```",
+            color=discord.Color.green()
+        )
+
+        await interaction.response.send_message(embeds=[system_embed, disk_embed], ephemeral=True, delete_after=30)
+
+async def setup(bot: commands.Bot):
+    await bot.add_cog(ViewStats(bot))
diff --git a/src/entrypoint.sh b/src/entrypoint.sh
@@ -0,0 +1,14 @@
+#!/bin/sh
+
+if [ -n "$TZ" ]; then
+    if [ -f "/usr/share/zoneinfo/$TZ" ]; then
+        cp "/usr/share/zoneinfo/$TZ" /etc/localtime
+        echo "$TZ" > /etc/timezone
+    else
+        echo "Warning: Timezone $TZ not found, using default"
+    fi
+else
+    echo "No TZ environment variable set, using default"
+fi
+
+exec gosu nonroot "$@"
