Edit memory for on-premise runtime (Windows)

Last modified by Erik Bakker on 2024/02/21 21:42

Note that the functionality mentioned in this microlearning will become obsolete when migrating to the 3rd generation runtime.

Sometimes you have runtimes running on-premises. What we mean by that is that the runtimes are running within a data center of the customer instead of running in the eMagiz Cloud. For running a runtime on-premise we support running them on either Windows or Linux as the operating system. In this microlearning, we will learn how you can edit the memory settings of a runtime that is deployed on-premise on Windows.

Should you have any questions, please contact academy@emagiz.com.

1. Prerequisites

  • Basic knowledge of the eMagiz platform

2. Key concepts

This microlearning centers on editing the memory settings for an on-premise runtime that is running on Windows

With an on-premise runtime we mean: A runtime that is running within a data center of the customer instead of running in the eMagiz Cloud

The focal point of this microlearning will be to learn how you can safely edit the memory settings for an on-premise runtime running on Windows

  • The key aspects are:
    • eMagiz can help you determine the correct size you need to configure via Design -> Architecture
    • You need access to the on-premise location to perform the action
    • Only change the wrapper.conf file. Nothing else

3. Edit memory for on-premise runtime (Windows)

Sometimes you have runtimes running on-premises. What we mean by that is that the runtimes are running within a data center of the customer instead of running in the eMagiz Cloud. For running a runtime on-premise we support running them on either Windows or Linux as the operating system. In this microlearning, we will learn how you can edit the memory settings of a runtime that is deployed on-premise on Windows.

The focal point of this microlearning will be to learn how you can safely edit the memory settings for an on-premise runtime running on Windows

  • The key aspects are:
    • eMagiz can help you determine the correct size you need to configure via Design -> Architecture
    • You need access to the on-premise location to perform the action
    • Only change the wrapper.conf file. Nothing else

3.1 Check adviced size

Within Design Architecture you can see for each connector runtime what the advised sizing of eMagiz is based on how you have configured your integration data model. To do so navigate to Design -> Architecture and open the context menu on connector runtime level via a right mouse click.

intermediate-solution-architecture-edit-memory-on-premise-runtime-windows--context-menu-view.png

When selecting the option View container a pop-up will be shown. Within this pop-up, you will see the advised heap and non-heap memory settings of that particular runtime.

intermediate-solution-architecture-edit-memory-on-premise-runtime-windows--pop-up-details.png

3.2 Edit memory

Now that we know what the advised size is we can navigate to our on-premise location to edit the memory settings. Below we will detail the various steps needed to make this happen.

  1. At first we navigate to the etc folder of your runtime installation which is named according to the following naming convention -> emagiz*{technicalbusname}-{containertype}-{technicalnameofruntime}*{environment}. In this example that would mean emagiz_commupd-connector-ordsys_test.

intermediate-solution-architecture-edit-memory-on-premise-runtime-windows--etc-folder-location.png

2. Within this folder you will find a wrapper.conf file that is named based on the runtime name.

intermediate-solution-architecture-edit-memory-on-premise-runtime-windows--wrapper-conf-file.png

3. When you open this file you can change the memory settings, both heap, and metaspace. In the figures shown below, you can see which parts of the file you need to change to change the memory settings.

Heap memory:

intermediate-solution-architecture-edit-memory-on-premise-runtime-windows--heap-memory.png

Metaspace memory:

intermediate-solution-architecture-edit-memory-on-premise-runtime-windows--metaspace-memory.png

4. Save the file as administrator
5. Restart the runtime to ensure your changes have been actualized

4. Key takeaways

  • The key aspects are:
    • eMagiz can help you determine the correct size you need to configure via Design -> Architecture
    • You need access to the on-premise location to perform the action
    • Only change the wrapper.conf file. Nothing else

5. Suggested Additional Readings

None