Skip to content

Commit

Permalink
[Doc] add memory suggestion (#454)
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
4 people authored Aug 15, 2022
1 parent d8b3ca5 commit 02ff81f
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## 6.4.1
- [DOC] Add direct memory example [#454](https://github.com/logstash-plugins/logstash-input-beats/pull/454)

## 6.4.0
- Feat: review and deprecate ssl protocol/cipher settings [#450](https://github.com/logstash-plugins/logstash-input-beats/pull/450)

Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
6.4.0
6.4.1
14 changes: 14 additions & 0 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,19 @@ will be similar to events directly indexed by {plugin-uc} into Elasticsearch.
endif::[]


[id="plugins-{type}s-{plugin}-memory"]
===== Memory usage

This plugin uses "off-heap" direct memory in addition to heap memory.
By default, a JVM's off-heap direct memory limit is the same as the heap size.
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.
You can set the amount of direct memory with `-XX:MaxDirectMemorySize` in {logstash-ref}/jvm-settings.html[Logstash JVM Settings].
Consider setting direct memory to half of the heap size.
Setting direct memory too low decreases the performance of ingestion.

NOTE: Be sure that heap and direct memory combined does not exceed the total memory available on the server to avoid an OutOfDirectMemoryError


//Content for Beats
ifeval::["{plugin}"=="beats"]
[id="plugins-{type}s-{plugin}-multiline"]
Expand All @@ -101,6 +114,7 @@ plugin] to handle multiline events. Doing so will result in the failure to start
Logstash.
endif::[]


//Content for Beats
ifeval::["{plugin}"=="beats"]
[id="plugins-{type}s-{plugin}-versioned-indexes"]
Expand Down

0 comments on commit 02ff81f

Please sign in to comment.