Configure profiling and memory

When Itential Platform starts a service (application or adapter), the service loads its configuration data at startup. Service configuration for each application or adapter is managed in the Service Config editor in Admin Essentials.

This page covers service configuration for profiling logs and setting maximum memory size.

CPU profiling

Itential Platform has a built-in CPU profiler to help troubleshoot performance issues and high CPU usage. It is based on V8 profiling and Node.js simple profiling.

Profiling can be enabled for Itential Platform and select applications and adapters in release version 2020.1 and higher.

Before you begin

You must have write permission to the working directory to create profiling logs.

Enable profiling for Itential Platform

In a Docker environment, set the following environment variable in /docker/startContainer:

$
PHCORE_PROFILING=true

In a shell environment, use the --prof CLI option:

$
sudo -u pronghorn node --prof server.js

Enable profiling for apps and adapters

1
{
2
  "profiling": true
3
}

Process profiler logs

The profiler writes data to a file in the working directory named isolate-*-v8.log.

To convert the log into a readable format, use the Node.js --prof-process CLI option:

$
node --prof-process isolate-0x5589eb9afae0-v8.log > isolate-0x5589eb9afae0-v8-PRETTY.log

Open the resulting file in your preferred editor to inspect the profiling data.

Remove profiler logs

After analyzing the profiling data, delete the log files to reclaim disk space.

Maximum memory size

As memory consumption approaches its limit for a service process, use maxOldSpaceSize to increase the memory limit. Add it to systemProps in the service config by navigating to Admin Essentials > Applications > Configuration > Service Config.

Sample configuration:

1
"systemProps": {
2
  "maxOldSpaceSize": 4095
3
}