# penekhun/springdog architecture

> Architecture diagram of the GitHub repository penekhun/springdog, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/penekhun/springdog
- Repository: https://github.com/penekhun/springdog

## Overview

##### Main Components Identification

a) Core Modules:
- springdog-agent: Web interface and API endpoints
- springdog-manager: Core management functionality
- springdog-domain: Business logic and domain models
- springdog-storage: Data persistence layer
- springdog-notification: Email notification system
- springdog-autoconfigure: Spring Boot auto-configuration
- springdog-shared: Shared utilities and DTOs

**[Client Application] --> [Springdog Agent Layer]**

- v
**[Security Layer] <--> [Core Management Layer] <--> [Notification System]**

- v
**[Domain Layer] <--> [Storage Layer] --> [Database]**

##### Component Details

- Host Spring Boot Application
- Email Server (SMTP)
- Database System

b) Internal Components (solid rectangles):
- Agent Module (UI/API Gateway)
- Core Modules (Management, Domain, Storage)
- Notification System

##### Data Flow Representation

a) Primary Flows:
- Request Flow: Client -> Agent -> Management -> Domain -> Storage
- Monitoring Flow: System Metrics -> Manager -> Notification
- Rate Limiting Flow: Requests -> Security Filter -> Rate Limit Rules

b) Secondary Flows:
- Error Tracing: Exceptions -> Error Collector -> Storage
- Metrics Collection: Endpoints -> Metrics Collector -> Storage

##### Key Features Visualization

a) Monitoring Features:
- System Resource Monitoring
- Endpoint Performance Tracking
- Error Tracing System

b) Security Features:
- Rate Limiting
- Access Control
- IP Filtering

##### Integration Points

Integration points with:
- Spring Security
- Spring MVC
- Email System
- Database (Cayenne ORM)

##### Additional Elements

Include:
- Version compatibility (Java 17+, Spring Boot 3.x)
- Configuration properties
- Security boundaries

##### Technical Details

Annotations for:
- Required dependencies
- Configuration options
- Security settings
- Integration points

Remember to include a note about the @SpringDogEnable annotation as the primary integration point for client applications.

This system design should help engineers understand both the high-level architecture and the detailed interactions between components while highlighting the security and monitoring capabilities of the Springdog library.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef external fill:#f0f0f0,stroke-dasharray: 5 5
    classDef core fill:#b3d1ff
    classDef security fill:#90EE90
    classDef monitoring fill:#FFE5B4
    classDef storage fill:#E6E6FA
    classDef notification fill:#FFC0CB

    %% External Systems
    Client["Client Application"]:::external
    DB[(Database)]:::external
    SMTP["Email Server (SMTP)"]:::external

    %% Main Layers
    subgraph AgentLayer["Agent Layer"]
        WebAPI["Web Interface/API"]:::core
        SecConfig["Security Configuration"]:::security
    end

    subgraph CoreLayer["Core Management Layer"]
        Manager["Core Management"]:::core
        AutoConfig["Auto Configuration"]:::core
        Shared["Shared Components"]:::core
    end

    subgraph SecurityLayer["Security Features"]
        RateLimit["Rate Limiting"]:::security
        IPFilter["IP Filtering"]:::security
        AccessControl["Access Control"]:::security
    end

    subgraph MonitoringLayer["Monitoring Features"]
        ErrorTrace["Error Tracing"]:::monitoring
        SysMon["System Monitoring"]:::monitoring
        Metrics["Endpoint Metrics"]:::monitoring
    end

    subgraph DomainLayer["Domain Layer"]
        Domain["Domain Logic"]:::core
    end

    subgraph StorageLayer["Storage Layer"]
        Storage["Storage Layer"]:::storage
        DBConfig["Database Configuration"]:::storage
    end

    subgraph NotificationLayer["Notification Layer"]
        Notify["Notification System"]:::notification
    end

    %% Connections
    Client --> WebAPI
    WebAPI --> Manager
    Manager --> Domain
    Domain --> Storage
    Storage --> DB
    Manager --> Notify
    Notify --> SMTP
    
    WebAPI --> SecurityLayer
    SecurityLayer --> Manager
    Manager --> MonitoringLayer
    MonitoringLayer --> Storage

    %% Click Events
    click WebAPI "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-agent/src/main/java/org/easypeelsecurity/springdog/agent/"
    click Manager "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-manager/src/main/java/org/easypeelsecurity/springdog/manager/"
    click Domain "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-domain/src/main/java/org/easypeelsecurity/springdog/domain/"
    click Storage "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-storage/src/main/java/org/easypeelsecurity/springdog/storage/"
    click Notify "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-notification/src/main/java/org/easypeelsecurity/springdog/notification/"
    click AutoConfig "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-autoconfigure/src/main/java/org/easypeelsecurity/springdog/autoconfigure/"
    click Shared "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-shared/src/main/java/org/easypeelsecurity/springdog/shared/"
    click RateLimit "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-domain/src/main/java/org/easypeelsecurity/springdog/domain/ratelimit/"
    click ErrorTrace "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-domain/src/main/java/org/easypeelsecurity/springdog/domain/errortracing/"
    click SysMon "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-domain/src/main/java/org/easypeelsecurity/springdog/domain/statistics/"
    click SecConfig "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-agent/src/main/java/org/easypeelsecurity/springdog/agent/security/"
    click DBConfig "https://github.com/PENEKhun/springdog/tree/main/springdog-project/springdog-storage/src/main/resources/springdog-db/"

    %% Legend
    subgraph Legend
        L1["External System"]:::external
        L2["Core Component"]:::core
        L3["Security Feature"]:::security
        L4["Monitoring Feature"]:::monitoring
        L5["Storage Component"]:::storage
        L6["Notification Component"]:::notification
    end
```
