django-cfg 1.4.114__py3-none-any.whl → 1.5.8__py3-none-any.whl

django_cfg/apps/integrations/grpc/migrations/0003_grpcserverstatus.py

@@ -0,0 +1,119 @@
+# Generated by Django 5.2.7 on 2025-11-03 08:28
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        (
+            "grpc",
+            "0002_rename_django_cfg__service_4c4a8e_idx_django_cfg__service_584308_idx_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="GRPCServerStatus",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+                    ),
+                ),
+                (
+                    "instance_id",
+                    models.CharField(
+                        db_index=True,
+                        help_text="Unique instance identifier (hostname:port:pid)",
+                        max_length=100,
+                        unique=True,
+                    ),
+                ),
+                ("host", models.CharField(help_text="Server host address", max_length=200)),
+                ("port", models.IntegerField(help_text="Server port")),
+                (
+                    "address",
+                    models.CharField(
+                        db_index=True, help_text="Full server address (host:port)", max_length=200
+                    ),
+                ),
+                ("pid", models.IntegerField(help_text="Process ID of gRPC server")),
+                ("hostname", models.CharField(help_text="Server hostname", max_length=255)),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[
+                            ("starting", "Starting"),
+                            ("running", "Running"),
+                            ("stopping", "Stopping"),
+                            ("stopped", "Stopped"),
+                            ("error", "Error"),
+                        ],
+                        db_index=True,
+                        default="starting",
+                        help_text="Current server status",
+                        max_length=20,
+                    ),
+                ),
+                (
+                    "started_at",
+                    models.DateTimeField(
+                        auto_now_add=True, db_index=True, help_text="When server started"
+                    ),
+                ),
+                (
+                    "last_heartbeat",
+                    models.DateTimeField(
+                        auto_now=True, db_index=True, help_text="Last heartbeat timestamp"
+                    ),
+                ),
+                (
+                    "stopped_at",
+                    models.DateTimeField(blank=True, help_text="When server stopped", null=True),
+                ),
+                (
+                    "max_workers",
+                    models.IntegerField(default=10, help_text="Maximum worker threads"),
+                ),
+                (
+                    "enable_reflection",
+                    models.BooleanField(default=False, help_text="Whether reflection is enabled"),
+                ),
+                (
+                    "enable_health_check",
+                    models.BooleanField(default=True, help_text="Whether health check is enabled"),
+                ),
+                (
+                    "error_message",
+                    models.TextField(
+                        blank=True, help_text="Error message if status is ERROR", null=True
+                    ),
+                ),
+                (
+                    "created_at",
+                    models.DateTimeField(auto_now_add=True, help_text="Record creation time"),
+                ),
+                (
+                    "updated_at",
+                    models.DateTimeField(auto_now=True, help_text="Record last update time"),
+                ),
+            ],
+            options={
+                "verbose_name": "gRPC Server Status",
+                "verbose_name_plural": "gRPC Server Statuses",
+                "db_table": "django_cfg_grpc_server_status",
+                "ordering": ["-started_at"],
+                "indexes": [
+                    models.Index(
+                        fields=["status", "-started_at"], name="django_cfg__status_b0ce6c_idx"
+                    ),
+                    models.Index(
+                        fields=["address", "-started_at"], name="django_cfg__address_4966eb_idx"
+                    ),
+                    models.Index(fields=["pid", "-started_at"], name="django_cfg__pid_bab561_idx"),
+                ],
+            },
+        ),
+    ]

django_cfg/apps/integrations/grpc/migrations/0004_grpcserverstatus_registered_services.py

@@ -0,0 +1,22 @@
+# Generated by Django 5.2.7 on 2025-11-03 09:25
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("grpc", "0003_grpcserverstatus"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="grpcserverstatus",
+            name="registered_services",
+            field=models.JSONField(
+                blank=True,
+                default=list,
+                help_text="List of registered service metadata (name, methods, etc.)",
+            ),
+        ),
+    ]

django_cfg/apps/integrations/grpc/models/__init__.py

