Skip to content

Commit d3bb407

Browse files
psteinroeclaude
andcommitted
docs: add message format documentation
Document the XADD command structure and example stream entry format. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent 5368986 commit d3bb407

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

src/sink/redis_streams.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@
44
//! 1. `stream` key in event metadata (from subscription's metadata/metadata_extensions)
55
//! 2. Fallback to `stream_name` in sink config
66
//!
7+
//! # Message Format
8+
//!
9+
//! Each event is added to the stream using `XADD` with:
10+
//! - Auto-generated stream entry ID (`*`)
11+
//! - Single field: `payload` containing the JSON-serialized event payload
12+
//!
13+
//! Example entry when read with `XREAD`:
14+
//! ```text
15+
//! 1704067200000-0 payload {"id": 1, "name": "test"}
16+
//! ```
17+
//!
718
//! # Dynamic Routing
819
//!
920
//! The target stream can be configured per-event using metadata_extensions:

0 commit comments

Comments
 (0)