This lesson is part of the Ignition Gateway course. You can browse the rest of the lessons below.

LESSON LIST

Autoplay Off

Supplemental Videos

LESSON

Changing Gateway Memory Allocation

Description

Learn how to change the amount of memory (RAM) dedicated to the Gateway service by editing the Ignition configuration file (ignition.conf).

Video recorded using: Ignition 8.1

Transcript

(open in window)

[00:00] In the future, there may be some situations where you need to change the amount of memory allocated to Ignition. For example, perhaps you want to scale that amount of memory based on the size of your system, or you're trying to optimize response events. The process is easy. Like all pieces of software, the Ignition service is allocated a certain amount of memory or RAM that it's allowed to run with. To see how much your system is allowed to run with, we'll start on the homepage of your Ignition gateway and click on the Status tab. Now, select the Performance page. I'm only using a fraction of the available memory in my case. We can see here that our system is allowed to use 1024 megabytes, a little over one gigabyte of RAM. You might wanna add a little more wiggle room to utilize more of the server's memory, especially if your memory usage usually floats around the maximum allocated. If we wanted to change this maximum value for memory allocation, we would need to first go into the Ignition installation directory.

[01:03] In this example, I'm working with a Windows machine, but the process is similar for MacOS or Linux. Here are the default installation directories for each operating system. Next, we'll need to find the Data directory inside the Ignition installation directory. Once we're in the Data directory, we can open up this configuration file -- the Ignition.conf file. Scroll down to the section called Wrapper Java Properties, and look for the property called Maximum Java Heap Size. The line below it called wrapper.java.maxmemory is the line that we're going to update. Right now we're using about one gigabyte of RAM here, but because I have a 64-bit system, I can bump this up a little. Let's set it to use four gigabytes of RAM, or 4096 megabytes. The value is required to be in megabytes, and it should also be a multiple of eight. For the changes to take effect, I would then need to save this and restart my gateway. One important note of caution, though.

[02:02] if the max memory here is set higher than what's currently available in the system, the Ignition service will stop and then fail to start again. It will also log an error in the wrapper.log file explaining why. If this happens, simply come back here to the Ignition.conf file, set the max memory to something more appropriate, save the file, and restart the gateway again. I've included links to the Gateway Configuration File reference, and the Ignition Default Installation Directories reference in the Ignition User Manual below this video. Please check out the articles for more details about the default installation directories and the configuration changes that can be made to the Ignition.conf file.

You are editing this transcript.

Make any corrections to improve this transcript. We'll review any changes before posting them.