Weave Code
Module Cms Observability Laravel Package
liberusoftware/module-cms-observability
Observability module for the Liberu CMS: adds structured logging, metrics, tracing, and health checks so you can monitor content operations, diagnose failures, and track performance across your Laravel application.
Liberusoftware Module CMS Observability provides drop-in observability tooling for Laravel-based CMS modules. It instruments content operations—page renders, cache hits, query paths, and publishing events—so you can trace slow requests and surface failures before they reach editors.
- Structured logging with consistent, CMS-aware context on every event
- Performance metrics for renders, queries, and cache behaviour
- Health checks and readiness probes tailored to CMS modules
- Tracing hooks that plug into existing Laravel logging and monitoring stacks
- Lightweight, config-driven setup with no changes to your module code
Frequently asked questions about Module Cms Observability
- What is liberusoftware/module-cms-observability used for?
- It is the observability module for Liberu CMS, a Laravel-based content management system. It adds a public readiness probe backed by a health-check registry that other modules can contribute to, plus a backend-agnostic metrics recorder and tracing hooks. In practice it helps you surface errors and performance insights in content-driven applications without wiring up a full monitoring stack first.
- How do I install the observability module in a Laravel Liberu CMS application?
- Install it with Composer as liberusoftware/module-cms-observability in your application. Because it is a Liberu CMS module, it is expected to follow the same module registration and configuration conventions as the rest of the CMS package set. Publish and review the module configuration before enabling the public readiness endpoint in any shared environment.
- Which Laravel versions does this module support?
- The provided package overview and README excerpt do not list specific Laravel version constraints. Check the illuminate/support and php requirements in the package's composer.json for the authoritative answer. Matching the module's constraints to your CMS core version is the safest way to avoid conflicts.
- How does the public readiness probe work?
- The module exposes a readiness endpoint that reports whether the application is ready to serve traffic. It is backed by a health-check registry, so the result reflects the checks contributed by your installed modules rather than a single hard-coded test. Because the endpoint is public by design, treat its output as sensitive and review how much detail you expose in production.
- How do I register a custom health check from my own module?
- The module is built around a health-check registry that other modules contribute to, so custom checks are added through that registry rather than by editing the core probe. Register your check in your module's service provider so it runs whenever the readiness probe is evaluated. Keep individual checks fast and side-effect free, since they run on a request path.
- What metrics can the recorder collect and which backends does it support?
- The metrics recorder is described as backend-agnostic, meaning the recording layer does not lock you into one vendor or storage engine. You record metrics through the module and decide where they go via configuration and adapters. This lets you start simple and later point the same instrumentation at a hosted or self-managed backend.
- What is the zero-infra log-channel default and when should I switch away from it?
- Out of the box the module writes observability data through a log channel, which means no Redis, collector, or external service is required to get started. That default is ideal for small deployments, staging environments, and early development. Move to a dedicated metrics or tracing backend once log volume grows or you need dashboards, alerting, and historical querying.
- Does this module replace Sentry, Prometheus, or a full APM platform?
- No. It provides the instrumentation layer inside your Laravel CMS: health checks, a readiness probe, a metrics recorder, logging, and tracing hooks. Those signals still need somewhere to go, and the backend-agnostic design lets you forward them to an APM or metrics platform of your choice. Think of it as the plumbing rather than the dashboard.
- Does the module support distributed tracing?
- The package description states that it adds logging, metrics, health checks, and tracing hooks for monitoring content-driven applications. The tracing support is exposed as hooks, so you connect them to the tracing backend you already use. Consult the module configuration to see which hooks are available in your installed version.
- How do I configure and test the observability module before deploying?
- Configuration is config-driven, so review the module's config file and environment variables for the probe route, health checks, metrics, and log channel settings. Locally, hit the readiness endpoint and confirm each registered health check returns the expected status, then verify metrics appear wherever your configured channel sends them. Repeat the same checks in a staging environment before making the readiness probe publicly reachable in production.
Weaver
How can I help you explore Laravel packages today?