Java Buildpack Memory Calculator

The Java Buildpack Memory Calculator calculates a holistic JVM memory configuration with the goal of ensuring that applications perform well while not exceeding a container's memory limit and being recycled.

In order to perform this calculation, the Memory Calculator requires the following input:

• --total-memory: total memory available to the application, typically expressed with size classification (B, K, M, G, T)
• --loaded-class-count: the number of classes that will be loaded when the application is running
• --thread-count: the number of user threads
• --jvm-options: JVM Options, typically JAVA_OPTS
• --head-room: percentage of total memory available which will be left unallocated to cover JVM overhead

The Memory Calculator prints the calculated JVM configuration flags (excluding any that the user has specified in --jvm-options). If a valid configuration cannot be calculated (e.g. more memory must be allocated than is available), an error is printed and a non-zero exit code is returned. In order to override a calculated value, users should pass any of the standard JVM configuration flags into --jvm-options. The calculation will take these as fixed values and adjust the non-fixed values accordingly.

Install

$ go get -v github.com/cloudfoundry/java-buildpack-memory-calculator

Algorithm

The following algorithm is used to generate the holistic JVM memory configuration:

1. Headroom amount is calculated as total memory * (head room / 100).

2. If -XX:MaxDirectMemorySize is configured it is used for the amount of direct memory. If not configured, 10M (in the absence of any reasonable heuristic) is used.

3. If -XX:MaxMetaspaceSize is configured it is used for the amount of metaspace. If not configured, then the value is calculated as (5800B * loaded class count) + 14000000b.

4. If -XX:ReservedCodeCacheSize is configured it is used for the amount of reserved code cache. If not configured, 240M (the JVM default) is used.

5. If -Xss is configured it is used for the size of each thread stack. If not configured, 1M (the JVM default) is used.

6. If -Xmx is configured it is used for the size of the heap. If not configured, then the value is calculated as

   total memory - (headroom amount + direct memory + metaspace + reserved code cache + (thread stack * thread count))
   

Broadly, this means that for a constant application (same number of classes), the non-heap overhead is a fixed value. Any changes to the total memory will be directly reflected in the size of the heap. Adjustments to the non-heap memory configuration (e.g. stack size, reserved code cache) can result in larger heap sizes, but can also have negative runtime side effects that must be taken into account.

For example, with a 1G memory limit, you have a heap size of 1G - (0 headroom + 10M direct + X metaspace + 240M + 250 threads * 1M thread memory) which means you have heap space = 524M - X metaspace. Metaspace is often around 100M for a typical Spring Boot app, so in that situation it leaves us with around 424M of heap space. If you shift your memory limit to 768M then you end up with heap space = 268M - X metaspace or 168M with a typical Spring Boot app (100M metaspace). As you can see, when the memory limit goes below 1G, the formula used by the memory calculator prioritizes the non-heap space and heap space suffers.

Every application is different, but for best results, it is recommended that when running with a memory limit below 1G the user apply some manual adjustments to the memory limits. For example, you can lower the thread stack size, the number of threads, or the reserved code cache size. This will allow you to save more room for the heap. Just be aware that each of these tunings has a trade-off for your application in terms of scalability (threads) or performance (code cache), and this is why the memory calculator prioritizes these settings over the heap. As a human, you need to test/evaluate the trade-offs for a given application and decide what works best for the application.

Compressed class space size

According to the HotSpot GC Tuning Guide:

The MaxMetaspaceSize applies to the sum of the committed compressed class space and the space for the other class metadata.

Therefore the memory calculator does not set the compressed class space size (-XX:CompressedClassSpaceSize) since the memory for the compressed class space is bounded by the maximum metaspace size (-XX:MaxMetaspaceSize).

License

The Java Buildpack Memory Calculator is Open Source software released under the Apache 2.0 license.