Weave Code
Monitor Bundle Laravel Package
openconext/monitor-bundle
OpenConext Monitor Bundle adds health and status monitoring endpoints to Symfony services, exposing service metadata, availability checks, and diagnostic details for operations dashboards and uptime monitoring.
Openconext bundle for monitoring endpoints
Frequently asked questions about Monitor Bundle
- Is openconext/monitor-bundle compatible with Laravel?
- No, not directly. It is an OpenConext Symfony bundle that ships a Bundle subclass, a DI extension, service tags for checks, and a controller returning symfony/http-foundation responses. Laravel can only adopt it by reusing the plain PHP check layer behind its own route, or by running it as a thin Symfony sidecar. Treat installing the bundle and reusing the check library as two separate adoption decisions.
- How do I install openconext/monitor-bundle?
- Install it with composer require openconext/monitor-bundle inside a Symfony application, then register the bundle and expose the health routes. Custom checks are added by implementing CheckInterface and tagging the service. There is no equivalent one-step installation path for Laravel, since Laravel does not use Symfony bundle registration.
- How would I add health and status endpoints to a Laravel app with this package?
- You would port the reusable pieces: a service provider or config-driven registry that instantiates the check classes, a controller that serialises the aggregated result, and a route group for the endpoint. Plan for roughly one to two sprints of small, low-complexity work. Most of the effort goes into deciding which built-in checks are meaningful outside an OpenConext deployment.
- What endpoints does the bundle expose?
- It exposes health, info, and status endpoints, typically at /health, /info, and /status, for operations dashboards and uptime monitors. The health endpoint returns the aggregated check result, while info and status expose service metadata and diagnostic details. Confirm the exact paths and payloads in the bundle's routing configuration before wiring your monitor to them.
- Does a failing check make the health endpoint report unhealthy?
- This is the key thing to verify yourself. In release 4.3.1 a check that fails to instantiate is caught rather than propagating, which prevents one broken check from taking down the whole endpoint. The risk is fail-open reporting: if the skipped check is omitted or shown as passing or unknown, an aggregator may read that as healthy. Confirm fail-closed behaviour against the implementation, not the changelog.
- Are check instantiation errors logged when a check fails?
- The changelog alone does not tell you, so inspect the code path around the new try/catch. You want a log line at an alertable level, otherwise misconfiguration such as a renamed class or dropped constructor dependency stays invisible behind a green endpoint. If the exception is discarded, add your own logging around the check registry.
- What PHP and Symfony versions does it require?
- The declared constraints live in the package's composer.json, so check them against your runtime and your existing symfony/* pins before adopting. This matters especially if you are on an older Symfony LTS or a newer PHP minor. For a Laravel adapter, only the PHP constraint applies, since you would not install the bundle wiring.
- Are the /info and /status endpoints safe to expose publicly?
- Treat them as internal by default. They can expose version strings, environment names, dependency details, and service topology, all of which help an attacker fingerprint your stack. Put authentication or a network restriction in front of them and inspect the actual response payload before exposing anything beyond your monitoring network.
- Can I reuse the check classes in Laravel without the bundle?
- Yes, the genuinely portable part is the check abstraction: CheckInterface, the built-in checks, and the status and health aggregation, all plain PHP. The bundle, DI extension, service tags, and routing are Symfony-specific and must be replaced by a Laravel service provider and controller. Audit each built-in check first, because some assume OpenConext infrastructure such as SAML metadata endpoints or specific service topologies.
- What is the maintenance status, license, and risk of upgrading?
- Release 4.3.1 is a low-risk patch containing a typo fix and a try/catch around check instantiation, with no API, deprecation, or configuration schema changes, so it is a drop-in replacement for 4.3.0. Before committing, review the repository for release cadence, maintainer count, open-issue backlog, and any stated 4.3.x support horizon, and read the LICENSE for redistribution and modification terms. If uniform health data across mixed services matters, also evaluate running the bundle as a small Symfony sidecar that Laravel scrapes.
Weaver
How can I help you explore Laravel packages today?