roadrunner

README

[WIP]

RoadRunner is an open-source (MIT licensed) high-performance PHP application server, load balancer, and process manager. It supports running as a service with the ability to extend its functionality on a per-project basis.

RoadRunner includes PSR-7/PSR-17 compatible HTTP and HTTP/2 server and can be used to replace classic Nginx+FPM setup with much greater performance and flexibility.

Official Website | Documentation

Features:

• Production-ready
• PCI DSS compliant
• PSR-7 HTTP server (file uploads, error handling, static files, hot reload, middlewares, event listeners)
• HTTPS and HTTP/2 support (including HTTP/2 Push, H2C)
• A Fully customizable server, FastCGI support
• Flexible environment configuration
• No external PHP dependencies (64bit version required), drop-in (based on Goridge)
• Load balancer, process manager and task pipeline
• Frontend agnostic (Queue, PSR-7, GRPC, etc)
• Integrated metrics (Prometheus)
• Works over TCP, UNIX sockets and standard pipes
• Automatic worker replacement and safe PHP process destruction
• Worker create/allocate/destroy timeouts
• Max jobs per worker
• Worker lifecycle management (controller)
  • maxMemory (graceful stop)
  • TTL (graceful stop)
  • idleTTL (graceful stop)
  • execTTL (brute, max_execution_time)
• Payload context and body
• Protocol, worker and job level error management (including PHP errors)
• Very fast (~250k rpc calls per second on Ryzen 1700X using 16 threads)
• Integrations with Symfony, Laravel, Slim, CakePHP, Zend Expressive
• Application server for Spiral
• Automatic reloading on file changes
• Works on Windows (Unix sockets (AF_UNIX) supported on Windows 10)

Installation:

go get -u github.com/spiral/roadrunner/v2

For getting roadrunner binary file you can use our docker image: spiralscout/roadrunner:X.X.X (more information about image and tags can be found here)

Configuration can be located in .rr.yaml file (full sample):

http:
  address:         0.0.0.0:8080
  workers.command: "php worker.php"

Read more in Documentation.

Run:

To run application server:

$ ./rr serve -v -d

License:

The MIT License (MIT). Please see LICENSE for more information. Maintained by Spiral Scout.

Documentation

Index

• type ProcessState
  • func WorkerProcessState(w worker.BaseProcess) (ProcessState, error)

Types

type ProcessState

type ProcessState struct {
	// Pid contains process id.
	Pid int `json:"pid"`

	// Status of the worker.
	Status string `json:"status"`

	// Number of worker executions.
	NumJobs int64 `json:"numExecs"`

	// Created is unix nano timestamp of worker creation time.
	Created int64 `json:"created"`

	// MemoryUsage holds the information about worker memory usage in bytes.
	// Values might vary for different operating systems and based on RSS.
	MemoryUsage uint64 `json:"memoryUsage"`
}

ProcessState provides information about specific worker.

func WorkerProcessState

func WorkerProcessState(w worker.BaseProcess) (ProcessState, error)

WorkerProcessState creates new worker state definition.