@@ -0,0 +1,11 @@
+"""
+Models for gRPC app.
+"""
+
+from .grpc_request_log import GRPCRequestLog
+from .grpc_server_status import GRPCServerStatus
+
+__all__ = [
+    "GRPCRequestLog",
+    "GRPCServerStatus",
+]

django_cfg/apps/integrations/grpc/models/grpc_request_log.py

@@ -0,0 +1,219 @@
+"""
+gRPC Request Log Model.
+
+Django model for tracking gRPC requests and responses.
+Provides observability for debugging and monitoring.
+"""
+
+from django.conf import settings
+from django.db import models
+from django.utils import timezone
+
+
+class GRPCRequestLog(models.Model):
+    """
+    Log of gRPC requests and responses.
+
+    Tracks all gRPC method calls with status, timing, and error tracking.
+    Provides observability for debugging and monitoring.
+
+    Example:
+        >>> log = GRPCRequestLog.objects.create(
+        ...     request_id="abc123",
+        ...     service_name="myapp.UserService",
+        ...     method_name="GetUser",
+        ... )
+        >>> log.mark_success(duration_ms=125)
+    """
+
+    # Custom manager
+    from ..managers.grpc_request_log import GRPCRequestLogManager
+
+    objects: GRPCRequestLogManager = GRPCRequestLogManager()
+
+    class StatusChoices(models.TextChoices):
+        """Status of gRPC request."""
+
+        PENDING = "pending", "Pending"
+        SUCCESS = "success", "Success"
+        ERROR = "error", "Error"
+        CANCELLED = "cancelled", "Cancelled"
+        TIMEOUT = "timeout", "Timeout"
+
+    # Identity
+    request_id = models.CharField(
+        max_length=100,
+        unique=True,
+        db_index=True,
+        help_text="Unique request identifier (UUID)",
+    )
+
+    # gRPC details
+    service_name = models.CharField(
+        max_length=200,
+        db_index=True,
+        help_text="gRPC service name (e.g., myapp.UserService)",
+    )
+
+    method_name = models.CharField(
+        max_length=200,
+        db_index=True,
+        help_text="gRPC method name (e.g., GetUser)",
+    )
+
+    full_method = models.CharField(
+        max_length=400,
+        db_index=True,
+        help_text="Full method path (e.g., /myapp.UserService/GetUser)",
+    )
+
+    # Request/Response data
+    request_size = models.IntegerField(
+        null=True,
+        blank=True,
+        help_text="Request size in bytes",
+    )
+
+    response_size = models.IntegerField(
+        null=True,
+        blank=True,
+        help_text="Response size in bytes",
+    )
+
+    request_data = models.JSONField(
+        null=True,
+        blank=True,
+        help_text="Request data (if logged)",
+    )
+
+    response_data = models.JSONField(
+        null=True,
+        blank=True,
+        help_text="Response data (if logged)",
+    )
+
+    # Status tracking
+    status = models.CharField(
+        max_length=20,
+        choices=StatusChoices.choices,
+        default=StatusChoices.PENDING,
+        db_index=True,
+        help_text="Current status of request",
+    )
+
+    grpc_status_code = models.CharField(
+        max_length=50,
+        null=True,
+        blank=True,
+        db_index=True,
+        help_text="gRPC status code (OK, CANCELLED, INVALID_ARGUMENT, etc.)",
+    )
+
+    error_message = models.TextField(
+        null=True,
+        blank=True,
+        help_text="Error message if failed",
+    )
+
+    error_details = models.JSONField(
+        null=True,
+        blank=True,
+        help_text="Additional error details",
+    )
+
+    # Performance
+    duration_ms = models.IntegerField(
+        null=True,
+        blank=True,
+        help_text="Total duration in milliseconds",
+    )
+
+    # User context
+    user = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        related_name="grpc_request_logs",
+        help_text="Authenticated user (if applicable)",
+    )
+
+    is_authenticated = models.BooleanField(
+        default=False,
+        db_index=True,
+        help_text="Whether request was authenticated",
+    )
+
+    # Client metadata
+    client_ip = models.GenericIPAddressField(
+        null=True,
+        blank=True,
+        help_text="Client IP address",
+    )
+
+    user_agent = models.TextField(
+        null=True,
+        blank=True,
+        help_text="User agent from metadata",
+    )
+
+    peer = models.CharField(
+        max_length=200,
+        null=True,
+        blank=True,
+        help_text="gRPC peer information",
+    )
+
+    # Timestamps
+    created_at = models.DateTimeField(
+        auto_now_add=True,
+        db_index=True,
+        help_text="When request was received",
+    )
+
+    completed_at = models.DateTimeField(
+        null=True,
+        blank=True,
+        db_index=True,
+        help_text="When request completed (success/error)",
+    )
+
+    class Meta:
+        db_table = "django_cfg_grpc_request_log"
+        ordering = ["-created_at"]
+        indexes = [
+            models.Index(fields=["service_name", "-created_at"]),
+            models.Index(fields=["method_name", "-created_at"]),
+            models.Index(fields=["status", "-created_at"]),
+            models.Index(fields=["user", "-created_at"]),
+            models.Index(fields=["grpc_status_code", "-created_at"]),
+        ]
+        verbose_name = "gRPC Request Log"
+        verbose_name_plural = "gRPC Request Logs"
+
+    def __str__(self) -> str:
+        """String representation."""
+        return f"{self.full_method} ({self.request_id[:8]}...) - {self.status}"
+
+    @property
+    def is_completed(self) -> bool:
+        """Check if request is completed (any terminal status)."""
+        return self.status in [
+            self.StatusChoices.SUCCESS,
+            self.StatusChoices.ERROR,
+            self.StatusChoices.CANCELLED,
+            self.StatusChoices.TIMEOUT,
+        ]
+
+    @property
+    def is_successful(self) -> bool:
+        """Check if request was successful."""
+        return self.status == self.StatusChoices.SUCCESS
+
+    @property
+    def success_rate(self) -> float:
+        """Calculate success rate (for compatibility with stats)."""
+        return 1.0 if self.is_successful else 0.0
+
+
+__all__ = ["GRPCRequestLog"]

