django-cfg 1.4.119__py3-none-any.whl → 1.5.1__py3-none-any.whl

django_cfg/apps/grpc/migrations/0002_rename_django_cfg__service_4c4a8e_idx_django_cfg__service_584308_idx_and_more.py

@@ -0,0 +1,38 @@
+# Generated by Django 5.2.7 on 2025-11-01 13:48
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("grpc", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.RenameIndex(
+            model_name="grpcrequestlog",
+            new_name="django_cfg__service_584308_idx",
+            old_name="django_cfg__service_4c4a8e_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="grpcrequestlog",
+            new_name="django_cfg__method__5e704d_idx",
+            old_name="django_cfg__method__8e1a7c_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="grpcrequestlog",
+            new_name="django_cfg__status_a564a8_idx",
+            old_name="django_cfg__status_f3d9a1_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="grpcrequestlog",
+            new_name="django_cfg__user_id_f2ada7_idx",
+            old_name="django_cfg__user_id_9c2b4f_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="grpcrequestlog",
+            new_name="django_cfg__grpc_st_fea09f_idx",
+            old_name="django_cfg__grpc_st_a7e5c2_idx",
+        ),
+    ]

django_cfg/apps/grpc/models/__init__.py

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

django_cfg/apps/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/grpc/serializers/__init__.py

@@ -0,0 +1,23 @@
+"""
+Pydantic serializers for gRPC monitoring API.
+"""
+
+from .health import HealthCheckSerializer
+from .requests import RecentRequestsSerializer
+from .services import (
+    MethodListSerializer,
+    MethodStatsSerializer,
+    ServiceListSerializer,
+    ServiceStatsSerializer,
+)
+from .stats import OverviewStatsSerializer
+
+__all__ = [
+    "HealthCheckSerializer",
+    "OverviewStatsSerializer",
+    "RecentRequestsSerializer",
+    "ServiceStatsSerializer",
+    "ServiceListSerializer",
+    "MethodStatsSerializer",
+    "MethodListSerializer",
+]

django_cfg/apps/grpc/serializers/health.py

@@ -0,0 +1,18 @@
+"""
+Health check serializer for gRPC monitoring API.
+"""
+
+from pydantic import BaseModel, Field
+
+
+class HealthCheckSerializer(BaseModel):
+    """Health check response."""
+
+    status: str = Field(description="Health status: healthy or unhealthy")
+    server_host: str = Field(description="Configured gRPC server host")
+    server_port: int = Field(description="Configured gRPC server port")
+    enabled: bool = Field(description="Whether gRPC is enabled")
+    timestamp: str = Field(description="Current timestamp")
+
+
+__all__ = ["HealthCheckSerializer"]

django_cfg/apps/grpc/serializers/requests.py

@@ -0,0 +1,18 @@
+"""
+Requests serializers for gRPC monitoring API.
+"""
+
+from pydantic import BaseModel, Field
+
+
+class RecentRequestsSerializer(BaseModel):
+    """Recent gRPC requests list."""
+
+    requests: list[dict] = Field(description="List of recent requests")
+    count: int = Field(description="Number of requests returned")
+    total_available: int = Field(description="Total requests available")
+    offset: int = Field(default=0, description="Current offset for pagination")
+    has_more: bool = Field(default=False, description="Whether more results are available")
+
+
+__all__ = ["RecentRequestsSerializer"]

django_cfg/apps/grpc/serializers/services.py

@@ -0,0 +1,50 @@
+"""
+Services serializers for gRPC monitoring API.
+"""
+
+from pydantic import BaseModel, Field
+
+
+class ServiceStatsSerializer(BaseModel):
+    """Statistics for a single gRPC service."""
+
+    service_name: str = Field(description="Service name")
+    total: int = Field(description="Total requests")
+    successful: int = Field(description="Successful requests")
+    errors: int = Field(description="Error requests")
+    avg_duration_ms: float = Field(description="Average duration")
+    last_activity_at: str | None = Field(description="Last activity timestamp")
+
+
+class ServiceListSerializer(BaseModel):
+    """List of gRPC services with statistics."""
+
+    services: list[ServiceStatsSerializer] = Field(description="Service statistics")
+    total_services: int = Field(description="Total number of services")
+
+
+class MethodStatsSerializer(BaseModel):
+    """Statistics for a single gRPC method."""
+
+    method_name: str = Field(description="Method name")
+    service_name: str = Field(description="Service name")
+    total: int = Field(description="Total requests")
+    successful: int = Field(description="Successful requests")
+    errors: int = Field(description="Error requests")
+    avg_duration_ms: float = Field(description="Average duration")
+    last_activity_at: str | None = Field(description="Last activity timestamp")
+
+
+class MethodListSerializer(BaseModel):
+    """List of gRPC methods with statistics."""
+
+    methods: list[MethodStatsSerializer] = Field(description="Method statistics")
+    total_methods: int = Field(description="Total number of methods")
+
+
+__all__ = [
+    "ServiceStatsSerializer",
+    "ServiceListSerializer",
+    "MethodStatsSerializer",
+    "MethodListSerializer",
+]

django_cfg/apps/grpc/serializers/stats.py

@@ -0,0 +1,22 @@
+"""
+Statistics serializers for gRPC monitoring API.
+"""
+
+from pydantic import BaseModel, Field
+
+
+class OverviewStatsSerializer(BaseModel):
+    """Overview statistics for gRPC requests."""
+
+    total: int = Field(description="Total requests in period")
+    successful: int = Field(description="Successful requests")
+    errors: int = Field(description="Error requests")
+    cancelled: int = Field(description="Cancelled requests")
+    timeout: int = Field(description="Timeout requests")
+    success_rate: float = Field(description="Success rate percentage")
+    avg_duration_ms: float = Field(description="Average duration in milliseconds")
+    p95_duration_ms: float | None = Field(description="95th percentile duration in milliseconds")
+    period_hours: int = Field(description="Statistics period in hours")
+
+
+__all__ = ["OverviewStatsSerializer"]

django_cfg/apps/grpc/services/__init__.py

@@ -0,0 +1,16 @@
+"""
+gRPC services utilities.
+
+Provides service discovery and base classes for gRPC services.
+"""
+
+from .base import AuthRequiredService, BaseService, ReadOnlyService
+from .discovery import ServiceDiscovery, discover_and_register_services
+
+__all__ = [
+    "BaseService",
+    "ReadOnlyService",
+    "AuthRequiredService",
+    "ServiceDiscovery",
+    "discover_and_register_services",
+]