Laravel Schedule Monitor

https://github.com/spatie/laravel-schedule-monitor
Admin
Monitor scheduled tasks in Laravel apps with database logging and Oh Dear integration for...
Tokens:26,309
Snippets:370
Trust Score:10
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install and setup package

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/README.md

Commands to install the package, publish configuration files, and run migrations.

```bash
composer require spatie/laravel-schedule-monitor
php artisan vendor:publish --provider="Spatie\ScheduleMonitor\ScheduleMonitorServiceProvider"
php artisan migrate
```

--------------------------------

### List Tasks Examples

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/console-commands.md

Examples of using the list command to view current task statuses.

```bash
# Display current status
$ php artisan schedule-monitor:list

# See all tasks, including those not being monitored
$ php artisan schedule-monitor:list

# Output is color-coded and formatted for terminal display
```

--------------------------------

### Configuration Example

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/ping-oh-dear-job.md

Configuration settings for the Oh Dear integration in config/schedule-monitor.php.

```php
'oh_dear' => [
    // Ping job class
    'ping_oh_dear_job' => Spatie
ScheduleMonitor
Jobs
PingOhDearJob::class,
    
    // Retry attempts configuration
    'retry_job_for_minutes' => 10,
    
    // Delay between retries
    'retry_delay_ms' => 10_000,
    
    // Silence job in Horizon dashboard
    'silence_ping_oh_dear_job_in_horizon' => true,
    
    // Enable detailed logging of failed pings
    'debug_logging' => env('OH_DEAR_DEBUG_LOGGING', false),
    
    // Queue name
    'queue' => env('OH_DEAR_QUEUE'),
    
    // Oh Dear ping endpoint
    'endpoint_url' => env('OH_DEAR_PING_ENDPOINT_URL'),
    
    // Oh Dear API base URL
    'api_url' => env('OH_DEAR_API_URL', 'https://ohdear.app/api/'),
]
```

--------------------------------

### Install Oh Dear SDK

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/console-commands.md

Installs the required Oh Dear PHP SDK via Composer.

```bash
composer require ohdearapp/ohdear-php-sdk
```

--------------------------------

### Mark task as starting

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/monitored-scheduled-task-model.md

Record the start of a task execution, typically triggered by event subscribers.

```php
public function markAsStarting(ScheduledTaskStarting $event): self
```

```php
// Called automatically by event subscriber
$task->markAsStarting($event);
```

--------------------------------

### Configure Starting Pings

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/configuration.md

Enable notifications when a task starts, in addition to finish or failure events.

```php
'oh_dear' => [
    'send_starting_ping' => env('OH_DEAR_SEND_STARTING_PING', false),
]
```

```env
OH_DEAR_SEND_STARTING_PING=true
```

--------------------------------

### Dispatching the Job

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/ping-oh-dear-job.md

Example of how to dispatch the job manually.

```php
dispatch(new PingOhDearJob($logItem));
```

--------------------------------

### Command Output Example

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/console-commands.md

Standard progress output displayed during command execution.

```text
Start syncing schedule...
Start syncing schedule with database...
[Tasks created/updated]
Start syncing schedule with Oh Dear...
Successfully synced schedule with Oh Dear!
[Number of tasks] monitored scheduled tasks
```

--------------------------------

### Sync Command Examples

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/console-commands.md

Demonstration of full sync versus additive sync with expected output.

```bash
# Sync everything (replaces old tasks at Oh Dear)
$ php artisan schedule-monitor:sync
Start syncing schedule...
Start syncing schedule with database...
Start syncing schedule with Oh Dear...
Successfully synced schedule with Oh Dear!
5 monitored scheduled tasks

# Keep existing Oh Dear tasks (add new only)
$ php artisan schedule-monitor:sync --keep-old
Start syncing schedule...
Start syncing schedule with database...
Start syncing schedule with Oh Dear...
Successfully synced schedule with Oh Dear!
5 monitored scheduled tasks
```

--------------------------------

### Package Configuration Structure

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/service-provider.md

Example of the required configuration file structure located at config/schedule-monitor.php.

```php
return [
    'delete_log_items_older_than_days' => 30,
    'date_format' => 'Y-m-d H:i:s',
    
    'models' => [
        'monitored_scheduled_task' => Spatie")));
        'monitored_scheduled_log_item' => Spatie")));
    ],
    
    'oh_dear' => [
        'api_token' => env('OH_DEAR_API_TOKEN', ''),
        'monitor_id' => env('OH_DEAR_MONITOR_ID'),
        // ... more options
    ],
];
```

--------------------------------

### Setup Oh Dear integration

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/README.md

Environment configuration and verification commands for Oh Dear integration.

```bash
# Set environment variables
OH_DEAR_API_TOKEN=sk_live_...
OH_DEAR_MONITOR_ID=42

# Verify configuration
php artisan schedule-monitor:verify

# Sync with Oh Dear
php artisan schedule-monitor:sync
```

--------------------------------

### Service Provider Integration Example

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/service-provider.md

Demonstrates registering the service provider and utilizing macros within the schedule definition.

```php
// Application bootstrap
app()->register(ScheduleMonitorServiceProvider::class);

// After booting:
// - Commands are registered: schedule-monitor:list, sync, verify
// - Models are bound to configured classes
// - Events are wired to listen for task execution
// - Macros are available: ->monitorName(), ->graceTimeInMinutes(), etc.
// - Oh Dear API client is configured with auth token

// In schedule definition
protected function schedule(Schedule $schedule)
{
    $schedule->command('backup')
        ->daily()
        ->monitorName('Daily Backup')              // Macro from service provider
        ->graceTimeInMinutes(10);                  // Macro from service provider
}

// When task runs
// - ScheduledTaskStarting event fires
// - ScheduledTaskEventSubscriber catches it
// - Calls MonitoredScheduledTask::findForTask() then markAsStarting()
// - Logs to MonitoredScheduledTaskLogItem
// - Dispatches PingOhDearJob to notify Oh Dear
```

--------------------------------