django_cfg/apps/integrations/grpc/models/grpc_server_status.py

@@ -0,0 +1,270 @@
+"""
+gRPC Server Status Model.
+
+Tracks the lifecycle and status of gRPC server instances.
+Provides real-time monitoring of server availability and uptime.
+"""
+
+import os
+from datetime import datetime, timedelta
+
+from django.db import models
+from django.utils import timezone
+
+
+class GRPCServerStatus(models.Model):
+    """
+    Track gRPC server status and lifecycle.
+
+    Stores information about server instances including:
+    - Start/stop times
+    - Process ID
+    - Server address and configuration
+    - Health status and heartbeats
+
+    Example:
+        >>> # Server starts
+        >>> status = GRPCServerStatus.objects.start_server(
+        ...     host="[::]",
+        ...     port=50051,
+        ...     pid=12345
+        ... )
+        >>> status.is_running
+        True
+        >>> status.uptime_seconds
+        120
+
+        >>> # Server stops
+        >>> status.stop_server()
+        >>> status.is_running
+        False
+    """
+
+    # Custom manager
+    from ..managers.grpc_server_status import GRPCServerStatusManager
+
+    objects: GRPCServerStatusManager = GRPCServerStatusManager()
+
+    class StatusChoices(models.TextChoices):
+        """Server status choices."""
+
+        STARTING = "starting", "Starting"
+        RUNNING = "running", "Running"
+        STOPPING = "stopping", "Stopping"
+        STOPPED = "stopped", "Stopped"
+        ERROR = "error", "Error"
+
+    # Identity
+    instance_id = models.CharField(
+        max_length=100,
+        unique=True,
+        db_index=True,
+        help_text="Unique instance identifier (hostname:port:pid)",
+    )
+
+    # Server configuration
+    host = models.CharField(
+        max_length=200,
+        help_text="Server host address",
+    )
+
+    port = models.IntegerField(
+        help_text="Server port",
+    )
+
+    address = models.CharField(
+        max_length=200,
+        db_index=True,
+        help_text="Full server address (host:port)",
+    )
+
+    # Process information
+    pid = models.IntegerField(
+        help_text="Process ID of gRPC server",
+    )
+
+    hostname = models.CharField(
+        max_length=255,
+        help_text="Server hostname",
+    )
+
+    # Status tracking
+    status = models.CharField(
+        max_length=20,
+        choices=StatusChoices.choices,
+        default=StatusChoices.STARTING,
+        db_index=True,
+        help_text="Current server status",
+    )
+
+    # Lifecycle timestamps
+    started_at = models.DateTimeField(
+        auto_now_add=True,
+        db_index=True,
+        help_text="When server started",
+    )
+
+    last_heartbeat = models.DateTimeField(
+        auto_now=True,
+        db_index=True,
+        help_text="Last heartbeat timestamp",
+    )
+
+    stopped_at = models.DateTimeField(
+        null=True,
+        blank=True,
+        help_text="When server stopped",
+    )
+
+    # Configuration snapshot
+    max_workers = models.IntegerField(
+        default=10,
+        help_text="Maximum worker threads",
+    )
+
+    enable_reflection = models.BooleanField(
+        default=False,
+        help_text="Whether reflection is enabled",
+    )
+
+    # Registered services (stored as JSON)
+    registered_services = models.JSONField(
+        default=list,
+        blank=True,
+        help_text="List of registered service metadata (name, methods, etc.)",
+    )
+
+    enable_health_check = models.BooleanField(
+        default=True,
+        help_text="Whether health check is enabled",
+    )
+
+    # Error tracking
+    error_message = models.TextField(
+        null=True,
+        blank=True,
+        help_text="Error message if status is ERROR",
+    )
+
+    # Metadata
+    created_at = models.DateTimeField(
+        auto_now_add=True,
+        help_text="Record creation time",
+    )
+
+    updated_at = models.DateTimeField(
+        auto_now=True,
+        help_text="Record last update time",
+    )
+
+    class Meta:
+        db_table = "django_cfg_grpc_server_status"
+        ordering = ["-started_at"]
+        indexes = [
+            models.Index(fields=["status", "-started_at"]),
+            models.Index(fields=["address", "-started_at"]),
+            models.Index(fields=["pid", "-started_at"]),
+        ]
+        verbose_name = "gRPC Server Status"
+        verbose_name_plural = "gRPC Server Statuses"
+
+    def __str__(self) -> str:
+        """String representation."""
+        return f"gRPC Server {self.address} ({self.status}) - PID {self.pid}"
+
+    @property
+    def is_running(self) -> bool:
+        """Check if server is currently running."""
+        if self.status not in [self.StatusChoices.RUNNING, self.StatusChoices.STARTING]:
+            return False
+
+        # Check if process is still alive
+        if not self._is_process_alive():
+            return False
+
+        # Check heartbeat (consider dead if no heartbeat in 5 minutes)
+        if self.last_heartbeat:
+            time_since_heartbeat = timezone.now() - self.last_heartbeat
+            if time_since_heartbeat > timedelta(minutes=5):
+                return False
+
+        return True
+
+    @property
+    def uptime_seconds(self) -> int:
+        """Calculate server uptime in seconds."""
+        if not self.is_running or not self.started_at:
+            return 0
+
+        if self.stopped_at:
+            delta = self.stopped_at - self.started_at
+        else:
+            delta = timezone.now() - self.started_at
+
+        return int(delta.total_seconds())
+
+    @property
+    def uptime_display(self) -> str:
+        """Human-readable uptime."""
+        seconds = self.uptime_seconds
+        if seconds == 0:
+            return "Not running"
+
+        days, remainder = divmod(seconds, 86400)
+        hours, remainder = divmod(remainder, 3600)
+        minutes, seconds = divmod(remainder, 60)
+
+        parts = []
+        if days > 0:
+            parts.append(f"{days}d")
+        if hours > 0:
+            parts.append(f"{hours}h")
+        if minutes > 0:
+            parts.append(f"{minutes}m")
+        if seconds > 0 or not parts:
+            parts.append(f"{seconds}s")
+
+        return " ".join(parts)
+
+    def _is_process_alive(self) -> bool:
+        """Check if the process is still running."""
+        try:
+            # Send signal 0 to check if process exists
+            os.kill(self.pid, 0)
+            return True
+        except (OSError, ProcessLookupError):
+            return False
+
+    def mark_running(self):
+        """Mark server as running."""
+        self.status = self.StatusChoices.RUNNING
+        self.error_message = None
+        self.save(update_fields=["status", "error_message", "updated_at", "last_heartbeat"])
+
+    def mark_stopping(self):
+        """Mark server as stopping."""
+        self.status = self.StatusChoices.STOPPING
+        self.save(update_fields=["status", "updated_at", "last_heartbeat"])
+
+    def mark_stopped(self, error_message: str = None):
+        """Mark server as stopped."""
+        self.status = self.StatusChoices.STOPPED
+        self.stopped_at = timezone.now()
+        if error_message:
+            self.error_message = error_message
+        self.save(update_fields=["status", "stopped_at", "error_message", "updated_at"])
+
+    def mark_error(self, error_message: str):
+        """Mark server as error."""
+        self.status = self.StatusChoices.ERROR
+        self.error_message = error_message
+        self.stopped_at = timezone.now()
+        self.save(update_fields=["status", "error_message", "stopped_at", "updated_at"])
+
+    def heartbeat(self):
+        """Update heartbeat timestamp."""
+        self.last_heartbeat = timezone.now()
+        self.save(update_fields=["last_heartbeat", "updated_at"])
+
+
+__all__ = ["GRPCServerStatus"]

