CODEWITHSUNDEEP
gradlebuild.gradlejava-opts
user3105453
user3105453

Reputation: 1981

Setting JAVA_OPTS and JAVA_TOOL_OPTIONS in Gradle

Running a large Gradle build (with JDK7) I receive two OutOfMemoryErrors:

Exception: java.lang.OutOfMemoryError thrown from the UncaughtExceptionHandler in thread "main"
Exception: java.lang.OutOfMemoryError thrown from the UncaughtExceptionHandler in thread "Test worker"

When I set the two environment variables below, the build runs through and works just fine:

export JAVA_OPTS="-Xmx2048m -XX:MaxPermSize=1024m"
export JAVA_TOOL_OPTIONS="-Xmx1024m -XX:MaxPermSize=1024m -Xms768m"
./gradlew test --stacktrace
...
Picked up JAVA_TOOL_OPTIONS: -Xmx1024m -XX:MaxPermSize=1024m -Xms768m
...

Is there a way to include those settings in gradle.properties or in build.gradle? If yes, what is the correct usage?

I already tried this in build.gradle:

allprojects {
    System.setProperty('JAVA_OPTS', "-Xmx2048m -XX:MaxPermSize=1024m")
    System.setProperty('JAVA_TOOL_OPTIONS', "-Xmx1024m -XX:MaxPermSize=1024m -Xms768m")
}

but that doesn't work.

Upvotes: 9

Views: 22170

Answers (3)

Genlight
Genlight

Reputation: 16

since this question is old but still relevant, I post what i found in the official docs:

Basically, the run scripts which are generated by gradlew distZip have an argument JAVA_OPTS set which can be set via using the gradle plugin 'application' and setting it via



plugins {
    id 'application'
}

...
application {
    applicationDefaultJvmArgs = ['-Dgreeting.language=en']
}

in this example i am setting a system property 'greeting.language' to 'en'.

In similar fashion you can do set JVM args like this:

application {
    applicationDefaultJvmArgs = ['-Xmx2048m', '-XX:MaxPermSize=1024m']
}

Found this in the official docs, for Gradle 6.9.1 and newer

Upvotes: 0

Sebastian Zubrinic
Sebastian Zubrinic

Reputation: 758

From what I gather the gradlew is intended to be tweaked. So adding those environment variables in the gradlew script would be acceptable and the setting would be available in all CI environments.

Upvotes: 1

Opal
Opal

Reputation: 84854

Could you please try to create a gradle.properties file which should be located next to root build.gradle and will it with the following content:

org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=1024m

Another option is to set the required options via compileJava task, please see here and here.

Unfortunately no idea how JAVA_TOOL_OPTIONS can be set, it seems unsupported.

Upvotes: 5

Related Questions