### Handle ScheduledTaskStarting event

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/event-handlers.md

Records the start of a scheduled task by finding the associated model and marking it as starting.

```php
ScheduledTaskStarting::class => fn (ScheduledTaskStarting $event) => 
    optional($this->getMonitoredScheduleTaskModel()->findForTask($event->task))
        ->markAsStarting($event)
```

--------------------------------

### Event Failure Handling

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/ping-oh-dear-job.md

Examples for firing and listening to the OhDearPingFailed event.

```php
event(new OhDearPingFailed($logItem, $payload, $exception, $transferStats));
```

```php
Event::listen(OhDearPingFailed::class, function (OhDearPingFailed $event) {
    Log::error('Failed to ping Oh Dear', [
        'task' => $event->logItem->monitoredScheduledTask->name,
        'exception' => $event->exception->getMessage(),
    ]);
});
```

--------------------------------

### Verification Examples

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/console-commands.md

Common usage scenarios and expected output patterns for the verification command.

```bash
# Check configuration
$ php artisan schedule-monitor:verify

# With missing API token
$ OH_DEAR_API_TOKEN= php artisan schedule-monitor:verify
No API token found. ...

# With network error
$ php artisan schedule-monitor:verify
Failed to GET monitors/42: cURL error 28: Connection timeout
```

--------------------------------

### Configure task monitoring in Kernel

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/README.md

Example of adding monitoring methods to a scheduled command in app/Console/Kernel.php.

```php
// In app/Console/Kernel.php
protected function schedule(Schedule $schedule)
{
    $schedule->command('backup:database')
        ->daily()
        ->monitorName('Daily Database Backup')      // Set custom name
        ->graceTimeInMinutes(15)                    // Allow 15 min to complete
        ->storeOutputInDb();                        // Capture output to database
}
```

--------------------------------

### Install legacy version for Laravel 8

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/README.md

Use this command to install version 2 of the package if your project is running on Laravel 8.

```bash
composer require spatie/laravel-schedule-monitor:^2
```

--------------------------------

### Define complete package configuration

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/configuration.md

A full example of the configuration file, including log retention, date formatting, model overrides, and Oh Dear integration settings.

```php
<?php

return [
    'delete_log_items_older_than_days' => 30,
    
    'date_format' => 'Y-m-d H:i:s',
    
    'models' => [
        'monitored_scheduled_task' => Spatie\ScheduleMonitor\Models\MonitoredScheduledTask::class,
        'monitored_scheduled_log_item' => Spatie\ScheduleMonitor\Models\MonitoredScheduledTaskLogItem::class,
    ],
    
    'oh_dear' => [
        'api_token' => env('OH_DEAR_API_TOKEN', ''),
        'monitor_id' => env('OH_DEAR_MONITOR_ID'),
        'queue' => env('OH_DEAR_QUEUE'),
        'ping_oh_dear_job' => Spatie\ScheduleMonitor\Jobs\PingOhDearJob::class,
        'retry_job_for_minutes' => 10,
        'retry_delay_ms' => env('OH_DEAR_RETRY_DELAY_MS', 10_000),
        'silence_ping_oh_dear_job_in_horizon' => true,
        'send_starting_ping' => env('OH_DEAR_SEND_STARTING_PING', false),
        'grace_time_in_minutes' => 5,
        'endpoint_url' => env('OH_DEAR_PING_ENDPOINT_URL'),
        'api_url' => env('OH_DEAR_API_URL', 'https://ohdear.app/api/'),
        'debug_logging' => env('OH_DEAR_DEBUG_LOGGING', false),
    ],
];
```

--------------------------------

### Get Last Execution Start Time

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/task-base-class.md

Retrieves the last start time from the database record.

```php
public function lastRunStartedAt(): ?CarbonInterface
```

--------------------------------

### Access Log Item Types

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/types.md

Example of querying and checking the type of a log item.

```php
$logItem = MonitoredScheduledTaskLogItem::firstWhere('type', MonitoredScheduledTaskLogItem::TYPE_FAILED);
if ($logItem->type === MonitoredScheduledTaskLogItem::TYPE_FINISHED) {
    echo "Completed in " . $logItem->meta['runtime'] . "s";
}
```

--------------------------------

### Verify Oh Dear SDK Installation

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/errors.md

Checks for the presence of the Oh Dear SDK class and throws an exception if the dependency is missing.

```php
// In VerifyCommand::verifySdkInstalled()
if (! class_exists(OhDear::class)) {
    throw new Exception("You must install the Oh Dear SDK in order to sync your schedule with Oh Dear. Run `composer require ohdearapp/ohdear-php-sdk`.");
}
```

--------------------------------

### Create Cron Check Usage Example

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/oh-dear-support.md

Shows how to instantiate an OhDear client and create a new cron check, including database persistence of the ping URL.

```php
$ohDear = app(OhDear::class);

// Create a single cron check
$check = $ohDear->createCronCheck(
    monitorId: 123,
    name: 'Process Queue',
    cronExpression: '*/5 * * * *',
    graceTimeInMinutes: 2,
    description: 'Process background jobs',
    serverTimezone: 'UTC'
);

echo "Ping URL: " . $check->pingUrl;  // Use this to send pings
echo "Expires: " . $check->graceTimeInMinutes . " minutes";

// Store the ping URL in database
MonitoredScheduledTask::where('name', $check->name)
    ->update(['ping_url' => $check->pingUrl]);
```

--------------------------------

### Sync Scheduled Tasks to Database

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-tasks.md

Example of iterating through tasks to persist their configuration into a database model.

```php
class SyncCommand extends Command
{
    public function handle()
    {
        $tasks = ScheduledTasks::createForSchedule()->uniqueTasks();
        
        foreach ($tasks as $task) {
            MonitoredScheduledTask::updateOrCreate(
                ['name' => $task->name()],
                [
                    'type' => $task->type(),
                    'cron_expression' => $task->cronExpression(),
                    'grace_time_in_minutes' => $task->graceTimeInMinutes(),
                ]
            );
        }
    }
}
```

