From 2847f0f3a93cae75c9b0720c859a5070d30dff16 Mon Sep 17 00:00:00 2001 From: Johannes Dillmann Date: Mon, 15 Apr 2024 08:39:55 +0200 Subject: [PATCH] Document BPL_JVM_CLASS_ADJUSTMENT --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d8d8e57..8f72a42 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,7 @@ The buildpack will do the following if a JRE is requested: | `$BPL_JVM_HEAD_ROOM` | Configure the percentage of headroom the memory calculator will allocated. Defaults to `0`. | | `$BPL_JVM_LOADED_CLASS_COUNT` | Configure the number of classes that will be loaded at runtime. Defaults to 35% of the number of classes. | | `$BPL_JVM_THREAD_COUNT` | Configure the number of user threads at runtime. Defaults to `250`. | +| `$BPL_JVM_CLASS_ADJUSTMENT` | Absolute or percentage based adjustment of the memory calculator's class count, which influences various memory settings of the JVM. This is useful when the number of classes cannot be reliably determined during build-time and workloads run into OOM situations. Defaults to `100%`. | | `$BPL_HEAP_DUMP_PATH` | Configure the location for writing heap dumps in the event of an OutOfMemoryError exception. Defaults to ``, which disables writing heap dumps. The path set must be writable by the JVM process. | | `$BPL_JAVA_NMT_ENABLED` | Configure whether Java Native Memory Tracking (NMT) is enabled. Defaults to `true`. Set this to `false` to disable NMT functionality. | | `$BPL_JAVA_NMT_LEVEL` | Configure the level of detail for Java Native Memory Tracking (NMT) output. Defaults to `summary`. Set this to `detail` for detailed NMT output. |