Merge pull request #389 from paketo-buildpacks/modulo11-patch-1

Document BPL_JVM_CLASS_ADJUSTMENT
paketo-buildpacks · Apr 15, 2024 · f853c7c · f853c7c
2 parents fb04e83 + 8297343
commit f853c7c
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,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_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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
 | `$BPL_JMX_ENABLED`            | Configure whether Java Management Extensions (JMX) is enabled. Defaults to `false`. Set this to `true` to enable JMX functionality.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |