Skip to main content
Version: Next

Getting started

All distributions of Optimize come with a predefined set of configuration options that can be overwritten by the user, based on current environment requirements. To do that, have a look into the folder named config. There are two files, one called environment-config.yaml with values that override the default Optimize properties and another called environment-logback.xml, which sets the logging configuration.

You can see all supported values and read about logging configuration here.

Optimize web container configuration​

Refer to the configuration section on container settings for more information on how to adjust the Optimize web container configuration.

Elasticsearch/OpenSearch configuration​

You can customize the Elasticsearch/OpenSearch connection settings as well as the index settings.

Camunda 7 configuration​

Camunda 7 only

To perform an import and provide the full set of features, Optimize requires a connection to the REST API of the Camunda engine. For details on how to configure the connection to the Camunda 7, refer to the Camunda 7 configuration section.

Camunda 8 specific configuration​

For Camunda 8, Optimize is importing process data from exported zeebe records as created by the Zeebe Elasticsearch Exporter (or Zeebe OpenSearch Exporter) from the same cluster that Optimize used to store its own data. For the relevant configuration options, refer to the Camunda 8 import configuration.

Adjust engine heap size​

Sending huge process definition diagrams via Rest API might cause the engine to crash if the engine heap size is inadequately limited. Thus, it is recommended to increase the heap size of the engine to at least 2 GB; for example, by adding the following Java command line property when starting the engine:

-Xmx2048m

For Camunda 7, it is also recommended to decrease the deployment cache size to 500, e.g. by:

<property name="cacheCapacity" value="500" />

Adjust Optimize heap size​

By default, Optimize is configured with 1GB JVM heap memory. Depending on your setup and actual data, you might still encounter situations where you need more than this default for a seamless operation of Optimize. To increase the maximum heap size, you can set the environment variable OPTIMIZE_JAVA_OPTS and provide the desired JVM system properties; for example, for 2GB of Heap:

OPTIMIZE_JAVA_OPTS=-Xmx2048m

Maximum result limits for queries​

It's possible that engine queries consume a lot of memory. To mitigate this risk, you can limit the number of results a query can return. If you do this, we recommended setting the value of the queryMaxResultsLimit to 10000 so that the Optimize import works without any problems. This value should still be low enough so you don't run into any problems with the previously mentioned heap configurations.