Skip to content

FOUR-32945: Octane: Create a health check for Octane installation - #9037

Open
rodriquelca wants to merge 2 commits into
developfrom
feature/FOUR-32945
Open

FOUR-32945: Octane: Create a health check for Octane installation#9037
rodriquelca wants to merge 2 commits into
developfrom
feature/FOUR-32945

Conversation

@rodriquelca

@rodriquelca rodriquelca commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Issue & Reproduction Steps

Octane/FrankenPHP can return HTTP 500 while CLI PHP looks fine: worker ignores system php.ini, and OCTANE_* limits only apply with the project Caddyfile. No quick way to verify Octane health or worker config.

Solution

  • php artisan octane:heartbeat — liveness probe (/health/live, exit 0/1)
  • --ready — adds DB/Redis checks
  • --php-ini — compares CLI vs FrankenPHP worker vs .env
  • /health/live?format=json — worker php.ini + extensions for probes

Start Octane with --caddyfile=Caddyfile.

heartbeat.mov

How to Test

run

`# Unit + feature tests
./vendor/bin/phpunit tests/Feature/Console/OctaneHeartbeatCommandTest.php tests/unit/ProcessMaker/Health/

Liveness (Octane must be running)

php artisan octane:start --server=frankenphp --caddyfile=Caddyfile
php artisan octane:heartbeat # Status: ALIVE
php artisan octane:heartbeat -q # octane:heartbeat: alive (...)

Readiness (DB/Redis)

php artisan octane:heartbeat --ready # Platform checks: Database OK, ...

php.ini diagnostic

php artisan octane:heartbeat --php-ini # tables + exit 1 if worker ≠ .env

HTTP endpoint

curl -s http://127.0.0.1:8001/health/live
curl -s 'http://127.0.0.1:8001/health/live?format=json' | jq .`

Related Tickets & Packages

Code Review Checklist

  • I have pulled this code locally and tested it on my instance, along with any associated packages.
  • This code adheres to ProcessMaker Coding Guidelines.
  • This code includes a unit test or an E2E test that tests its functionality, or is covered by an existing test.
  • This solution fixes the bug reported in the original ticket.
  • This solution does not alter the expected output of a component in a way that would break existing Processes.
  • This solution does not implement any breaking changes that would invalidate documentation or cause existing Processes to fail.
  • This solution has been tested with enterprise packages that rely on its functionality and does not introduce bugs in those packages.
  • This code does not duplicate functionality that already exists in the framework or in ProcessMaker.
  • This ticket conforms to the PRD associated with this part of ProcessMaker.

ci:deploy

@decisions-sonarqube

Copy link
Copy Markdown

@nolanpro

nolanpro commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

QA server K8S was successfully deployed https://ci-64d58bde37.engk8s.processmaker.net

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants