Skip to content

Commit 96dac92

Browse files
committed
Merge branch '520-java-opts-docs'
2 parents d3c7a50 + 972a559 commit 96dac92

File tree

1 file changed

+11
-23
lines changed

1 file changed

+11
-23
lines changed

docs/framework-java_opts.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -67,44 +67,32 @@ from_environment: false
6767
java_opts: -Xloggc:$PWD/beacon_gc.log -verbose:gc
6868
```
6969
70-
## Memory Settings
71-
72-
The following `JAVA_OPTS` are restricted and will cause the application to fail deployment.
73-
74-
* `-Xms`
75-
* `-Xmx`
76-
* `-Xss`
77-
* `-XX:MaxMetaspaceSize`
78-
* `-XX:MaxPermSize`
79-
* `-XX:MetaspaceSize`
80-
* `-XX:PermSize`
81-
82-
### Allowed Memory Settings
83-
84-
Setting any of the allowed memory settings may require a change to the [Memory Weightings]. Where a value is shown it is the default value for that setting.
70+
## Allowed Memory Settings
8571
8672
| Argument| Description
8773
| ------- | -----------
88-
| `-Xmn <SIZE>` | Maximum size of young generation, known as the eden region. **This could effect the total heap size [Memory Weightings].**
74+
| `-Xms` | Minimum or initial size of heap.
75+
| `-Xss` | Size of each thread's stack. **This could effect the total heap size. [JRE Memory]**
76+
| `-XX:MaxMetaspaceSize` | The maximum size Metaspace can grow to. **This could effect the total heap size. [JRE Memory]**
77+
| `-XX:MaxPermSize` | The maximum size Permgen can grow to. Only applies to Java 7. **This could effect the total heap size. [JRE Memory]**
78+
| `-Xmn <SIZE>` | Maximum size of young generation, known as the eden region.
8979
| `-XX:+UseGCOverheadLimit` | Use a policy that limits the proportion of the VM's time that is spent in GC before an `java.lang.OutOfMemoryError` error is thrown.
9080
| `-XX:+UseLargePages` | Use large page memory. For details, see [Java Support for Large Memory Pages].
9181
| `-XX:-HeapDumpOnOutOfMemoryError` | Dump heap to file when `java.lang.OutOfMemoryError` is thrown.
9282
| `-XX:HeapDumpPath=<PATH>` | Path to directory or filename for heap dump.
9383
| `-XX:LargePageSizeInBytes=<SIZE>` | Sets the large page size used for the Java heap.
94-
| `-XX:MaxDirectMemorySize=<SIZE>` | Upper limit on the maximum amount of allocatable direct buffer memory. **This could effect the [Memory Weightings].**
84+
| `-XX:MaxDirectMemorySize=<SIZE>` | Upper limit on the maximum amount of allocatable direct buffer memory. **This could effect the total heap size. [JRE Memory]**
9585
| `-XX:MaxHeapFreeRatio=<RATIO>` | Maximum percentage of heap free after GC to avoid shrinking.
96-
| `-XX:MaxNewSize=<SIZE>` | Maximum size of new generation. Since `1.4`, `MaxNewSize` is computed as a function of `NewRatio`. **This could effect the total heap size [Memory Weightings].**
86+
| `-XX:MaxNewSize=<SIZE>` | Maximum size of new generation. Since `1.4`, `MaxNewSize` is computed as a function of `NewRatio`.
9787
| `-XX:MinHeapFreeRatio=<RATIO>` | Minimum percentage of heap free after GC to avoid expansion.
9888
| `-XX:NewRatio=<RATIO>` | Ratio of old/new generation sizes. 2 is equal to approximately 66%.
99-
| `-XX:NewSize=<SIZE>` | Default size of new generation. **This could effect the total heap size [Memory Weightings].**
89+
| `-XX:NewSize=<SIZE>` | Default size of new generation.
10090
| `-XX:OnError="<CMD ARGS>;<CMD ARGS>"` | Run user-defined commands on fatal error.
101-
| `-XX:OnOutOfMemoryError="<CMD ARGS>;<CMD ARGS>"` | Run user-defined commands when an `java.lang.OutOfMemoryError` is first thrown.
102-
| `-XX:ReservedCodeCacheSize=<SIZE>` | _Java 8 Only_ Maximum code cache size. Also know as `-Xmaxjitcodesize`. **This could effect the [Memory Weightings].**
91+
| `-XX:ReservedCodeCacheSize=<SIZE>` | _Java 8 Only_ Maximum code cache size. Also know as `-Xmaxjitcodesize`. **This could effect the total heap size. [JRE Memory]**
10392
| `-XX:SurvivorRatio=<RATIO>` | Ratio of eden/survivor space. Solaris only.
10493
| `-XX:TargetSurvivorRatio=<RATIO>` | Desired ratio of survivor space used after scavenge.
105-
| `-XX:ThreadStackSize=<SIZE>` | Thread stack size. (0 means use default stack size).
10694

10795
[`config/java_opts.yml`]: ../config/java_opts.yml
10896
[Configuration and Extension]: ../README.md#configuration-and-extension
10997
[Java Support for Large Memory Pages]: http://www.oracle.com/technetwork/java/javase/tech/largememory-jsp-137182.html
110-
[Memory Weightings]: jre-open_jdk_jre.md#memory-weightings
98+
[JRE Memory]: jre-open_jdk_jre.md#memory

0 commit comments

Comments
 (0)