django_cfg/apps/integrations/grpc/serializers/__init__.py

@@ -0,0 +1,67 @@
+"""
+Pydantic serializers for gRPC monitoring API.
+"""
+
+from .charts import (
+    DashboardChartsSerializer,
+    ErrorDistributionChartSerializer,
+    RequestVolumeChartSerializer,
+    ResponseTimeChartSerializer,
+    ServerLifecycleChartSerializer,
+    ServerUptimeChartSerializer,
+    ServiceActivityChartSerializer,
+)
+from .config import GRPCConfigSerializer, GRPCServerInfoSerializer
+from .health import GRPCHealthCheckSerializer
+from .requests import RecentRequestsSerializer
+from .service_registry import (
+    MethodDetailSerializer,
+    ServiceDetailSerializer,
+    ServiceListSerializer as ServiceRegistryListSerializer,
+    ServiceMethodsSerializer,
+)
+from .services import (
+    MethodListSerializer,
+    MethodStatsSerializer,
+    MonitoringServiceStatsSerializer,
+    ServiceListSerializer,
+)
+from .stats import GRPCOverviewStatsSerializer
+from .testing import (
+    GRPCCallRequestSerializer,
+    GRPCCallResponseSerializer,
+    GRPCExamplesListSerializer,
+    GRPCTestLogsSerializer,
+)
+
+__all__ = [
+    # Health & Stats
+    "GRPCHealthCheckSerializer",
+    "GRPCOverviewStatsSerializer",
+    "RecentRequestsSerializer",
+    "MonitoringServiceStatsSerializer",
+    "ServiceListSerializer",
+    "MethodStatsSerializer",
+    "MethodListSerializer",
+    # Config
+    "GRPCConfigSerializer",
+    "GRPCServerInfoSerializer",
+    # Service Registry
+    "ServiceRegistryListSerializer",
+    "ServiceDetailSerializer",
+    "ServiceMethodsSerializer",
+    "MethodDetailSerializer",
+    # Testing
+    "GRPCExamplesListSerializer",
+    "GRPCTestLogsSerializer",
+    "GRPCCallRequestSerializer",
+    "GRPCCallResponseSerializer",
+    # Charts
+    "ServerUptimeChartSerializer",
+    "RequestVolumeChartSerializer",
+    "ResponseTimeChartSerializer",
+    "ServiceActivityChartSerializer",
+    "ServerLifecycleChartSerializer",
+    "ErrorDistributionChartSerializer",
+    "DashboardChartsSerializer",
+]