Skip to content

Commit 840cc2f

Browse files
mfernestclaudeFeediver1github-actions[bot]prakhargarg105
authored
fix(broker): add conceptual intro, use case, and naming clarification (#384)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: prakhargarg105 <prakhar.garg@redpanda.com> Co-authored-by: vbotbuildovich <62446873+vbotbuildovich@users.noreply.github.com> Co-authored-by: JakeSCahill <45230295+JakeSCahill@users.noreply.github.com> Co-authored-by: Joyce Fee <joyce@redpanda.com> Co-authored-by: micheleRP <michele@redpanda.com>
1 parent 60e1aaa commit 840cc2f

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
memory/
12
node_modules
23
.vscode
34
docs

modules/components/pages/outputs/broker.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,11 @@
1010
component_type_dropdown::[]
1111

1212

13-
Allows you to route messages to multiple child outputs using a range of brokering <<patterns>>.
13+
A meta-output that routes messages to child outputs using a range of brokering <<patterns,patterns>>. Unlike regular outputs, `broker` doesn't send messages anywhere by itself. Instead, it wraps other outputs and controls how messages are delivered across them.
1414

15+
Use `broker` to fan out the same message to multiple destinations (for example, publishing events to Kafka while also writing them to a database), or to distribute messages across a pool of outputs for load balancing or throughput scaling. The delivery pattern determines whether each message is written to all outputs or routed to a single output, and whether writes happen in parallel or in sequence.
16+
17+
NOTE: The name `broker` refers to the brokering delivery pattern, not a Redpanda broker (cluster node).
1518

1619
[tabs]
1720
======
@@ -57,7 +60,9 @@ include::redpanda-connect:components:partial$fields/outputs/broker.adoc[]
5760

5861
== Patterns
5962

60-
The broker pattern determines the way in which messages are allocated and can be chosen from the following:
63+
The broker pattern determines how messages are distributed across outputs. Use `fan_out` (the default) when every output should receive every message. Use `round_robin` or `greedy` when you want to distribute messages across outputs for load balancing rather than duplication.
64+
65+
The available patterns are:
6166

6267
=== `fan_out`
6368

0 commit comments

Comments
 (0)