Framework.Overlay.OutboxBrowser (Framework v0.5.0)

View Source

Outbox Browser for observability overlay.

Provides head/tail inspection of outbox events with filtering by correlation IDs. Essential for debugging event ordering, payload inspection, and sequence analysis.

Features

  • Head/tail event inspection
  • Correlation ID filtering
  • Schema validation status
  • Event payload visualization
  • Sequence gap detection

Summary

Functions

Get list of available event types from the outbox.

Get detailed information about a specific event by sequence.

Get recent events from the outbox (head).

Get events within a sequence range.

Get outbox statistics and health metrics.

Get oldest events from the outbox (tail).

List events with pagination support for overlay browser.

Get count of recent events within specified minutes.

Functions

available_event_types()

Get list of available event types from the outbox.

get_event_details(sequence)

Get detailed information about a specific event by sequence.

get_head(limit \\ 50, filters \\ %{})

Get recent events from the outbox (head).

Returns most recent events for real-time monitoring.

Parameters

  • limit: Number of events to return (default 50)
  • filters: Map of filter criteria
    • event_type: Filter by specific event type
    • request_id: Filter by request ID
    • client_id: Filter by client ID
    • session_id: Filter by session ID
    • schema_id: Filter by schema ID

Returns

List of outbox events with enhanced metadata

get_range(from_sequence, to_sequence, filters \\ %{})

Get events within a sequence range.

Useful for inspecting specific sequence windows and analyzing event ordering.

Parameters

  • from_sequence: Starting sequence (inclusive)
  • to_sequence: Ending sequence (inclusive)
  • filters: Optional filter criteria

Returns

List of events in sequence order with gap detection

get_stats()

Get outbox statistics and health metrics.

Returns aggregate information about outbox state and performance.

Returns

Map containing:

  • total_events: Total number of events in outbox
  • sequence_head: Highest sequence number
  • sequence_tail: Lowest sequence number
  • event_type_distribution: Count by event type
  • schema_distribution: Count by schema
  • recent_activity: Events in last hour
  • largest_gaps: Biggest sequence gaps

get_tail(limit \\ 50, filters \\ %{})

Get oldest events from the outbox (tail).

Returns earliest events for historical analysis and replay testing.

Parameters

  • limit: Number of events to return (default 50)
  • filters: Map of filter criteria (same as get_head)

Returns

List of outbox events with enhanced metadata

list_events(opts \\ [])

List events with pagination support for overlay browser.

recent_events_count(opts \\ [])

Get count of recent events within specified minutes.

search_payload(search_term, limit \\ 100, filters \\ %{})

Search events by payload content.

Performs JSONB queries on event payloads for advanced debugging.

Parameters

  • search_term: Text to search for in payload
  • limit: Maximum results (default 100)
  • filters: Additional filter criteria

Returns

List of matching events with highlighted search terms