Doc: Format examples for easier parsing (#90)

Bump to v1.4.7 Co-authored-by: Rob Bavey <rob.bavey@elastic.co>
logstash-plugins · Jun 7, 2024 · 64e90a5 · 64e90a5
1 parent 4e1d98e
commit 64e90a5
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 1.4.7
+  - [DOCS] Clarify examples for single and multiple event hubs [#90](https://github.com/logstash-plugins/logstash-input-azure_event_hubs/pull/90)
+
 ## 1.4.6
   - [DOCS] Add outbound port requirements for Event Hub [#88](https://github.com/logstash-plugins/logstash-input-azure_event_hubs/pull/88)
 

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.4.6
+1.4.7
diff --git a/docs/index.asciidoc b/docs/index.asciidoc
@@ -124,13 +124,24 @@ NOTE: Threads are currently available only as a global setting across all event
 input definition. However if your configuration includes multiple `azure_event_hubs` inputs, the threads setting applies
 independently to each.
 
-**Sample scenarios** 
+**Example: Single event hub**
 
-* Event Hubs = 4. Partitions on each Event Hub = 3.
-Minimum threads is 5 (4 Event Hubs plus one).
-* If you’re collecting activity logs from one event hub instance, 
-then only 2 threads (1 Event Hub plus one) are required.
+If you’re collecting activity logs from one event hub instance, 
+then only 2 threads are required.
 
+* Event hubs = 1
+* Minimum threads = 2 (1 Event Hub + 1)
+
+**Example: Multiple event hubs**
+
+If you are collecting activity logs from more than event hub instance, then at least 1 thread per event hub is required.
+
+* Event hubs = 4 
+* Minimum threads = 5 (4 Event Hubs + 1) 
+
+When you are using multiple partitions per event hub, you may want to assign more threads.
+A good base level is (1 + `number of event hubs * number of partitions`).
+That is, one thread for each partition across all event hubs. 
 
 [id="plugins-{type}s-{plugin}-eh_config_models"]
 ==== Configuration models