Skip to content

[kernel-1116] browser logging: Event Schema & Pipeline#184

Open
archandatta wants to merge 10 commits intomainfrom
archand/kernel-1116/browser-logging
Open

[kernel-1116] browser logging: Event Schema & Pipeline#184
archandatta wants to merge 10 commits intomainfrom
archand/kernel-1116/browser-logging

Conversation

@archandatta
Copy link
Copy Markdown
Contributor

@archandatta archandatta commented Mar 23, 2026

Note

Medium Risk
Introduces new concurrency-heavy event ingestion and persistence code (ring buffer fan-out, atomic sequencing, and file appends), which can impact reliability and performance under load. Also adds truncation logic that may drop payload data when events exceed the 1MB limit.

Overview
Adds a new events package implementing a canonical BrowserEvent schema (category/source/detail level fields) and a capture pipeline that stamps capture_session_id, monotonic seq, and timestamps, then enforces a 1MB max record size by truncating oversized data and marking events as truncated.

Implements two sinks: a non-blocking in-memory RingBuffer with per-reader cursors and an events.dropped sentinel when readers fall behind, and a per-category JSONL FileWriter that lazily opens <category>.log files and serializes concurrent writes. Includes extensive unit tests covering serialization, overflow/drop behavior, concurrent readers/writers, file routing, sequencing, and truncation.

Written by Cursor Bugbot for commit 36cff2d. This will update automatically on new commits. Configure here.

@archandatta archandatta marked this pull request as ready for review March 24, 2026 12:50
@archandatta archandatta force-pushed the archand/kernel-1116/browser-logging branch from 09ed5ed to 29f2bbf Compare March 24, 2026 13:21
Copy link
Copy Markdown
Contributor

@rgarcia rgarcia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice direction on the pipeline/schema. one thing i'd consider before cementing BrowserEvent v1: if this is eventually going to drive both capture controls (for example: "turn on cdp console only" or "turn on network request/response capture at headers-only detail") and subscriptions, it might be worth making those selector dimensions first-class in the envelope instead of encoding too much into a single type string.

concretely, i think i'd lean toward:

  • keeping the primary event identity semantic, e.g. console.log, network.request, input.click
  • adding explicit provenance fields like source_kind (cdp, kernel_api, extension, local_process) plus source_name / source_event (for example Runtime.consoleAPICalled)
  • adding an explicit detail_level (minimal, default, verbose, raw)
  • possibly making category first-class too instead of deriving it from the type prefix

i probably would not use raw Runtime.* / Network.* as the primary type, since that makes future non-cdp producers feel awkward/second-class. i think the semantic-type + provenance split ages better if we later want to emit events from things like:

  • third-party extensions running in the browser and talking to localhost
  • vm-local helper processes/programs running alongside the browser
  • server/api-driven tool actions like screenshot/input/recording events

that shape also gives the system a much more natural control surface for both capture config and subscriptions, since selectors can operate directly on stable fields like category, topic, source_kind, and detail_level instead of needing to parse overloaded event names.

Copy link
Copy Markdown
Contributor

@Sayan- Sayan- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

focused review on the pipeline since raf had some feedback to the event schema!

// Writers never block regardless of reader count or speed.
// Readers track their position by seq value (not ring index) and receive an
// events_dropped synthetic BrowserEvent when they fall behind the oldest retained event.
type RingBuffer struct {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense to handroll. the combination of non-blocking writes with eviction, multi-reader fan-out with independent positions, synthetic drop notification, and context-aware blocking reads is pretty niche, no standard Go library covers it without significant wrapping.

// FileWriter is a per-category JSONL appender. It opens each log file lazily on
// first write (O_APPEND|O_CREATE|O_WRONLY) and serialises concurrent writes
// within a category with a single mutex.
type FileWriter struct {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doc comment says "serialises concurrent writes within a category" but the mutex is global across all categories. worth either making the comment accurate or switching to per-category mutexes.

return fmt.Errorf("filewriter: marshal: %w", err)
}

var buf bytes.Buffer
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: the bytes.Buffer alloc per write is unnecessary since we're under the mutex. can just f.Write(data) + f.Write([]byte{'\n'}) directly.


// TestConcurrentReaders: 3 readers subscribe before publish; publish 5 events;
// each reader independently reads all 5; no reader affects another.
func TestConcurrentReaders(t *testing.T) {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be good to add a test where publishing and reading happen in parallel to exercise the locking/contention paths under go test -race.

@archandatta archandatta force-pushed the archand/kernel-1116/browser-logging branch from 29f2bbf to 997edb4 Compare March 27, 2026 11:38
@archandatta archandatta force-pushed the archand/kernel-1116/browser-logging branch from b9a88df to 1644fe7 Compare March 27, 2026 13:48
Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

func truncateIfNeeded(ev BrowserEvent) (BrowserEvent, []byte) {
data, err := json.Marshal(ev)
if err != nil {
return ev, data
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Marshal error silently writes corrupt JSONL line

Low Severity

truncateIfNeeded silently swallows json.Marshal errors and returns nil data (since Marshal returns nil on error). The caller in Pipeline.Publish passes this nil data to FileWriter.Write, which executes append(nil, '\n') and writes a bare newline to the JSONL file — a corrupt, non-JSON line. The function returns no error, so the pipeline cannot detect the failure. The first error path (return ev, data) and second (return ev, nil) are also inconsistent, suggesting an oversight.

Additional Locations (1)
Fix in Cursor Fix in Web

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants