Apache/nifi
1
0
Fork 0
mirror of https://github.com/apache/nifi.git synced 2025-02-06 01:58:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

NIFI-13865 Add HeapDumpOnOutOfMemoryError description to Admin Guide (#9579)

Browse Source 
Signed-off-by: David Handermann <exceptionfactory@apache.org>
This commit is contained in:
Matt Burgess 2024-12-14 09:08:15 -05:00 committed by GitHub
parent 502572b2f5
commit 9c79c871cc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
nifi-docs/src/main/asciidoc/administration-guide.adoc
View File

@ -4076,6 +4076,15 @@ NiFi can be configured to automatically execute the diagnostics command in the e
In the case of a lengthy diagnostic, NiFi may terminate before the command execution ends. In this case, the `graceful.shutdown.seconds` property should be set to a higher value in the `bootstrap.conf` configuration file.
=== Automatic heap dump on Out of Memory Errors
It is possible to set properties in `bootstrap.conf` to configure NiFi to generate a heap dump when an Out of Memory (OOM) error occurs. This can be helpful to analyze for memory leaks. An example of properties to be added to `bootstrap.conf` follows:
java.arg.heapDumpPath=-XX:HeapDumpPath=./work
java.arg.heapDumpOnOutOfMemory=-XX:+HeapDumpOnOutOfMemoryError
These property values (as set in the example) will cause a heap dump to be generated into the `./work` directory. The location of the heap dump is configurable by changing the location of the `-XX:HeapDumpPath=` argument.
[[jmx_metrics]]
== JMX Metrics