Broadcast Events (Pusher, Laravel Reverb)
Your app pushes live updates to the browser through Laravel Reverb, Pusher or soketi: «order shipped», «new message». When the browser shows the wrong thing, you want to see what the server actually sent. Buggregator pretends to be the broadcast server's HTTP API, so every event your backend broadcasts shows up in Buggregator with its channel and data.
It can also pass each event on to your real Reverb or Pusher server, so the browser keeps getting live updates.
Available since server 2.13.0.
How it works
Your backend sends each broadcast as an HTTP request to the broadcast server (POST /apps/<app-id>/events). Point those requests at Buggregator instead:
- Capture only (the default). Buggregator stores the event and answers «ok». Browsers get nothing, so live updates stop while the app points at Buggregator.
- Capture and forward. Set
upstreamto your real server. Buggregator stores the event, sends the same request on, and gives your app the real server's answer. Browsers keep working.
Only the server side changes. The browser still connects to the real Reverb or Pusher over WebSocket; Buggregator does not speak that protocol.
Setup
Laravel Reverb
In .env, point the server-side settings at Buggregator, and keep the browser settings on the real Reverb:
BROADCAST_CONNECTION=reverb
REVERB_APP_ID=...
REVERB_APP_KEY=...
REVERB_APP_SECRET=...
# Laravel sends broadcasts to Buggregator
REVERB_HOST=127.0.0.1 # host.docker.internal when Laravel runs in Docker and Buggregator on the host
REVERB_PORT=8000 # Buggregator's HTTP port
REVERB_SCHEME=http
# Echo in the browser connects to Reverb directly
VITE_REVERB_APP_KEY="${REVERB_APP_KEY}"
VITE_REVERB_HOST=localhost
VITE_REVERB_PORT=8080 # Reverb's port
VITE_REVERB_SCHEME=httpThen let Buggregator pass the events on to Reverb, so the browser keeps getting them:
BROADCAST_UPSTREAM=http://localhost:8080 ./buggregatorTwo things to watch:
php artisan install:broadcastingwritesVITE_REVERB_HOST="${REVERB_HOST}"andVITE_REVERB_PORT="${REVERB_PORT}". OnceREVERB_HOSTpoints at Buggregator, the browser would go there too, and Buggregator does not speak WebSocket. SetVITE_REVERB_HOSTandVITE_REVERB_PORTto Reverb itself, as above.- The Reverb server listens on
REVERB_SERVER_HOSTandREVERB_SERVER_PORT(default0.0.0.0:8080), not onREVERB_HOST. ChangingREVERB_HOSTdoes not move Reverb.
Checked with Laravel 12, laravel/reverb 1.14 and Laravel Echo 2.1. In Buggregator the event name is the full class name, for example App\Events\OrderShipped; Echo's .listen('OrderShipped') keeps working.
Older Laravel apps use BROADCAST_DRIVER instead of BROADCAST_CONNECTION.
Laravel with Pusher
BROADCAST_CONNECTION=pusher
PUSHER_HOST=127.0.0.1
PUSHER_PORT=8000
PUSHER_SCHEME=httpPusher SDK
Any server SDK of Pusher works: set the host to Buggregator, port 8000, no TLS. Node.js:
const Pusher = require('pusher')
const pusher = new Pusher({
appId: '1001', key: 'app-key', secret: 'app-secret',
host: '127.0.0.1', port: '8000', useTLS: false,
})
await pusher.trigger('orders', 'OrderShipped', { id: 42 })Without upstream, any app id, key and secret work.
Forward to the real server
broadcast:
upstream: http://127.0.0.1:8080 # your real Reverb or Pusher serverOr BROADCAST_UPSTREAM=http://127.0.0.1:8080.
- Keep your real app id, key and secret in the app. Buggregator sends the same path, query and body, so the real server accepts the signature.
- Buggregator waits up to 5 seconds for the real server. Your app gets the real server's answer.
- When the real server cannot be reached, your app gets
502with the reason, and the event is still stored. - Pointed
upstreamat Buggregator itself by mistake? It notices the loop and answers508instead of sending the event around forever. - A user name and password in the
upstreamaddress are not shown in the UI. The app secret is never stored.
Check the signature
List your apps, and Buggregator checks each event's signature with the secret:
broadcast:
apps:
- key: app-key
secret: app-secretOr BROADCAST_APPS=app-key:app-secret,other-key:other-secret. The event then says valid, or invalid with a warning. Events from keys not in the list say not_checked.
Environment variables win over the file; BROADCAST_APPS replaces the whole apps list.
What you see
Broadcast in the menu opens a channel console:
- On the left, every channel that got events, with its kind (public, private, presence, encrypted) and the number of events. Type in Filter channels to find one, or pick All channels.
- On the right, the events of that channel, newest or oldest first: time, event name, size, payload.
- Open an event to see its payload, what Changed since the previous event of the same name on that channel, who sent it and to whom, the signature result and, when forwarding, the real server's answer. Copy as cURL gives the request to send it again.
A feed card for a broadcast opens the console on that event.
Each broadcast is one broadcast event: its name, channels (public, private, presence, encrypted or user), data, the socket id, the signature result and, when forwarding, the real server's status and time. A batch (triggerBatch) gives one event per item, marked with the same batch.
Buggregator adds warnings for data over 10 KB, more than 100 channels, no channel, data that is not JSON, and a signature that does not match.
API: GET /api/events?type=broadcast.
Projects
Events go to the default project. To send them to another project, add the header X-Buggregator-Project: shop. A new name creates the project with its first event. The app id does not choose the project.
In Laravel, add the header to the reverb connection in config/broadcasting.php:
'reverb' => [
// ...
'client_options' => [
'headers' => ['X-Buggregator-Project' => env('BUGGREGATOR_PROJECT', 'default')],
],
],From curl or a script you can also put the project in the address, http://broadcast:shop@127.0.0.1:8000; it wins over the header.
Limits
- Only signed
POSTrequests are broadcasts. APOSTwithoutauth_keyandauth_signatureis stored as an HTTP dump. - Channel queries (
GET /apps/<id>/channels) are not supported: Buggregator answers with its web page, not JSON, so the Pusher client fails on it. Send them to the real server. - Closing a user's connections (
terminateUserConnections) is passed on or answered, but not stored. - Data on encrypted channels is stored as sent; Buggregator cannot decrypt it.
- Turn it off with
modules.broadcast: falseinbuggregator.yaml, or leavebroadcastout ofCLIENT_SUPPORTED_EVENTS.