Skip to content

Commit 02ff81f

Browse files
kaisechengkarenzonerobbaveyyaauie
authored
[Doc] add memory suggestion (#454)
add Direct Memory example and suggestion Co-authored-by: Karen Metts <[email protected]> Co-authored-by: Rob Bavey <[email protected]> Co-authored-by: Ry Biesemeyer <[email protected]>
1 parent d8b3ca5 commit 02ff81f

File tree

3 files changed

+18
-1
lines changed

3 files changed

+18
-1
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## 6.4.1
2+
- [DOC] Add direct memory example [#454](https://github.com/logstash-plugins/logstash-input-beats/pull/454)
3+
14
## 6.4.0
25
- Feat: review and deprecate ssl protocol/cipher settings [#450](https://github.com/logstash-plugins/logstash-input-beats/pull/450)
36

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
6.4.0
1+
6.4.1

docs/index.asciidoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,19 @@ will be similar to events directly indexed by {plugin-uc} into Elasticsearch.
8888
endif::[]
8989

9090

91+
[id="plugins-{type}s-{plugin}-memory"]
92+
===== Memory usage
93+
94+
This plugin uses "off-heap" direct memory in addition to heap memory.
95+
By default, a JVM's off-heap direct memory limit is the same as the heap size.
96+
For example, setting `-Xmx10G` without setting the direct memory limit will allocate `10GB` for heap and an additional `10GB` for direct memory, for a total of `20GB` allocated.
97+
You can set the amount of direct memory with `-XX:MaxDirectMemorySize` in {logstash-ref}/jvm-settings.html[Logstash JVM Settings].
98+
Consider setting direct memory to half of the heap size.
99+
Setting direct memory too low decreases the performance of ingestion.
100+
101+
NOTE: Be sure that heap and direct memory combined does not exceed the total memory available on the server to avoid an OutOfDirectMemoryError
102+
103+
91104
//Content for Beats
92105
ifeval::["{plugin}"=="beats"]
93106
[id="plugins-{type}s-{plugin}-multiline"]
@@ -101,6 +114,7 @@ plugin] to handle multiline events. Doing so will result in the failure to start
101114
Logstash.
102115
endif::[]
103116

117+
104118
//Content for Beats
105119
ifeval::["{plugin}"=="beats"]
106120
[id="plugins-{type}s-{plugin}-versioned-indexes"]

0 commit comments

Comments
 (0)