--------------------------------

### Query Execution History and Failures

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/monitored-scheduled-task-log-item-model.md

Examples for retrieving recent log history and filtering for failed tasks.

```php
$logItems = MonitoredScheduledTaskLogItem::query()
    ->where('monitored_scheduled_task_id', $taskId)
    ->orderByDesc('created_at')
    ->limit(10)
    ->get();

foreach ($logItems as $item) {
    echo "Type: {$item->type}\n";
    echo "Runtime: {$item->meta['runtime']}s\n";
    echo "Memory: " . ($item->meta['memory'] / 1024 / 1024) . " MB\n";
}
```

```php
$failures = MonitoredScheduledTaskLogItem::where('type', 'failed')
    ->where('created_at', '>', now()->subDays(7))
    ->with('monitoredScheduledTask')
    ->get();
```

--------------------------------

### Usage of monitorName() in scheduler

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-task-macros.md

Example of applying custom monitor names to console commands and queued jobs within the kernel schedule.

```php
// In app/Console/Kernel.php
protected function schedule(Schedule $schedule)
{
    $schedule->command('backup:database')
        ->daily()
        ->monitorName('Daily Database Backup');
    
    $schedule->job(new ProcessLogs)
        ->hourly()
        ->monitorName('Process Application Logs');
}
```

--------------------------------

### Create Cron Check

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/oh-dear-support.md

Method signature and usage example for creating a new cron check for a monitored task.

```php
public function createCronCheck(
    int $monitorId,
    string $name,
    string $cronExpression,
    int $graceTimeInMinutes,
    string $description,
    string $serverTimezone
): CronCheck
```

```php
$cronCheck = app(OhDear::class)->createCronCheck(
    monitorId: 123,
    name: 'Daily Backup',
    cronExpression: '0 2 * * *',
    graceTimeInMinutes: 10,
    description: 'Database backup',
    serverTimezone: 'America/New_York'
);

echo $cronCheck->pingUrl;  // Ping endpoint for this check
```

--------------------------------

### Usage of doNotMonitor

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-task-macros.md

Examples of excluding tasks from monitoring, including conditional exclusion.

```php
$schedule->command('schedule:run')
    ->everyMinute()
    ->doNotMonitor();

// Or disable conditionally
$schedule->command('test')
    ->daily()
    ->doNotMonitor(app()->environment('testing'));
```

--------------------------------

### Usage of graceTimeInMinutes() in scheduler

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-task-macros.md

Example of extending the default grace period for a specific long-running command.

```php
$schedule->command('sync:large-dataset')
    ->daily()
    ->graceTimeInMinutes(30);  // Allow 30 minutes to complete
```

--------------------------------

### Configure Model Pruning

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/monitored-scheduled-task-log-item-model.md

Method signature and implementation example for scheduling the automatic deletion of old log records.

```php
public function prunable(): Builder
```

```php
// In app/Console/Kernel.php
protected function schedule(Schedule $schedule)
{
    $schedule->command('model:prune', [
        '--model' => MonitoredScheduledTaskLogItem::class
    ])->daily();
}
```

--------------------------------

### Configure OhDear API Credentials

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/oh-dear-support.md

Example configuration for the OhDear API settings within the Laravel config file.

```php
// In config/schedule-monitor.php
'oh_dear' => [
    'api_token' => env('OH_DEAR_API_TOKEN'),
    'api_url' => env('OH_DEAR_API_URL', 'https://ohdear.app/api/'),
]
```

--------------------------------

### Install Laravel Schedule Monitor via Composer

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/README.md

Use this command to add the package to your Laravel project. For Laravel 8 support, specify version ^2.

```bash
composer require spatie/laravel-schedule-monitor
```

```bash
composer require "spatie/laravel-schedule-monitor:^2"
```

--------------------------------

### Example Custom PingOhDearJob Class

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/README.md

Create a custom job class that extends `Spatie\ScheduleMonitor\Jobs\PingOhDearJob` to customize the Oh Dear ping functionality.

```php
namespace App\Jobs;

use Spatie\ScheduleMonitor\Jobs\PingOhDearJob;
use Spatie\ScheduleMonitor\Models\MonitoredScheduledTaskLogItem;

class CustomPingOhDearJob extends PingOhDearJob
{
    // your implementation
}
```

--------------------------------

### Define Background Task

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/event-handlers.md

Example of defining a task to run in the background within the Laravel scheduler.

```php
$schedule->command('process:queue')
    ->everyMinute()
    ->runInBackground();  // Runs in background
```

--------------------------------

### Handle InvalidClassException

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/types.md

Example of catching the exception when an invalid model class is provided in the configuration.

```php
try {
    // Configuration with invalid model class
    config(['schedule-monitor.models.monitored_scheduled_task' => InvalidModel::class]);
    app()->make('boot-service-providers');
} catch (InvalidClassException $e) {
    echo $e->getMessage();
    // "The provided class name ... does not extend the required package class ..."
}
```

--------------------------------

### Log failure context

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/errors.md

Example of the structured log output generated when debug logging is enabled.

```php
Log::warning('PingOhDearJob failed: {message}', [
    'request' => [
        'url' => '...',
        'data' => [...],
        'headers' => [...],
    ],
    'timing' => [
        'namelookup_time_s' => 0.012,
        'connect_time_s' => 0.034,
        'appconnect_time_s' => 0.156,
        'starttransfer_time_s' => 0.212,
        'total_time_s' => 0.215,
    ],
    'connection' => [
        'primary_ip' => '203.0.113.45',
        'primary_port' => 443,
        'local_ip' => '192.0.2.1',
    ],
    'response' => [
        'status' => 500,
        'headers' => [...],
        'body' => '...',  // Limited to 1024 chars
    ],
    'exception' => 'Error message',
]);
```

--------------------------------

### Sync Cron Checks

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/oh-dear-support.md

Method signature, attribute structure, and usage example for syncing multiple cron checks, which replaces all existing checks.

