Skip to content

Live Tail

Live Tail provides an operational view of events as they move through the Data Plane. It is useful for checking source shape, pipeline selection and masking during a rollout.

Enable and connect

Live Tail is disabled by default. Explicitly enable it on the private Data Plane API:

api:
  enabled: true
  auth_token: "${ENV:SLIMSTREAM_API_AUTH_TOKEN}"
  live_tail_enabled: true
  live_tail_include_raw: false

In Helm, set dataplane.config.liveTail.enabled=true; includeRaw defaults to false. Open /ui/, enter the API bearer token and select Connect. Use HTTPS outside an isolated loopback development session. The UI sends the bearer token to POST /api/v1/tail/tickets and connects using a one-use ticket that expires after 30 seconds. The permanent token is never put in the WebSocket URL or browser storage. Reconnecting requires authentication again. Ticket issuance is capped at 64 pending tickets and 32 connected clients.

Frames contain transformed events. Raw events are omitted unless live_tail_include_raw=true; enabling raw capture may disclose values removed by masking. Restrict this option to a controlled investigation and disable it afterwards. These API settings require a restart.

Use cases

  • Verify that a new source reaches the expected pipeline.
  • Confirm that sensitive values are masked before emission.
  • Inspect a controlled sample while tuning route conditions.
  • Support incident response without querying the destination SIEM.

Boundaries

Each connected client buffers at most 32 frames. Frames above 64 KiB of serialized JSON are omitted, and slow clients lose frames. This bounds inspection memory and keeps the tap ephemeral.

Live Tail is not a queue, replay mechanism or compliance archive. It is intentionally ephemeral. Use the JSONL archive emitter, DLQ files and destination metrics for durable evidence.

The metric cards include HTTP request-body bytes attempted, events receiving HTTP 2xx acceptance responses and Splunk HEC events with positive protocol ACKs. These egress counters currently cover generic HTTP JSON, Sentinel DCR and Splunk HEC only. Retries count another body attempt, and successful retry responses can count acceptance again. They are not unique event totals, full wire traffic, durable-delivery guarantees or vendor billing measurements; see Observability for their exact scope.

The embedded UI is served by the application API. Keep the API listener private or place it behind the same authentication and network controls as other administrative endpoints. Never expose profiling endpoints publicly.

Troubleshooting workflow

  1. Check /api/v1/health.
  2. Confirm ingestion metrics on /metrics.
  3. Inspect the event in Live Tail.
  4. Compare the event against the pipeline match and route condition.
  5. Check emitter errors, retries and DLQ growth.