dStats 0.1.0__py3-none-any.whl

dStats/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for dStats project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "dStats.settings")
+
+application = get_asgi_application()

dStats/settings.py

@@ -0,0 +1,128 @@
+"""
+Django settings for dStats project.
+
+Generated by 'django-admin startproject' using Django 5.1.4.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.1/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-z)f1y6v3$3fa1=pbz2_mv&uhx=#cne(@=vy*)$1j-h(fyit+ri"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = ["*"]
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "daphne",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "dStats",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "dStats.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+# WSGI_APPLICATION = "dStats.wsgi.application"
+ASGI_APPLICATION = "dStats.asgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/5.1/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+MIGRATION_MODULES = {
+    "dStats": None,  # Disable migrations for dStats app
+}
+
+# Password validation
+# https://docs.djangoproject.com/en/5.1/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.1/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.1/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

dStats/urls.py

@@ -0,0 +1,24 @@
+"""
+URL configuration for dStats project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/5.1/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+
+from django.contrib import admin
+from django.urls import path
+from .views import DockerStatsView
+
+urlpatterns = [
+    path("", DockerStatsView.as_view(), name="stats"),
+]

dStats/views.py

@@ -0,0 +1,308 @@
+# views.py
+import docker
+import json
+from dataclasses import asdict, dataclass
+from typing import List, Dict
+import random
+from graphviz import Graph
+import base64
+from io import BytesIO
+from django.views.generic import TemplateView
+from django.http import JsonResponse
+from django.utils.decorators import method_decorator
+from django.views.decorators.csrf import csrf_exempt
+
+
+# Keep the existing dataclass definitions
+@dataclass
+class Network:
+    name: str
+    gateway: str
+    internal: bool
+    isolated: bool
+    color: str
+
+
+@dataclass
+class Interface:
+    endpoint_id: str
+    address: str
+    aliases: List[str]
+
+
+@dataclass
+class PortMapping:
+    internal: int
+    external: int
+    protocol: str
+
+
+@dataclass
+class Container:
+    container_id: str
+    name: str
+    interfaces: List[Interface]
+    ports: List[PortMapping]
+
+
+@dataclass
+class Link:
+    container_id: str
+    endpoint_id: str
+    network_name: str
+
+
+# Keep the existing color definitions
+COLORS = [
+    "#1f78b4",
+    "#33a02c",
+    "#e31a1c",
+    "#ff7f00",
+    "#6a3d9a",
+    "#b15928",
+    "#a6cee3",
+    "#b2df8a",
+    "#fdbf6f",
+    "#cab2d6",
+    "#ffff99",
+]
+color_index = 0
+
+
+def get_unique_color() -> str:
+    global color_index
+    if color_index < len(COLORS):
+        c = COLORS[color_index]
+        color_index += 1
+    else:
+        c = "#%06x" % random.randint(0, 0xFFFFFF)
+    return c
+
+
+class DockerStatsView(TemplateView):
+    template_name = "dStats/index.html"
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        return context
+
+    def generate_network_graph(self):
+        client = docker.from_env()
+        networks = self.get_networks(client)
+        containers, links = self.get_containers(client)
+
+        g = Graph(
+            comment="Docker Network Graph",
+            engine="sfdp",
+            format="png",
+            graph_attr={
+                "splines": "true",
+                "overlap": "false",
+                "nodesep": "2.0",
+                "ranksep": "2.0",
+            },
+        )
+
+        # Draw networks and containers
+        for network in networks.values():
+            self.draw_network(g, network)
+
+        for container in containers:
+            self.draw_container(g, container)
+
+        for link in links:
+            if link.network_name != "none":
+                self.draw_link(g, networks, link)
+
+        # Convert graph to base64 image
+        img_data = g.pipe()
+        encoded_img = base64.b64encode(img_data).decode("utf-8")
+        return encoded_img
+
+    def get_networks(self, client):
+        networks = {}
+        for net in sorted(client.networks.list(), key=lambda k: k.name):
+            try:
+                config = net.attrs["IPAM"]["Config"]
+                gateway = config[0]["Subnet"] if config else "0.0.0.0"
+            except (KeyError, IndexError):
+                continue
+
+            internal = net.attrs.get("Internal", False)
+            isolated = (
+                net.attrs.get("Options", {}).get(
+                    "com.docker.network.bridge.enable_icc", "true"
+                )
+                == "false"
+            )
+
+            color = get_unique_color()
+            networks[net.name] = Network(net.name, gateway, internal, isolated, color)
+
+        networks["host"] = Network("host", "0.0.0.0", False, False, "#808080")
+        return networks
+
+    def get_containers(self, client):
+        containers = []
+        links = []
+
+        for container in client.containers.list():
+            interfaces = []
+            ports = []
+
+            for net_name, net_info in container.attrs["NetworkSettings"][
+                "Networks"
+            ].items():
+                endpoint_id = net_info["EndpointID"]
+                aliases = net_info.get("Aliases", [])
+                interfaces.append(
+                    Interface(endpoint_id, net_info["IPAddress"], aliases)
+                )
+                links.append(Link(container.id, endpoint_id, net_name))
+
+            port_mappings = container.attrs["NetworkSettings"]["Ports"]
+            if port_mappings:
+                for container_port, host_ports in port_mappings.items():
+                    if host_ports:
+                        for host_port in host_ports:
+                            internal_port, protocol = container_port.split("/")
+                            ports.append(
+                                PortMapping(
+                                    int(internal_port),
+                                    int(host_port["HostPort"]),
+                                    protocol,
+                                )
+                            )
+
+            containers.append(
+                Container(container.id, container.name, interfaces, ports)
+            )
+
+        return containers, links
+
+    def draw_network(self, g: Graph, net: Network):
+        label = f"{{<gw_iface> {net.gateway} | {net.name}"
+        if net.internal:
+            label += " | Internal"
+        if net.isolated:
+            label += " | Containers isolated"
+        label += "}"
+
+        g.node(
+            f"network_{net.name}",
+            shape="record",
+            label=label,
+            fillcolor=net.color,
+            style="filled",
+        )
+
+    def draw_container(self, g: Graph, c: Container):
+        iface_labels = []
+        for iface in c.interfaces:
+            if iface.aliases:
+                iface_labels.append(f"{iface.address} ({', '.join(iface.aliases)})")
+            else:
+                iface_labels.append(iface.address)
+
+        port_labels = []
+        for port in c.ports:
+            port_labels.append(f"{port.internal}->{port.external}/{port.protocol}")
+
+        label = f"{c.name}\\n"
+        label += "Interfaces:\\n" + "\\n".join(iface_labels)
+        if port_labels:
+            label += "\\nPorts:\\n" + "\\n".join(port_labels)
+
+        g.node(
+            f"container_{c.container_id}",
+            shape="box",
+            label=label,
+            fillcolor="#ff9999",
+            style="filled",
+        )
+
+    def draw_link(self, g: Graph, networks: Dict[str, Network], link: Link):
+        g.edge(
+            f"container_{link.container_id}",
+            f"network_{link.network_name}",
+            color=networks[link.network_name].color,
+        )
+
+    @method_decorator(csrf_exempt)
+    def dispatch(self, *args, **kwargs):
+        return super().dispatch(*args, **kwargs)
+
+    def get_container_stats(self):
+        client = docker.from_env()
+        stats = []
+
+        for container in client.containers.list():
+            try:
+                container_stats = container.stats(stream=False)
+
+                # Calculate CPU percentage
+                cpu_total = float(
+                    container_stats["cpu_stats"]["cpu_usage"]["total_usage"]
+                )
+                cpu_delta = cpu_total - float(
+                    container_stats["precpu_stats"]["cpu_usage"]["total_usage"]
+                )
+                system_delta = float(
+                    container_stats["cpu_stats"]["system_cpu_usage"]
+                ) - float(container_stats["precpu_stats"]["system_cpu_usage"])
+                online_cpus = container_stats["cpu_stats"].get(
+                    "online_cpus",
+                    len(
+                        container_stats["cpu_stats"]["cpu_usage"].get(
+                            "percpu_usage", [1]
+                        )
+                    ),
+                )
+
+                cpu_percent = 0.0
+                if system_delta > 0.0:
+                    cpu_percent = (cpu_delta / system_delta) * 100.0 * online_cpus
+
+                # Memory usage
+                mem_usage = container_stats["memory_stats"].get("usage", 0)
+                mem_limit = container_stats["memory_stats"].get("limit", 1)
+                mem_percent = (mem_usage / mem_limit) * 100.0
+                mem_mb = mem_usage / (1024 * 1024)
+
+                # Network usage
+                net_usage = container_stats.get("networks", {})
+                network_in = sum([net.get("rx_bytes", 0) for net in net_usage.values()])
+                network_out = sum(
+                    [net.get("tx_bytes", 0) for net in net_usage.values()]
+                )
+
+                stats.append(
+                    {
+                        "name": container.name,
+                        "cpu_percent": f"{cpu_percent:.2f}%",
+                        "memory_usage": f"{mem_mb:.2f} MB ({mem_percent:.2f}%)",
+                        "network_io": f"IN: {network_in/1024:.2f} KB / OUT: {network_out/1024:.2f} KB",
+                    }
+                )
+
+            except Exception as e:
+                stats.append(
+                    {
+                        "name": container.name,
+                        "cpu_percent": "N/A",
+                        "memory_usage": "N/A",
+                        "network_io": "N/A",
+                    }
+                )
+
+        return stats
+
+    def get(self, request, *args, **kwargs):
+        if request.headers.get("X-Requested-With") == "XMLHttpRequest":
+            if request.GET.get("type") == "stats":
+                return JsonResponse({"stats": self.get_container_stats()})
+            elif request.GET.get("type") == "graph":
+                return JsonResponse({"graph": self.generate_network_graph()})
+
+        context = self.get_context_data(**kwargs)
+        return self.render_to_response(context)