```php
public function syncCronChecks(int $monitorId, array $cronCheckAttributes): array
```

```php
[
    'name' => 'Task Name',
    'type' => 'cron',
    'cron_expression' => '0 9 * * *',
    'grace_time_in_minutes' => 5,
    'description' => 'Optional description',
    'server_timezone' => 'UTC',
]
```

```php
$checks = app(OhDear::class)->syncCronChecks(123, [
    [
        'name' => 'Task 1',
        'type' => 'cron',
        'cron_expression' => '0 9 * * *',
        'grace_time_in_minutes' => 5,
        'description' => '',
        'server_timezone' => 'UTC',
    ],
    [
        'name' => 'Task 2',
        'type' => 'cron',
        'cron_expression' => '0 18 * * *',
        'grace_time_in_minutes' => 10,
        'description' => '',
        'server_timezone' => 'UTC',
    ],
]);
```

--------------------------------

### List Monitored Tasks

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/README.md

Run the `schedule-monitor:list` command to view all monitored scheduled tasks, including their last start, finish, and failure times.

```bash
php artisan schedule-monitor:list
```

--------------------------------

### Prepare Database for Schedule Monitor

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/README.md

Publish and run the package's migrations to set up the necessary database table for monitoring scheduled tasks.

```bash
php artisan vendor:publish --provider="Spatie\ScheduleMonitor\ScheduleMonitorServiceProvider" --tag="schedule-monitor-migrations"
php artisan migrate
```

--------------------------------

### Handle CommandStarting Event

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/event-handlers.md

The entry point for the listener, triggered when the schedule:finish command begins.

```php
public function handle(CommandStarting $event)
```

--------------------------------

### Publish the configuration file

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/configuration.md

Run this command to copy the package configuration file to your application's config directory.

```bash
php artisan vendor:publish --provider="Spatie\ScheduleMonitor\ScheduleMonitorServiceProvider" --tag="schedule-monitor-config"
```

--------------------------------

### Filter Scheduled Tasks by Type

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/types.md

Example of filtering a collection of tasks based on their type identifier.

```php
$tasks = ScheduledTasks::createForSchedule()->uniqueTasks();
$commands = $tasks->filter(fn($t) => $t->type() === 'command');
```

--------------------------------

### Run Database Migrations

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/errors.md

Commands to resolve SQLSTATE[42S02] errors caused by missing database tables.

```bash
php artisan migrate
```

```bash
php artisan vendor:publish --provider="Spatie\ScheduleMonitor\ScheduleMonitorServiceProvider" --tag="schedule-monitor-migrations"
php artisan migrate
```

--------------------------------

### Chain multiple monitoring macros

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-task-macros.md

Demonstrates chaining various monitoring macros to configure task behavior and monitoring settings.

```php
$schedule->command('sync:data')
    ->daily()
    ->at('02:00')
    ->monitorName('Nightly Data Synchronization')
    ->graceTimeInMinutes(15)
    ->storeOutputInDb();

$schedule->call(function () {
    // ...
})
    ->everyFiveMinutes()
    ->monitorName('Health Check')
    ->doNotMonitorAtOhDear();
```

--------------------------------

### Implement storeOutputInDb and retrieve output

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-task-macros.md

Enables output capture for a scheduled command and demonstrates how to retrieve the stored output from the log item.

```php
$schedule->command('send-notifications')
    ->everyMinute()
    ->storeOutputInDb();

// Later, retrieve the output
$logItem = MonitoredScheduledTaskLogItem::latest()->first();
$output = $logItem->meta['output'] ?? 'No output';
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/configuration.md

Define these variables in your .env file to integrate with Oh Dear. Required tokens and optional settings for queueing and logging are included.

```env
# Required for Oh Dear integration
OH_DEAR_API_TOKEN=sk_live_...
OH_DEAR_MONITOR_ID=42

# Optional Oh Dear settings
OH_DEAR_QUEUE=oh-dear
OH_DEAR_SEND_STARTING_PING=false
OH_DEAR_RETRY_DELAY_MS=10000
OH_DEAR_PING_ENDPOINT_URL=
OH_DEAR_API_URL=https://ohdear.app/api/
OH_DEAR_DEBUG_LOGGING=false
```

--------------------------------

### Update Oh Dear Integration Configuration

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/UPGRADING.md

Replace the old `ohdear.site_id` configuration with `monitor_id` to sync with Oh Dear monitors. Ensure the `OH_DEAR_MONITOR_ID` environment variable is set.

```php
        /*
         *  The id of the monitor you want to sync the schedule with.
         *
         * You'll find this id on the settings page of a monitor at Oh Dear.
         */
        'monitor_id' => env('OH_DEAR_MONITOR_ID'),

```

--------------------------------

### Get Task Name

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/task-base-class.md

Resolves the task name based on macros, default implementations, or null.

```php
public function name(): ?string
```

--------------------------------

### Get event task output

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/monitored-scheduled-task-model.md

Retrieves the captured output from a scheduler event if storage is configured.

```php
public function getEventTaskOutput($event): ?string
```

--------------------------------

### Add to Deployment Script

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/console-commands.md

Recommended placement of the sync command within a deployment workflow.

```bash
# In your deploy script
php artisan migrate
php artisan schedule-monitor:sync
```

--------------------------------

### Bootstrap lifecycle hook

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/service-provider.md

Initializes components after the service provider is booted.

```php
public function packageBooted()
```

--------------------------------

### Usage of doNotMonitorAtOhDear

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-task-macros.md

Examples of excluding specific tasks from Oh Dear while allowing others to remain monitored.

```php
$schedule->command('local-cleanup')
    ->daily()
    ->doNotMonitorAtOhDear();  // Local-only task

$schedule->command('critical-backup')
    ->daily();  // Will be monitored both locally and at Oh Dear
```

--------------------------------

### Creating a CronCheck via Oh Dear

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/types.md

Shows how to instantiate a new cron check using the Oh Dear service class.

```php
$ohDear = app(OhDear::class);
$check = $ohDear->createCronCheck(
    monitorId: 42,
    name: 'Backup Task',
    cronExpression: '0 2 * * *',
    graceTimeInMinutes: 10,
    description: 'Daily backup',
    serverTimezone: 'UTC'
);

