Skip to content

Debugging Node.JS

marksvc edited this page May 26, 2025 · 11 revisions

Depending on the environment, there are different levels of debugging that can be performed on the Realtime Server

Development

You can enable debugging of the Realtime Server by adding the following entry to your usersecrets.json file:

"node-options": "--inspect=9230"

Then, open chrome://inspect in your browser, and click "Open dedicated DevTools for Node".

QA/Production

On QA and production, you are limited to generating heap snapshots and CPU profiles for 30 seconds at a time.

Warning: This will result in a temporary outage of the realtime server while the snapshot is generated!

Generating a heap snapshot and CPU profile:

  1. sudo pkill --signal USR2 --full 'node -e'

  2. Wait up to a minute for the heap snapshot and CPU profile to be generated.

These will be created in the app directory, and named:

  • scriptureforge.heapsnapshot
  • profile.cpuprofile

Download them via SCP once created.

Clone this wiki locally