How to Manage Node Applications with PM2

Node.js is an open-source JavaScript runtime that allows you to run JavaScript code outside the browser. Built on Chrome's V8 engine, it is known for its speed and scalability, making it ideal for real-time and high-performance applications. Running Node applications in production faces unique challenges — you need to handle unexpected crashes, manage processes, and ensure continuous uptime. PM2 is a Production Process Manager for Node.js applications that simplifies application management, allowing you to monitor, restart, and optimize your applications.

This article explains how to manage Node Applications with PM2, explore its essential features, and follow best practices for managing your Node applications in a production environment.

Prerequisites

Have access to your workstation as the non-root sudo user running macOS, Linux, or Windows with Node and NPM installed.

Install PM2 Using NPM

Install PM2 via the NPM package manager.
console
```
$ sudo npm install pm2 -g
```

Create an Example Node.js Application

Follow the steps below to create an example Node.js application.

Navigate to the user's home directory.
console
```
$ cd ~
```
Create a file named app.js using a text editor such as vim.
console
```
$ vim app.js
```

Add the following code to the file.

                            javascript
                            
                        
const http = require('http');

const hostname = '0.0.0.0';
const port = 3000;

const server = http.createServer((req, res) => {
    res.statusCode = 200;
    res.setHeader('Content-Type', 'text/plain');
    res.end('Hello World');
});

server.listen(port, hostname, () => {
    console.log(`Server running at http://${hostname}:${port}/`);
});

Save and exit the file.

The above app.js file is an example Node.js web application that listens on port 3000 and when it receives an HTTP request, it sends back a response with message "Hello World".

Start the Application Using PM2

Start your Node.js application with PM2. Replace app.js with your application's entry file if needed.

                            console
                            
$ pm2 start app.js

Your output should be similar to the one below:

[PM2] Starting /home/linuxuser/app.js in fork_mode (1 instance)
[PM2] Done.
┌────┬────────────────────┬──────────┬──────┬───────────┬──────────┬──────────┐
│ id │ name               │ mode     │ ↺    │ status    │ cpu      │ memory   │
├────┼────────────────────┼──────────┼──────┼───────────┼──────────┼──────────┤
│ 0  │ app                │ fork     │ 0    │ online    │ 0%       │ 4.4mb    │
└────┴────────────────────┴──────────┴──────┴───────────┴──────────┴──────────┘

Below are some additional parameters to manage your application:

--name <app_name> - specify an application name
--watch - restart your application automatically when a file changes
--max-memory-restart <memory> - a memory limit that triggers an automatic restart when reached
--log <log_file> - specify a log file
--restart-delay <delay> - delay between automatic restarts in milliseconds
--time - prefix logs with time
--no-autorestart - turn off automatic application restarts
--cron - a cron job pattern for automatic application restarts
--no-daemon - do not run the application in a daemon process

Visit the official documentation to view all available parameters.

Manage the Application

Manage your Node.js application using PM2 and perform actions like restart, reload, stop and delete PM2 processes.

Restart your PM2-managed application.
console
```
$ pm2 restart app
```
Reload your PM2-managed application.
console
```
$ pm2 reload app
```
Stop your PM2-managed application.
console
```
$ pm2 stop app
```
Delete your PM2-managed application.
console
```
$ pm2 delete app
```

List All Applications

List all the applications that are managed by PM2.
console
```
$ pm2 list
```

Display Logs

View the logs produced by your application in real-time.
console
```
$ pm2 logs
```
View older logs, by specifying the number of lines using --lines flag.
console
```
$ pm2 logs --lines 200
```

Monitor the Resource Usage

Monitor the amount of resources consumed by your applications in near real time.
console
```
$ pm2 monit
```

Set up a Web-Based Dashboard

Configure a web-based PM2 dashboard.
console
```
$ pm2 plus
```
Follow the prompts to create or log in to your PM2 account. If you don’t have an account, complete the required information to create one and accept the license agreement.

You’ll see the following output during the setup process:
```
[PM2 I/O] Do you have a pm2.io account? (y/n) n
[PM2 I/O] No problem! We just need a few details to create your account.
[PM2 I/O] Please choose a username: vultrexampleuser
[PM2 I/O] Please choose an email: admin@example.com
[PM2 I/O] Please choose a password: ************
...
[PM2 I/O] Do you accept the terms and privacy policy (https://pm2.io/legals/terms_conditions.pdf)? (y/n) y
[PM2 I/O] Successfully authenticated
[PM2 I/O] Successfully validated
[+] PM2+ activated!
[PM2 I/O] Successfully connected to bucket PM2 Plus Monitoring
[PM2 I/O] You can use the web interface here: https://app.pm2.io/#/bucket/67cb27ccd623d57f6d4c63c0
```
Replace vultrexampleuser with your preferred username, admin@example.com with your log in email address and provide a strong password to secure your PM2 account.

Next Steps:
1. Open a web browser and visit the provided web address.
2. Log in using your PM2 account credentials.
3. Start monitoring and managing your applications through the PM2 Plus dashboard.
Note
PM2 Plus is a subscription-based offering that incurs a cost, depending on the number of processes you want to monitor. You can review the pricing details on the PM2 Plus page.

Configure PM2 to Start on Server Boot