// Use the ping URL
echo $check->pingUrl;  // https://ping.ohdear.app/...
```

--------------------------------

### Verify Oh Dear Integration

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/README.md

Run this Artisan command to verify that your `api_token` and `monitor_id` for Oh Dear are correctly configured in the `schedule-monitor` config.

```bash
php artisan schedule-monitor:verify
```

--------------------------------

### Run Verification Command

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/console-commands.md

Executes the verification process to ensure Oh Dear integration is correctly configured.

```bash
php artisan schedule-monitor:verify
```

--------------------------------

### Initialize Task Instance

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/task-base-class.md

Constructor for the task class, requiring an Illuminate Console Scheduling Event.

```php
public function __construct(Event $event)
```

--------------------------------

### Authenticated API Requests

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/oh-dear-support.md

Protected methods for sending authenticated GET and POST requests to the Oh Dear API.

```php
protected function get(string $endpoint): array
```

```php
protected function post(string $endpoint, array $data): array
```

--------------------------------

### Run Package Tests

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/README.md

Execute this command to run the test suite for the spatie/laravel-schedule-monitor package.

```bash
composer test
```

--------------------------------

### Retrieve Monitored Scheduled Task Relation

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/monitored-scheduled-task-log-item-model.md

Method signature and usage example for accessing the parent task of a log item.

```php
public function monitoredScheduledTask(): BelongsTo
```

```php
$logItem = MonitoredScheduledTaskLogItem::first();
$task = $logItem->monitoredScheduledTask;
```

--------------------------------

### Configure package structure

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/service-provider.md

Defines the package configuration, including views, migrations, and console commands.

```php
public function configurePackage(Package $package): void
```

--------------------------------

### Initialize OhDear Class Constructor

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/oh-dear-support.md

Defines the constructor for the OhDear client, requiring an API token and an optional base URI.

```php
public function __construct(string $apiToken, string $baseUri = 'https://ohdear.app/api/')
```

--------------------------------

### Get grace period duration

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/task-base-class.md

Returns the configured grace period in minutes before a task is considered late, following a specific resolution order.

```php
public function graceTimeInMinutes(): int
```

--------------------------------

### Publish Package Assets

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/service-provider.md

Artisan commands to publish views, configuration, and migrations for the package.

```bash
php artisan vendor:publish --provider="Spatie\ScheduleMonitor\ScheduleMonitorServiceProvider" --tag="schedule-monitor-views"
```

```bash
php artisan vendor:publish --provider="Spatie\ScheduleMonitor\ScheduleMonitorServiceProvider" --tag="schedule-monitor-config"
```

```bash
php artisan vendor:publish --provider="Spatie\ScheduleMonitor\ScheduleMonitorServiceProvider" --tag="schedule-monitor-migrations"
```

--------------------------------

### Package Directory Structure

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/README.md

Visual representation of the project's file organization.

```text
laravel-schedule-monitor/
├── src/
│   ├── Models/
│   │   ├── MonitoredScheduledTask.php
│   │   └── MonitoredScheduledTaskLogItem.php
│   ├── Commands/
│   │   ├── ListCommand.php
│   │   ├── SyncCommand.php
│   │   └── VerifyCommand.php
│   ├── Jobs/
│   │   └── PingOhDearJob.php
│   ├── Events/
│   │   └── OhDearPingFailed.php
│   ├── EventHandlers/
│   │   ├── ScheduledTaskEventSubscriber.php
│   │   └── BackgroundCommandListener.php
│   ├── Support/
│   │   ├── ScheduledTasks/
│   │   │   ├── ScheduledTasks.php
│   │   │   ├── ScheduledTaskFactory.php
│   │   │   ├── MonitoredScheduledTasks.php
│   │   │   └── Tasks/
│   │   │       ├── Task.php
│   │   │       ├── CommandTask.php
│   │   │       ├── JobTask.php
│   │   │       ├── ClosureTask.php
│   │   │       └── ShellTask.php
│   │   ├── OhDear/
│   │   │   ├── OhDear.php
│   │   │   └── CronCheck.php
│   │   ├── OhDearPayload/
│   │   │   ├── OhDearPayloadFactory.php
│   │   │   └── Payloads/
│   │   │       ├── Payload.php
│   │   │       ├── StartingPayload.php
│   │   │       ├── FinishedPayload.php
│   │   │       └── FailedPayload.php
│   │   └── Concerns/
│   │       ├── UsesMonitoredScheduledTasks.php
│   │       └── UsesScheduleMonitoringModels.php
│   ├── Exceptions/
│   │   └── InvalidClassException.php
│   └── ScheduleMonitorServiceProvider.php
├── config/
│   └── schedule-monitor.php
└── database/
    └── migrations/
        └── create_schedule_monitor_tables.php
```

--------------------------------

### Check if last run failed

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/task-base-class.md

Checks if the last execution failed by comparing the last failure timestamp against the last start timestamp. Returns false if not monitored.

```php
public function lastRunFailed(): bool
```

--------------------------------

### Custom Job Implementation

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/ping-oh-dear-job.md

Extending the base job to add custom logic and registering it in the configuration.

```php
namespace App
Jobs;

use Spatie\ScheduleMonitor\Jobs\PingOhDearJob;
use Spatie\ScheduleMonitor\Models\MonitoredScheduledTaskLogItem;

