CPU profiling basics in Node.js - Mini Project: Build & Apply

CPU Profiling Basics in Node.js

📖 Scenario: You are working on a Node.js application that sometimes runs slowly. To find out which parts of your code use the most CPU time, you want to create a CPU profile. This helps you understand where your program spends time, so you can improve it.

🎯 Goal: Build a simple Node.js script that uses the built-in inspector module to start and stop CPU profiling, then save the profile data to a file.

📋 What You'll Learn

Create a Node.js script that imports the inspector module

Start a CPU profile using the inspector session

Run a sample CPU-intensive function

Stop the CPU profile and save the profile data to a file named profile.cpuprofile

💡 Why This Matters

🌍 Real World

CPU profiling helps developers find performance bottlenecks in Node.js applications, improving speed and user experience.

💼 Career

Knowing how to profile CPU usage is valuable for backend developers, performance engineers, and anyone optimizing Node.js services.

1

Set up the inspector session

Create a variable called inspector that imports the inspector module, and create a new inspector.Session() instance called session. Then call session.connect() to start the session.

Node.js

const inspector = require('inspector');
const session = new inspector.Session();
// Your code here

Hint

Use require('inspector') to import the module, then create a new session with new inspector.Session(). Don't forget to call session.connect() to start the session.

2

Start the CPU profiler

Use session.post to start the CPU profiler by calling session.post('Profiler.enable') and then session.post('Profiler.start').

Node.js

const inspector = require('inspector');
const session = new inspector.Session();
session.connect();
// Your code here

Hint

Call session.post('Profiler.enable') first to enable profiling, then session.post('Profiler.start') to begin CPU profiling.

3

Run a CPU-intensive function

Create a function called calculate that runs a loop from 0 to 999999 and sums the numbers. Then call calculate() to simulate CPU work.

Node.js

const inspector = require('inspector');
const session = new inspector.Session();
session.connect();
session.post('Profiler.enable');
session.post('Profiler.start');
// Your code here

Hint

Write a function named calculate that sums numbers in a loop. Call it once to create CPU load.

4

Stop profiling and save the profile

Use session.post('Profiler.stop') with a callback that receives the profile data. Inside the callback, write the profile data to a file named profile.cpuprofile using require('fs').writeFileSync. Then call session.disconnect().

Node.js

const inspector = require('inspector');
const session = new inspector.Session();
session.connect();
session.post('Profiler.enable');
session.post('Profiler.start');

function calculate() {
    let sum = 0;
    for (let i = 0; i < 1000000; i++) {
        sum += i;
    }
    return sum;
}

calculate();
// Your code here

Hint

Stop the profiler with session.post('Profiler.stop'). Use the callback to get the profile data and save it to a file with fs.writeFileSync. Finally, disconnect the session.

Practice

1. What is the main purpose of CPU profiling in Node.js?

easy

A. To debug syntax errors in the code

B. To check the memory usage of the application

C. To monitor network requests

D. To find which parts of the code use the most CPU time

Solution

1. Step 1: Understand CPU profiling goal

   CPU profiling tracks where the CPU spends time during app execution.

2. Step 2: Compare options to profiling purpose

   Only To find which parts of the code use the most CPU time matches CPU time usage; others relate to memory, network, or syntax.

3. Final Answer:

   To find which parts of the code use the most CPU time -> Option D

4. Quick Check:

   CPU profiling = find CPU time hotspots [OK]

Hint: CPU profiling shows where CPU time is spent [OK]

Common Mistakes:

• Confusing CPU profiling with memory profiling
• Thinking it tracks network or syntax errors
• Assuming it shows all app performance issues

2. Which command correctly starts CPU profiling in Node.js?

easy

A. node --profile app.js

B. node --cpu-profile app.js

C. node --prof app.js

D. node --profile-cpu app.js

Solution

1. Step 1: Recall Node.js CPU profiling command

   The correct flag to start CPU profiling is --prof.

2. Step 2: Check each option's correctness

   Only node --prof app.js uses --prof, others are invalid flags.

3. Final Answer:

   node --prof app.js -> Option C

4. Quick Check:

   Use --prof to start CPU profiling [OK]

Hint: Use --prof flag to enable CPU profiling [OK]

Common Mistakes:

• Using incorrect flags like --profile or --cpu-profile
• Confusing profiling with debugging flags
• Omitting the --prof flag entirely

3. Given this command sequence:
node --prof app.js
Then running:
node --prof-process isolate-0x12345-v8.log
What is the output of --prof-process?

medium

A. The original JavaScript source code

B. A readable report showing CPU time spent in functions

C. A list of all files loaded by Node.js

D. An error message about missing files

Solution

1. Step 1: Understand purpose of --prof-process

   This command processes the raw CPU profile log into a readable report.

2. Step 2: Match output to options

   The output is a report showing CPU time spent per function, not source code or file lists.

3. Final Answer:

   A readable report showing CPU time spent in functions -> Option B

4. Quick Check:

   --prof-process = readable CPU time report [OK]

Hint: Use --prof-process to get readable CPU report [OK]

Common Mistakes:

• Expecting source code output from --prof-process
• Thinking it lists loaded files
• Confusing it with error output

4. You ran node --prof app.js but no log file was created. What is a likely cause?

medium

A. The app.js script exited too quickly before profiling started

B. You forgot to run node --prof-process first

C. You used --prof with an unsupported Node.js version

D. The log file is created only if you add --cpu-prof

Solution

1. Step 1: Understand profiling log creation

   The log file is created when the app runs with --prof and exits normally.

2. Step 2: Analyze why no log appears

   If the app exits too fast, profiling may not start or finish, so no log is saved.

3. Final Answer:

   The app.js script exited too quickly before profiling started -> Option A

4. Quick Check:

   App must run long enough to create profile log [OK]

Hint: App must run fully to generate profile log [OK]

Common Mistakes:

• Thinking --prof-process creates the log file
• Assuming --cpu-prof is required for logs
• Blaming Node.js version without checking

5. You want to find which function in your Node.js app uses the most CPU time. You run node --prof app.js and get a log file. What is the correct next step to analyze this data?

hard

A. Run node --prof-process on the log file to get a readable CPU profile report

B. Open the log file in a text editor and search for function names manually

C. Run node --inspect to debug the app instead

D. Restart the app without profiling to compare performance

Solution

1. Step 1: Understand how to analyze CPU profile logs

   The raw log file is not human-friendly; it needs processing.

2. Step 2: Use the correct tool for analysis

   Running node --prof-process on the log file converts it into a readable report showing CPU usage per function.

3. Final Answer:

   Run node --prof-process on the log file to get a readable CPU profile report -> Option A

4. Quick Check:

   Use --prof-process to analyze CPU profile logs [OK]

Hint: Process logs with --prof-process for readable CPU report [OK]

Common Mistakes:

• Trying to read raw logs manually
• Confusing profiling with debugging
• Restarting app without analyzing logs