Quickstart
Quickstart
cboxdk/statamic-telemetry is a thin overlay on
cboxdk/laravel-telemetry. It
adds Statamic's vocabulary to the signals the base package already captures —
content-named request spans, the Stache and static cache, site and user
context — and ships Statamic-specific metrics. See the
Requirements before you begin.
1. Install
composer require cboxdk/statamic-telemetry
Everything is on by default except the Antlers view/tag spans and the inventory gauges (both add per-request or per-scrape cost).
2. Publish the config (optional)
Only needed if you want to change the instrument.* toggles or opt into the
gauges/Antlers spans:
php artisan vendor:publish --tag=statamic-telemetry-config
Every toggle is also settable via a STATAMIC_TELEMETRY_* env var — see the
configuration reference for the full list.
3. Import the Grafana dashboard
The addon bundles a Statamic dashboard that joins the base suite's tab bar
(same telemetry tag):
php artisan statamic-telemetry:dashboards # import into a local Grafana
php artisan statamic-telemetry:dashboards --export=./provisioning
4. (Optional) Browser tracing in Antlers
Drop the RUM snippet into your layout's <head> to root browser page-load
timing on the server trace:
{{ telemetry:browser }}
It stays correct under static caching automatically — see Browser tracing in Antlers.
Next steps
- Reference — every span attribute, metric and config toggle, and the events each derives from.
- Design notes — why the addon is built the way it is.