Generate a startup script and configure PM2 to start on server boot.

console

$ pm2 startup

Your output should be similar to the one below:

[PM2] To setup the Startup Script, copy/paste the following command:
sudo env PATH=$PATH:/home/linuxuser/.nvm/versions/node/v22.14.0/bin /home/linuxuser/.nvm/versions/node/v22.14.0/lib/node_modules/pm2/bin/pm2 startup systemd -u linuxuser --hp /home/linuxuser

Copy the command from previous command output and execute it to make the PM2 process persistent.

                            console
                            
$ sudo env PATH=$PATH:/home/linuxuser/.nvm/versions/node/v22.14.0/bin /home/linuxuser/.nvm/versions/node/v22.14.0/lib/node_modules/pm2/bin/pm2 startup systemd -u linuxuser --hp /home/linuxuser

Your output should be similar to the one below:

...
[PM2] Writing init configuration in /etc/systemd/system/pm2-linuxuser.service
Created symlink /etc/systemd/system/multi-user.target.wants/pm2-linuxuser.service → /etc/systemd/system/pm2-linuxuser.service.
...

Configure Applications to Start on Server Boot

Configure your PM2 applications to start automatically on server boot by saving them into an application list.

Save the running applications to the list.

console

$ pm2 save

Your output should be similar to the one below:

[PM2] Saving current process list...
[PM2] Successfully saved in /home/linuxuser/.pm2/dump.pm2

If you need to restore the saved applications manually from the list, use the below command.

console

$ pm2 resurrect

Your output should be similar to the one below:

[PM2] Resurrecting
[PM2] Restoring processes located in /home/linuxuser/.pm2/dump.pm2
[PM2] Process /home/linuxuser/app.js restored
┌────┬────────────────────┬──────────┬──────┬───────────┬──────────┬──────────┐
│ id │ name               │ mode     │ ↺    │ status    │ cpu      │ memory   │
├────┼────────────────────┼──────────┼──────┼───────────┼──────────┼──────────┤
│ 0  │ app                │ fork     │ 0    │ online    │ 0%       │ 21.3mb   │
└────┴────────────────────┴──────────┴──────┴───────────┴──────────┴──────────┘

Check for Updates

Print a list of outdated NPM packages on your system.
console
```
$ npm outdated -g
```
This command displays a list of globally installed NPM packages that have newer versions available.

Update PM2

Update the PM2 package via NPM. The update stops all your running PM2 processes until upgrade is completed and your applications will face downtime during this period.
console
```
$ npm install pm2@latest -g
```
Perform an in-memory update of PM2.
console
```
$ pm2 update
```

Best Practices and Security Considerations

Prevent Downtime With Cluster Mode

Your PM2 processes may restart multiple times during their lifecycle, causing temporary downtime. Use PM2's cluster mode to reduce downtime. Cluster mode runs multiple instances of your application. When a restart is required, only one instance stops and restarts at a time, while other instances continue to serve your application.

Delete the application before switching to cluster mode.
console
```
$ pm2 delete app
```
Start the application in cluster mode, specifying the number of instances with the -i parameter.
console
```
$ pm2 start app.js -i 3
```
This command starts three instances of your application in cluster mode using PM2.
Scale the application by specifying the new number of instances.
console
```
$ pm2 scale app 4
```
This command will scale up your application to have 4 instances of app application.

Eliminate Failed Requests With Graceful Shutdown

PM2 ensures graceful shutdowns by sending signals to your application so it can terminate cleanly. This process helps prevent data loss or corruption by allowing your app to finish active tasks before exiting.

PM2 handles graceful shutdowns as follows:
1. Before shutdown, PM2 sends a SIGINT signal to your application.
2. Your application intercepts the signal.
3. It finishes active requests and closes open resources like database connections.
4. The application exits.
Add the following code to enable graceful shutdown in your application:
javascript
```
process.on('SIGINT', function() {
    // sigint signal received, log a message to the console
    console.log('Shutdown signal intercepted');
    // close the http server
    server.close();
    // exit the process
    process.exit();
});
```
The above code enables graceful shutdown in your application. It intercepts the SIGINT signal, logs a message to the console, closes the HTTP server, and exits the process.

Conclusion

In this article, you learned how to install and use PM2 to manage Node.js applications in a production environment. You configured PM2 to start applications automatically on system boot, monitored resource usage, viewed logs in real-time, and explored web-based dashboard capabilities with PM2 Plus. By following these steps, you can keep your Node.js applications running reliably, recover from crashes automatically, and simplify operational tasks using PM2’s robust feature set. For more information please visit the official documentation.

How to Manage Node Applications with PM2

Prerequisites

Install PM2 Using NPM

Create an Example Node.js Application

Start the Application Using PM2

Manage the Application

List All Applications

Display Logs

Monitor the Resource Usage

Set up a Web-Based Dashboard

Configure PM2 to Start on Server Boot

Configure Applications to Start on Server Boot

Check for Updates

Update PM2

Best Practices and Security Considerations

Prevent Downtime With Cluster Mode

Eliminate Failed Requests With Graceful Shutdown

Conclusion

Comments

Products

Features

Solutions

Marketplace

Resources

Company

Tech Talks

Vultr Blogs