Search by

visualbox / sentinel

ruben_tjok

Official Laravel agent for Sentinel. Batched telemetry for the VisualBox observability platform.

Package info

github.com/VBS-CodeWare/sentinel

pkg:composer/visualbox/sentinel

Statistics

Installs: 2

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v0.1.0 2026-08-08 23:59 UTC

This package is auto-updated.

Last update: 2026-11-11 17:50:16 UTC


README

Official Laravel agent for Sentinel by VisualBox Solutions.

Composer package: visualbox/sentinel

Installation

composer require visualbox/sentinel
php artisan sentinel:install

Configure .env:

SENTINEL_ENABLED=true
SENTINEL_TOKEN=sent_live_xxxxx
SENTINEL_ENDPOINT=https://your-sentinel-host
SENTINEL_SAMPLE_RATE=1.0

SENTINEL_ENDPOINT is the URL of your Sentinel instance (for example https://sentinel.example.com).

Disable during local development or PHPUnit (like Nightwatch):

SENTINEL_ENABLED=false

Event types (Nightwatch-class coverage)

Automatic collectors mirror Laravel Nightwatch core event types:

Event type Source
request HTTP middleware
query Database QueryExecuted
exception Exception handler
job Queue lifecycle
command Artisan commands
scheduled_task Scheduler
log MessageLogged
outgoing_request Laravel HTTP client
cache Cache hit / miss / write / forget
mail Outbound mail
notification Notifications

Each event includes trace identifiers (trace_id, span_id, parent_span_id), optional execution_context, authenticated user, and custom context metadata.

Commands

  • php artisan sentinel:install — publish config
  • php artisan sentinel:status — agent diagnostics
  • php artisan sentinel:deploy — record a deployment marker

Helpers

use Visualbox\Sentinel\Facades\Sentinel;

Sentinel::context('tenant_id', $tenantId);

Sentinel::ignore(function () {
    // No telemetry recorded inside this block
});

Transport

  • Batched buffer with gzip HTTP POST to /api/v1/telemetry
  • Retry/backoff and circuit breaker
  • Heartbeat to /api/v1/heartbeat
  • Deployments to /api/v1/deployments

Unlike Nightwatch, Sentinel v0.2.x sends telemetry from the web and queue worker process (no separate long-running sentinel:agent sidecar required).

Development

composer install
composer test

License

MIT