Repository navigation
feat(pulse): add timeline annotations and event markers with sliding cards - #1
Merged
Merged
Conversation
…cards
- Add Event and VisibleEvent types with WithEvent, AddEvent, and AddEventAt APIs
- Render marker glyphs (▼, 🚀, ⚡) and vertical guidelines (┆) across Lines and Braille modes
- Implement dynamic age tracking and automatic garbage collection for off-screen events
- Add EventsBox() helper for Lip Gloss cards with relative age tags (now, -12)
- Handle multi-width runes and emojis in grid without column drift
- Add interactive event injection hotkey ('e') to livedemo
- Add comprehensive documentation in docs/timeline-events.md
- Add unit tests covering sliding window aging, memory pruning, and rendering
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Brings Timeline Annotations & Event Markers to Pulse, introducing a core capability inspired by cloud observability platforms (Grafana, Datadog) to terminal charts.
When monitoring metrics (CPU, latency, memory), raw spikes don't explain why something happened. This feature allows operators and developers to pin discrete engineering events (deployments, alerts, pod restarts, config changes) onto the time-series grid.
Key Changes
Eventstruct (ID,Label,Glyph,Style,NoLine) andVisibleEvent(Col,Age,Event).chart.AddEvent(ev)(pins atnow),chart.AddEventAt(offset, ev)(pins at historical step),chart.VisibleEvents(), andchart. ClearEvents().pulse.WithEvent(offset, ev).Push/PushSeries.age = current_step - event_step. Events scroll smoothly to the left as new data points arrive.col < 0) to prevent memory leaks during long-running streaming sessions.▼,🚀,⚡,⚠️) at row 0.┆) through empty space and shaded/tinted area fills without corrupting box-drawing line turns (╭,╯,─).lipgloss.Width(glyph) > 1) in the terminal grid to prevent column drift.ModeLinesandModeBraille.chart.EventsBox()helper that returns a Lip Gloss bordered card listing active events with relative age tags ((now),(-14)).examples/livedemowith interactive keyeto drop live deployment markers in real time.docs/timeline-events.mdcovering best practices, glyph selection, and code snippets.README.mdfeatures and documentation index.Type of Change
Checklist
gofmt,go vet).go test -race ./...).