class CustomPingOhDearJob extends PingOhDearJob
{
    public function handle(): void
    {
        // Custom logic before
        
        parent::handle();
        
        // Custom logic after
    }
}
```

```php
'oh_dear' => [
    'ping_oh_dear_job' => \App\Jobs\CustomPingOhDearJob::class,
]
```

--------------------------------

### Configure debug logging for Oh Dear

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/configuration.md

Enable detailed diagnostic logging for failed pings to Oh Dear by setting the debug_logging key in the configuration or via environment variables.

```php
'oh_dear' => [
    'debug_logging' => env('OH_DEAR_DEBUG_LOGGING', false),
]
```

```env
OH_DEAR_DEBUG_LOGGING=true
```

--------------------------------

### Publish Schedule Monitor Config

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/README.md

Use this command to publish the configuration file for the schedule monitor. This allows you to customize its settings.

```bash
php artisan vendor:publish --provider="Spatie\ScheduleMonitor\ScheduleMonitorServiceProvider" --tag="schedule-monitor-config"
```

--------------------------------

### Run schedule-monitor:sync

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/console-commands.md

Execute the synchronization command with or without the --keep-old option.

```bash
# Full sync (replaces existing tasks)
php artisan schedule-monitor:sync

# Additive sync (keeps existing Oh Dear tasks)
php artisan schedule-monitor:sync --keep-old
```

--------------------------------

### Configure Oh Dear API

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/service-provider.md

Binds the OhDear class into the service container using configuration values.

```php
protected function configureOhDearApi(): self
```

```php
$ohDear = app(OhDear::class);  // Automatically configured with API token
```

--------------------------------

### Configure Oh Dear Environment Variables

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/console-commands.md

Required environment variables for enabling Oh Dear synchronization.

```env
OH_DEAR_API_TOKEN=sk_live_...
OH_DEAR_MONITOR_ID=42
```

--------------------------------

### Multitenancy Configuration

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/ping-oh-dear-job.md

Adding the job to the non-tenant aware list for multitenancy support.

```php
'not_tenant_aware_jobs' => [
    \Spatie\ScheduleMonitor\Jobs\PingOhDearJob::class,
]
```

--------------------------------

### Sync Schedule with Database

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/README.md

Execute the `schedule-monitor:sync` Artisan command to synchronize your application's schedule with the database. This is crucial after deploying your application.

```bash
php artisan schedule-monitor:sync
```

--------------------------------

### Oh Dear Integration Environment Variables

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/README.md

Configure these environment variables in your .env file to enable and customize Oh Dear integration for task monitoring.

```env
# Oh Dear Integration (optional)
OH_DEAR_API_TOKEN=sk_live_...
OH_DEAR_MONITOR_ID=42
OH_DEAR_QUEUE=oh-dear                          # Queue name for ping jobs
OH_DEAR_SEND_STARTING_PING=false               # Notify Oh Dear on start
OH_DEAR_RETRY_DELAY_MS=10000                   # Retry delay between attempts
OH_DEAR_API_URL=https://ohdear.app/api/        # Custom API endpoint
OH_DEAR_PING_ENDPOINT_URL=                     # Custom ping endpoint
OH_DEAR_DEBUG_LOGGING=false                    # Enable detailed logging
```

--------------------------------

### Configure API Token

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/console-commands.md

Sets the required API token in the environment configuration.

```env
OH_DEAR_API_TOKEN=sk_live_...
```

--------------------------------

### Schedule Monitor Configuration File

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/README.md

This is the content of the published configuration file. It includes settings for log item deletion, date formatting, custom models, and Oh Dear integration.

```php
return [
    /*
     * The schedule monitor will log each start, finish and failure of all scheduled jobs.
     * After a while the `monitored_scheduled_task_log_items` might become big.
     * Here you can specify the amount of days log items should be kept.
     *
     * Use Laravel's pruning command to delete old `MonitoredScheduledTaskLogItem` models.
     * More info: https://laravel.com/docs/11.x/eloquent#pruning-models
     */
    'delete_log_items_older_than_days' => 30,

    /*
     * The date format used for all dates displayed on the output of commands
     * provided by this package.
     */
    'date_format' => 'Y-m-d H:i:s',

    'models' => [
        /*
         * The model you want to use as a MonitoredScheduledTask model needs to extend the
         * `Spatie
ScheduleMonitor
Models
MonitoredScheduledTask` Model.
         */
        'monitored_scheduled_task' => Spatie\ScheduleMonitor\Models\MonitoredScheduledTask::class,

        /*
         * The model you want to use as a MonitoredScheduledTaskLogItem model needs to extend the
         * `Spatie
ScheduleMonitor
Models
MonitoredScheduledTaskLogItem` Model.
         */
        'monitored_scheduled_log_item' => Spatie\ScheduleMonitor\Models\MonitoredScheduledTaskLogItem::class,
    ],

    /*
     * Oh Dear can notify you via Mail, Slack, SMS, web hooks, ... when a
     * scheduled task does not run on time.
     *
     * More info: https://ohdear.app/docs/features/cron-job-monitoring
     */
    'oh_dear' => [
        /*
         * You can generate an API token at the Oh Dear user settings screen
         *
         * https://ohdear.app/user/api-tokens
         */
        'api_token' => env('OH_DEAR_API_TOKEN', ''),

        /*
         *  The id of the monitor you want to sync the schedule with.
         *
         * You'll find this id on the settings page of a monitor at Oh Dear.
         */
        'monitor_id' => env('OH_DEAR_MONITOR_ID'),

        /*
         * To keep scheduled jobs as short as possible, Oh Dear will be pinged
         * via a queued job. Here you can specify the name of the queue you wish to use.
         */
        'queue' => env('OH_DEAR_QUEUE'),

        /*
         * The job class that will be dispatched to ping Oh Dear.
         */
        'ping_oh_dear_job' => Spatie\ScheduleMonitor\Jobs\PingOhDearJob::class,

        /*
         * `PingOhDearJob`s will automatically be skipped if they've been queued for
         * longer than the time configured here.
         */
        'retry_job_for_minutes' => 10,

        /*
         * When set to true, we will automatically add the `PingOhDearJob` to Horizon's
         * silenced jobs.
         */
        'silence_ping_oh_dear_job_in_horizon' => true,

        /*
         * Send the start of a scheduled job to Oh Dear. This is not needed
         * for notifications to work correctly.
         */
        'send_starting_ping' => env('OH_DEAR_SEND_STARTING_PING', false),

        /**
         * The amount of minutes a scheduled task is allowed to run before it is
         * considered late.
         */
        'grace_time_in_minutes' => 5,

        /**
         * Which endpoint to ping on Oh Dear.
         */
        'endpoint_url' => env('OH_DEAR_PING_ENDPOINT_URL'),

        /**
         * The URL of the Oh Dear API.
         */
        'api_url' => env('OH_DEAR_API_URL', 'https://ohdear.app/api/'),

        /*
         * The delay in milliseconds between retry attempts when a ping fails.
         */
        'retry_delay_ms' => env('OH_DEAR_RETRY_DELAY_MS', 10_000),

        /*
         * When enabled, failed pings to Oh Dear will log detailed diagnostics
         * including request timing, connection info, and response data.
         * Useful for debugging connectivity issues with ping.ohdear.app.
         */
        'debug_logging' => env('OH_DEAR_DEBUG_LOGGING', false),
    ],
];
```

--------------------------------

### Task execution flow visualization

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/event-handlers.md

A conceptual representation of the event lifecycle and subscriber actions during task execution.

```text
Task starts → ScheduledTaskStarting fired → Subscriber listens → markAsStarting()
   ↓
