Skip to content

API Reference

API Reference

Complete API documentation for Laravel Queue Autoscale.

Core Components

Configuration

Configuration objects and data structures

Scaling

Scaling strategies and policies interfaces

Events

Laravel events for autoscaling lifecycle

Workers

Worker process and pool management

Quick Reference

Contracts

// Strategy Contract
interface ScalingStrategyContract
{
    public function calculateTargetWorkers(object $metrics, QueueConfiguration $config): int;
    public function getLastReason(): string;
    public function getLastPrediction(): ?float;
}

// Policy Contract
interface ScalingPolicyContract
{
    public function beforeScaling(object $metrics, QueueConfiguration $config, int $currentWorkers): void;
    public function afterScaling(ScalingDecision $decision, QueueConfiguration $config, int $currentWorkers): void;
}

Key Classes

  • AutoscaleManager - Main orchestrator
  • ScalingEngine - Decision calculation
  • QueueConfiguration - Per-queue settings
  • ScalingDecision - Scaling decision result
  • WorkerPool - Worker collection management
  • WorkerProcess - Individual worker process

See Also