This is an automated email from the ASF dual-hosted git repository.
exceptionfactory pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/main by this push:
new 9c79c871cc NIFI-13865 Add HeapDumpOnOutOfMemoryError description to
Admin Guide (#9579)
9c79c871cc is described below
commit 9c79c871ccc3e4f23691fb4f0b68f2e4b09b73c0
Author: Matt Burgess <[email protected]>
AuthorDate: Sat Dec 14 09:08:15 2024 -0500
NIFI-13865 Add HeapDumpOnOutOfMemoryError description to Admin Guide (#9579)
Signed-off-by: David Handermann <[email protected]>
---
nifi-docs/src/main/asciidoc/administration-guide.adoc | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/nifi-docs/src/main/asciidoc/administration-guide.adoc
b/nifi-docs/src/main/asciidoc/administration-guide.adoc
index 0e92332123..c315e9f5ed 100644
--- a/nifi-docs/src/main/asciidoc/administration-guide.adoc
+++ b/nifi-docs/src/main/asciidoc/administration-guide.adoc
@@ -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
