Modifying Java memory settings

Edge for Private Cloud v4.18.05

Depending on your traffic and processing requirements you may need to increase the heap size or class metadata size for one or more Apigee components.

To change these settings, edit the properties file for the component. If the component is installed on multiple machines, such as the Edge Message Processor, then edit the properties file on all machines hosting the component.

To set these values, set the following properties:

Property	Description
bin_setenv_min_mem	Sets the minimum heap size. The default is 256 MB. This setting corresponds to the Java -Xms option.
bin_setenv_max_mem	Sets the maximum heap size. The default is 512 MB. This setting corresponds to the Java -Xmx option.
bin_setenv_meta_space_size	Sets the default class metadata size. The default value is set to the value of bin_setenv_max_permsize, which defaults to 128 MB. On the Message Processor, Apigee recommends that you set this value to 256 MB or 512 MB, depending on your traffic. This setting corresponds to the Java -XX:MetaspaceSize option.

Set these properties for each component on the machine, using the "m" suffix to indicate megabyte. For example, for the Message Processor, set them in the /opt/apigee/customer/application/message-processor.properties file as:

bin_setenv_min_mem=512m
bin_setenv_max_mem=1024m
bin_setenv_meta_space_size=1024m

If the message-processor.properties file does not exist, or if the corresponding .properties file for any Edge component does not exist, create it and then change ownership of the file to the "apigee" user:

chown apigee:apigee /opt/apigee/customer/application/message-processor.properties

After setting the values in the .properties file, restart the component:

/opt/apigee/apigee-service/bin/apigee-service component restart

For example:

/opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

For Java settings not controlled by the properties listed above, you can also set the following in the corresponding .properties file for any Edge component:

• bin_setenv_ext_jvm_opts: Set any Java property not specified by other properties. For example:

  bin_setenv_ext_jvm_opts=-XX:MaxGCPauseMillis=500

  However, do not use bin_setenv_ext_jvm_opts to set -Xms, -Xmx, or -XX:MetaspaceSize as these values are controlled by the properties listed above.

For additional tips on configuring memory, see this article on the Edge forums.