Executes for 3.5 seconds → ScheduledTaskFinished fired → Subscriber listens → markAsFinished()
   ↓
Log item created: type=finished, meta={runtime: 3.5, memory: 2097152, exit_code: 0}
   ↓
PingOhDearJob dispatched to notify Oh Dear
```

--------------------------------

### Configure debug logging

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/errors.md

Enables detailed logging for Oh Dear operations in the configuration file.

```php
'oh_dear' => [
    'debug_logging' => true,  // Enable detailed logging
]
```

--------------------------------

### List Scheduled Tasks in Console

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-tasks.md

Displays various task categories using a view renderer within a console command.

```php
class ListCommand extends Command
{
    public function handle()
    {
        render(view('schedule-monitor::list', [
            'monitoredTasks' => ScheduledTasks::createForSchedule()->monitoredTasks(),
            'readyForMonitoringTasks' => ScheduledTasks::createForSchedule()->readyForMonitoringTasks(),
            'unnamedTasks' => ScheduledTasks::createForSchedule()->unnamedTasks(),
            'duplicateTasks' => ScheduledTasks::createForSchedule()->duplicateTasks(),
        ]));
    }
}
```

--------------------------------

### Configure Mass Pruning Queue

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/monitored-scheduled-task-log-item-model.md

Setting a specific queue for the mass pruning process to improve performance.

```php
// In service provider
use Spatie
ullScheduleMonitor
ullModels
ullMonitoredScheduledTaskLogItem;

MonitoredScheduledTaskLogItem::useDeleteQueue('queues:default');
```

--------------------------------

### Customize monitored scheduled task model

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/configuration.md

Extend the base model to add custom methods or behaviors, then register the class in the configuration file.

```php
namespace App\Models;

use Spatie\ScheduleMonitor\Models\MonitoredScheduledTask as BaseModel;

