# spatie/laravel-schedule-monitor architecture

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

- Interactive diagram: https://gitdiagram.com/spatie/laravel-schedule-monitor
- Repository: https://github.com/spatie/laravel-schedule-monitor

## Overview

##### Main Components

a. Core Components:
- Schedule Monitor Service (Central Component)
- Database Storage Layer
- Command Interface Layer
- Oh Dear Integration Service
- Event Handling System
- Task Monitoring Engine

b. External Systems:
- Laravel Application (Host System)
- Oh Dear API Service
- Database System

##### Component Relationships

**[Laravel Application] ←→ [Schedule Monitor Service]**
- ↓
**[Command Interface] → [Task Monitoring Engine]**
- ↓
**[Event Handlers] → [Database Storage]**
- ↓
**[Oh Dear Integration] → [Oh Dear API]**

##### Detailed Component Breakdown

a. Schedule Monitor Service:
- Connection to Models (MonitoredScheduledTask, MonitoredScheduledTaskLogItem)
- Task Factory and Task Types (Command, Job, Shell, Closure)

b. Database Layer:
- Monitored Tasks Table
- Log Items Table
- Task Metadata Storage

c. Command Interface:
- Command
- Sync Command
- Verify Command

d. Oh Dear Integration:
- Payload Factory
- Different Payload Types (Starting, Finished, Failed)
- Queue System for Oh Dear Pings

##### Data Flow Indicators

- Task Registration Flow
- Monitoring Flow
- Notification Flow
- Logging Flow

##### Implementation Details

- Service Provider Integration
- Model Relationships
- Event Subscription System
- Queue Management for Oh Dear Notifications

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Core System"
        SMS["Schedule Monitor Service"]:::core
        TME["Task Monitoring Engine"]:::core
        TaskFactory["Task Factory"]:::core
    end

    subgraph "Task Types"
        CommandTask["Command Task"]:::task
        JobTask["Job Task"]:::task
        ShellTask["Shell Task"]:::task
        ClosureTask["Closure Task"]:::task
    end

    subgraph "Database Layer"
        DB[(Database)]:::db
        MonitoredTask["Monitored Tasks Table"]:::db
        LogItems["Log Items Table"]:::db
    end

    subgraph "Command Interface"
        ListCmd["List Command"]:::cmd
        SyncCmd["Sync Command"]:::cmd
        VerifyCmd["Verify Command"]:::cmd
    end

    subgraph "Event System"
        EventHandler["Event Handler"]:::event
        EventSubscriber["Event Subscriber"]:::event
    end

    subgraph "Oh Dear Integration"
        OhDearInt["Oh Dear Integration"]:::ohdear
        PayloadFactory["Payload Factory"]:::ohdear
        PingJob["Ping Job"]:::ohdear
    end

    subgraph "External Systems"
        Laravel["Laravel Application"]:::external
        OhDearAPI["Oh Dear API"]:::external
    end

    %% Relationships
    Laravel --> SMS
    SMS --> TME
    TME --> TaskFactory
    TaskFactory --> CommandTask & JobTask & ShellTask & ClosureTask
    SMS --> EventHandler
    EventHandler --> EventSubscriber
    EventSubscriber --> DB
    DB --> MonitoredTask
    DB --> LogItems
    SMS --> ListCmd & SyncCmd & VerifyCmd
    SMS --> OhDearInt
    OhDearInt --> PayloadFactory
    PayloadFactory --> PingJob
    PingJob --> OhDearAPI

    %% Click Events
    click SMS "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/ScheduleMonitorServiceProvider.php"
    click TME "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Support/ScheduledTasks/ScheduledTasks.php"
    click TaskFactory "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Support/ScheduledTasks/ScheduledTaskFactory.php"
    click CommandTask "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Support/ScheduledTasks/Tasks/CommandTask.php"
    click JobTask "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Support/ScheduledTasks/Tasks/JobTask.php"
    click ShellTask "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Support/ScheduledTasks/Tasks/ShellTask.php"
    click ClosureTask "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Support/ScheduledTasks/Tasks/ClosureTask.php"
    click MonitoredTask "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Models/MonitoredScheduledTask.php"
    click LogItems "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Models/MonitoredScheduledTaskLogItem.php"
    click ListCmd "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Commands/ListCommand.php"
    click SyncCmd "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Commands/SyncCommand.php"
    click VerifyCmd "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Commands/VerifyCommand.php"
    click EventHandler "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/EventHandlers/BackgroundCommandListener.php"
    click EventSubscriber "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/EventHandlers/ScheduledTaskEventSubscriber.php"
    click OhDearInt "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Support/OhDearPayload/OhDearPayloadFactory.php"
    click PayloadFactory "https://github.com/spatie/laravel-schedule-monitor/tree/main/src/Support/OhDearPayload/Payloads"
    click PingJob "https://github.com/spatie/laravel-schedule-monitor/blob/main/src/Jobs/PingOhDearJob.php"

    %% Styles
    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef task fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef db fill:#f1c40f,stroke:#f39c12,color:black
    classDef cmd fill:#bdc3c7,stroke:#95a5a6,color:black
    classDef event fill:#9b59b6,stroke:#8e44ad,color:white
    classDef ohdear fill:#2ecc71,stroke:#27ae60,color:white
    classDef external fill:#e74c3c,stroke:#c0392b,color:white
```