dStats/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for dStats project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "dStats.settings")
+
+application = get_wsgi_application()

dStats-0.1.0.dist-info/LICENSE

@@ -0,0 +1,13 @@
+            DO WHAT THE F*** YOU WANT TO PUBLIC LICENSE
+                        Version 2, December 2004
+
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+            DO WHAT THE F*** YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE F*** YOU WANT TO.

dStats-0.1.0.dist-info/METADATA

@@ -0,0 +1,158 @@
+Metadata-Version: 2.2
+Name: dStats
+Version: 0.1.0
+Summary: A real-time web-based monitoring tool that provides performance stats for Docker containers and visualizes their network connectivity graph
+Home-page: https://github.com/Arifcse21/dStats
+Author: Abdullah Al Arif
+Author-email: arifcse21@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12.3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=5.1.4
+Requires-Dist: graphviz>=0.20.3
+Requires-Dist: daphne>=4.1.2
+Requires-Dist: requests>=2.32.3
+Requires-Dist: black>=24.10.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+# **dStats**
+
+**dStats** is a real-time web-based monitoring tool that provides performance stats for Docker containers and visualizes their network connectivity graph.
+
+---
+
+## **Deploy Container Directly**
+Pull and run the container from Docker Hub:
+
+```bash
+docker pull arifcse21/dstats:latest
+```
+
+Run the container:
+
+```bash
+docker run -d --name docker-stats-web --privileged \
+-v /var/run/docker.sock:/var/run/docker.sock \
+-p 2743:2743 arifcse21/dstats:latest
+```
+
+---
+
+## **Clone the Repository**
+
+If you’d like to explore or modify the project, start by cloning the repository:
+
+```bash
+git clone https://github.com/Arifcse21/dStats.git
+cd dStats
+```
+
+---
+
+## **Run with Docker Manually**
+
+Build the Docker image locally:
+
+```bash
+docker build -t dstats:latest .
+```
+
+Run the container:
+
+```bash
+docker run -d --name docker-stats-web --privileged \
+-v /var/run/docker.sock:/var/run/docker.sock \
+-p 2743:2743 dstats:latest
+```
+
+---
+
+## **Run with Docker Compose**
+
+Use Docker Compose for easier setup and teardown:
+
+1. Build and start the services:
+
+   ```bash
+   docker compose up -d
+   ```
+
+2. Stop and clean up the services:
+
+   ```bash
+   docker compose down --remove-orphans --rmi all
+   ```
+
+---
+
+## **Access the Application**
+
+- Open your browser and go to:  
+  **http://localhost:2743**
+
+Here, you’ll find:
+1. **Container Stats:** Real-time CPU, memory, and network I/O usage.
+2. **Network Graph:** Visualization of container interconnections.
+
+---
+
+## **Contribute to dStats Project**
+
+Thank you for considering contributing to dStats! We appreciate all efforts, big or small, to help improve the project.
+
+### **How to Contribute**
+
+We believe collaboration is key to building great software. Here’s how you can get involved:
+
+1. **Report Issues**  
+   Found a bug? Have a feature request? Open an issue [here](https://github.com/Arifcse21/dStats/issues).
+
+2. **Suggest Enhancements**  
+   Have an idea for improvement? Share it by opening a discussion or issue.
+
+3. **Contribute Code**  
+   Whether it’s fixing bugs, adding features, or enhancing documentation, here’s how to start:
+   - Fork this repository.
+   - Clone your fork:  
+     ```bash
+     git clone https://github.com/your-username/dStats.git
+     cd dStats
+     ```
+   - Create a branch:  
+     ```bash
+     git checkout -b my-feature
+     ```
+   - Commit your changes:  
+     ```bash
+     git commit -m "Add my feature"
+     ```
+   - Push your branch:  
+     ```bash
+     git push origin my-feature
+     ```
+   - Open a pull request on GitHub.
+
+4. **Improve Documentation**  
+   Good documentation helps everyone. Spot typos? Want to clarify something? Update the `README.md` or other docs and send us a PR.
+
+---
+
+### **Need Help?**
+
+Feel free to reach out by opening a discussion on the repository. We’re here to help!  
+
+Thank you for being part of this project. Together, we can make dStats even better. 🎉
+
+--- 

dStats-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+dStats/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dStats/asgi.py,sha256=MSQjGWX7GgrxE5_GvTsz8PRIiXwgCcx3PIkkUsQ1_tU,389
+dStats/settings.py,sha256=D73YEbwOWk54QosU21YvjSTVJvxkHTqUXiel76Nxpl4,3379
+dStats/urls.py,sha256=R7CHnIif6hO8wr-C_HH7ew3-ZT8KtnE31YO9XT1Q8kU,816
+dStats/views.py,sha256=mjxkwpwwZcS2rAemyaLzfrEOx3WmMHTj3LFGW5ruUwI,9427
+dStats/wsgi.py,sha256=5CVIfhfO5NEUV3gXOmrPPjLNkeararRk6fCzkghNI_Q,389
+dStats-0.1.0.dist-info/LICENSE,sha256=qjNhYHFWgrHF5vENj51WBRO85HtL38pwfTIg8huGj08,483
+dStats-0.1.0.dist-info/METADATA,sha256=dkOcRoxHFYkSXru_0xTWsarzPLLS8XdZIHlr7Qsn8_c,3805
+dStats-0.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+dStats-0.1.0.dist-info/top_level.txt,sha256=ZqX7qLq-LiHI4j3UAw9S9kHfeD094Jtxc5sdnrcNhU8,7
+dStats-0.1.0.dist-info/RECORD,,

dStats-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

dStats-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+dStats