class CustomMonitoredScheduledTask extends BaseModel
{
    // Custom methods and behaviors
}
```

```php
'models' => [
    'monitored_scheduled_task' => App\Models\CustomMonitoredScheduledTask::class,
]
```

--------------------------------

### Handle Method Definition

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/ping-oh-dear-job.md

The handle method signature for the job.

```php
public function handle(): void
```

--------------------------------

### Sync tasks with database

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/README.md

Command to synchronize scheduled tasks with the database.

```bash
php artisan schedule-monitor:sync
```

--------------------------------

### Configure Oh Dear Queue

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/configuration.md

Specify the queue name for ping jobs to improve performance. A dedicated queue is recommended.

```php
'oh_dear' => [
    'queue' => env('OH_DEAR_QUEUE'),  // defaults to default queue
]
```

```env
OH_DEAR_QUEUE=oh-dear
```

```php
// In your service provider
Queue::createPayloadUsing(function () {
    return ['queue' => 'oh-dear'];
});
```

--------------------------------

### Configure API Base URL

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/configuration.md

Set the base URL for the Oh Dear API.

```php
'oh_dear' => [
    'api_url' => env('OH_DEAR_API_URL', 'https://ohdear.app/api/'),
]
```

```env
OH_DEAR_API_URL=https://api.custom.ohdear.app/
```

--------------------------------

### Oh Dear Configuration

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/oh-dear-support.md

Configuration structure for the oh_dear array in config/schedule-monitor.php.

```php
'oh_dear' => [
    'api_token' => env('OH_DEAR_API_TOKEN', ''),
    'monitor_id' => env('OH_DEAR_MONITOR_ID'),
    'api_url' => env('OH_DEAR_API_URL', 'https://ohdear.app/api/'),
    'endpoint_url' => env('OH_DEAR_PING_ENDPOINT_URL'),
]
```

--------------------------------

### Create ScheduledTasks Instance

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-tasks.md

Factory method to instantiate the class from the application's current schedule.

```php
public static function createForSchedule(): self
```

```php
$tasks = ScheduledTasks::createForSchedule();
```

--------------------------------

### Configure Multitenancy for PingOhDearJob

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/README.md

If using spatie/laravel-multitenancy, add `PingOhDearJob` to the `not_tenant_aware_jobs` array in `config/multitenancy.php` to prevent it from failing.

```php
'not_tenant_aware_jobs' => [
    // ...
    \Spatie\ScheduleMonitor\Jobs\PingOhDearJob::class,
]
```

--------------------------------

### Retrieve Monitored Tasks

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-tasks.md

Returns tasks that already exist in the monitoring database.

```php
public function monitoredTasks(): Collection
```

```php
$monitoring = ScheduledTasks::createForSchedule()->monitoredTasks();
foreach ($monitoring as $task) {
    echo $task->name() . ": " . $task->lastRunFinishedAt() . "\n";
}
```

--------------------------------

### Implement type method

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/task-base-class.md

Returns the unique string identifier for the task type, such as command, job, closure, or shell.

```php
abstract public function type(): string
```

--------------------------------

### Implement defaultName method

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/task-base-class.md

Provides a default identifier for the task, which may return null for certain types like closures.

```php
abstract public function defaultName(): ?string
```

--------------------------------

### Implement Task Lifecycle Payloads

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/types.md

Specific payload implementations for task execution states.

```php
class StartingPayload extends Payload {
    public function url(): string;        // Returns: {ping_url}/starting
    public function data(): array;        // Returns: []
}
```

```php
class FinishedPayload extends Payload {
    public function url(): string;        // Returns: {ping_url}/finished
    public function data(): array;        // Returns: {runtime, exit_code, memory}
}
```

```php
class FailedPayload extends Payload {
    public function url(): string;        // Returns: {ping_url}/failed
    public function data(): array;        // Returns: {failure_message}
}
```

--------------------------------

### Error Handling for API Calls

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/oh-dear-support.md

Demonstrates wrapping API calls in try-catch blocks to handle potential failures.

```php
try {
    $check = $ohDear->createCronCheck(...);
} catch (Exception $e) {
    Log::error('Failed to create cron check: ' . $e->getMessage());
}
```

```php
try {
    $monitor = $ohDear->monitor(config('schedule-monitor.oh_dear.monitor_id'));
} catch (Exception $e) {
    // Configuration error or connectivity issue
    throw new Exception("Cannot connect to Oh Dear: " . $e->getMessage());
}
```

--------------------------------

### Constructor Definition

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-tasks.md

The constructor initializes the class by retrieving events from the Laravel Schedule instance and converting them into Task objects.

```php
public function __construct(Schedule $schedule)
```

--------------------------------

### Enable Debug Logging for Failed Pings

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/README.md

Set this environment variable to true to enable detailed logging for failed pings to Oh Dear. This is useful for diagnosing connection or timeout issues.

```env
OH_DEAR_DEBUG_LOGGING=true
```

--------------------------------

### Registering a JobTask

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/task-base-class.md

Use for queued job classes registered with Schedule::job().

```php
$schedule->job(ProcessData::class)->hourly();
```

--------------------------------

### Configure Oh Dear Monitor ID

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/configuration.md

Set the unique identifier for the monitor as found in the Oh Dear settings.

```php
'oh_dear' => [
    'monitor_id' => env('OH_DEAR_MONITOR_ID'),
]
```

```env
OH_DEAR_MONITOR_ID=42
```

--------------------------------

### Define monitorName() method signature

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-task-macros.md

Method signature for setting a custom display name for a scheduled task.

```php
public function monitorName(string $monitorName): Event
```

--------------------------------

### Constructor Definition

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/ping-oh-dear-job.md

Defines the constructor for the PingOhDearJob, requiring a MonitoredScheduledTaskLogItem.

```php
public function __construct(MonitoredScheduledTaskLogItem $logItem)
```

--------------------------------

### Register event handlers

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/service-provider.md

Registers subscribers and listeners for monitoring scheduled task execution.

```php
protected function registerEventHandlers(): self
```

--------------------------------

### Retrieve Tasks for Oh Dear

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-tasks.md

Returns tasks that are configured to be synchronized with the Oh Dear monitoring service.

```php
public function monitoredAtOhDear(): Collection
```

```php
$ohDearTasks = ScheduledTasks::createForSchedule()->monitoredAtOhDear();
// These will be synced to Oh Dear cron checks
```

--------------------------------

### Listen for OhDearPingFailed events

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/errors.md

Registers an event listener to log details when a ping failure occurs.

```php
use Spatie
ullScheduleMonitor
ullEvents
ullOhDearPingFailed;
use Illuminate
ullSupport
ullFacades
ullEvent;
use Illuminate
ullSupport
ullFacades
ullLog;

Event::listen(OhDearPingFailed::class, function (OhDearPingFailed $event) {
    Log::warning('Failed to ping Oh Dear', [
        'task_name' => $event->logItem->monitoredScheduledTask->name,
        'log_item_type' => $event->logItem->type,
        'error' => $event->exception->getMessage(),
        'transfer_stats' => $event->transferStats ? [
            'namelookup_time' => $event->transferStats->getHandlerStats()['namelookup_time'] ?? null,
            'connect_time' => $event->transferStats->getHandlerStats()['connect_time'] ?? null,
        ] : null,
    ]);
    
    // Optional: retry logic, alert, etc.
    if ($event->transferStats === null) {
        // Network error - manual retry later
    }
});
```

--------------------------------

### Retrieve New Tasks for Monitoring

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/scheduled-tasks.md

Returns unique tasks that have not yet been recorded in the monitoring database.

```php
public function readyForMonitoringTasks(): Collection
```

```php
$newTasks = ScheduledTasks::createForSchedule()->readyForMonitoringTasks();
// These tasks would be created during `schedule-monitor:sync`
```

--------------------------------

### Mark task as registered on Oh Dear

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/monitored-scheduled-task-model.md

Update the registration timestamp for the task on the Oh Dear service.

```php
public function markAsRegisteredOnOhDear(): self
```

```php
$task->markAsRegisteredOnOhDear();
```

--------------------------------

### Create log item

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/monitored-scheduled-task-model.md

Generates a new log item for the task with a specified type.

```php
public function createLogItem(string $type): MonitoredScheduledTaskLogItem
```

--------------------------------

### Registering a ShellTask

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/api-reference/task-base-class.md

Use for shell commands registered with Schedule::exec().

```php
$schedule->exec('curl https://example.com/webhook')->everyMinute();
```

--------------------------------

### Define OhDearPingFailed Event Class

Source: https://github.com/spatie/laravel-schedule-monitor/blob/main/_autodocs/types.md

Event class structure for handling failed pings to Oh Dear.

```php
class OhDearPingFailed {
    public MonitoredScheduledTaskLogItem $logItem;
    public Payload $payload;
    public Throwable $exception;
    public ?TransferStats $transferStats;
}
```
Tokens:
Raw