Performance bottleneck identification in Nginx - Mini Project: Build & Apply

Performance Bottleneck Identification with Nginx

📖 Scenario: You are a system administrator for a small website. Recently, the website has been slow, and you want to find out what is causing the delay. You will use Nginx logs and configuration to identify the performance bottleneck.

🎯 Goal: Learn how to set up Nginx logging, configure a simple status page, and analyze logs to find slow requests causing performance issues.

📋 What You'll Learn

Create a basic Nginx access log format

Enable the Nginx stub_status module for monitoring

Use log format to capture request time

Analyze logs to find slow requests

💡 Why This Matters

🌍 Real World

Web servers often slow down due to some requests taking too long. Identifying these slow requests helps fix performance issues.

💼 Career

System administrators and DevOps engineers use Nginx logs and status modules to monitor and improve web server performance.

1

Set up Nginx access log with request time

Create an Nginx configuration snippet that defines a log format called main which logs the client IP ($remote_addr), request time in seconds ($request_time), and the requested URI ($request_uri). Then set the access log to use this main format and write to /var/log/nginx/access.log.

Nginx

# Define log format 'main' and set access_log to '/var/log/nginx/access.log' using 'main'
# Your code here

Hint

Use log_format directive to define the format. Then use access_log directive to specify the log file and format.

2

Enable Nginx stub_status for monitoring

Add a location block for /nginx_status inside the server block that enables the stub_status module by setting stub_status on;. This will allow you to check basic Nginx performance metrics.

Nginx

log_format main '$remote_addr - $request_time - $request_uri';
access_log /var/log/nginx/access.log main;

# Add location /nginx_status with stub_status on
# Your code here

Hint

Use a location block with stub_status on; and restrict access to localhost with allow and deny.

3

Analyze logs to find slow requests

Write a shell command that uses awk to read /var/log/nginx/access.log and print lines where the request time (third field) is greater than 1 second. Use awk '$3 > 1' to filter.

Nginx

log_format main '$remote_addr - $request_time - $request_uri';
access_log /var/log/nginx/access.log main;

location /nginx_status {
    stub_status on;
    allow 127.0.0.1;
    deny all;
}

# Write awk command to filter slow requests > 1 second
# Your code here

Hint

Use awk to check the third field (request time) and print lines where it is greater than 1.

4

Display slow requests output

Run the command awk '$3 > 1' /var/log/nginx/access.log and print the output to show slow requests that took more than 1 second.

Nginx

log_format main '$remote_addr - $request_time - $request_uri';
access_log /var/log/nginx/access.log main;

location /nginx_status {
    stub_status on;
    allow 127.0.0.1;
    deny all;
}

# Run the awk command and print output
# Your code here

Hint

Run the awk command to see lines with request time greater than 1 second.

Practice

1. What is the primary purpose of enabling the stub_status module in nginx?

easy

A. To monitor active connections and request statistics

B. To enable SSL encryption for secure connections

C. To cache static files for faster delivery

D. To compress HTTP responses automatically

Solution

1. Step 1: Understand the stub_status module

   The stub_status module provides a simple way to get real-time statistics about nginx such as active connections and request counts.

2. Step 2: Identify its monitoring role

   It does not handle SSL, caching, or compression but focuses on performance metrics.

3. Final Answer:

   To monitor active connections and request statistics -> Option A

4. Quick Check:

   stub_status = monitor connections and requests [OK]

Hint: stub_status shows live connection and request stats [OK]

Common Mistakes:

• Confusing stub_status with SSL or caching modules
• Thinking it compresses responses
• Assuming it improves performance directly

2. Which of the following nginx configuration snippets correctly enables the stub_status page at /nginx_status?

easy

A. location /nginx_status { stub_status on; allow 127.0.0.1; deny all; }

B. location /nginx_status { stub_status; allow 127.0.0.1; deny all; }

C. location /nginx_status { stub_status on; allow all; }

D. location /nginx_status { status_stub on; allow 127.0.0.1; deny all; }

Solution

1. Step 1: Recall correct stub_status syntax

   The directive to enable stub_status is simply stub_status; without 'on'.

2. Step 2: Check access control correctness

   Allowing 127.0.0.1 and denying others is correct for security.

3. Final Answer:

   location /nginx_status { stub_status; allow 127.0.0.1; deny all; } -> Option B

4. Quick Check:

   stub_status directive has no 'on' [OK]

Hint: stub_status directive has no 'on' keyword [OK]

Common Mistakes:

• Adding 'on' after stub_status
• Using wrong directive name like status_stub
• Allowing all IPs without restriction

3. Given this nginx log excerpt showing many slow requests, which metric indicates a potential bottleneck?

medium

A. High number of 200 status codes

B. Low bytes_sent values

C. Frequent GET requests

D. High request_time values in access logs

Solution

1. Step 1: Understand request_time meaning

   The request_time shows how long nginx took to process a request; high values mean slow responses.

2. Step 2: Analyze other metrics

   Low bytes_sent or many 200 codes do not indicate slowness; frequent GETs are normal traffic.

3. Final Answer:

   High request_time values in access logs -> Option D

4. Quick Check:

   High request_time = slow requests [OK]

Hint: Look for high request_time to spot slow requests [OK]

Common Mistakes:

• Confusing status codes with performance
• Assuming bytes_sent relates to speed
• Ignoring request_time metric

4. You added the stub_status location but get a 404 error when accessing /nginx_status. What is the most likely cause?

medium

A. The location block syntax is incorrect with extra semicolons

B. The server block is missing the listen directive

C. The stub_status module is not compiled or enabled in nginx

D. The allow directive is missing

Solution

1. Step 1: Check module availability

   If stub_status is not compiled into nginx, the location will not work and return 404.

2. Step 2: Verify other config parts

   Incorrect syntax or missing listen usually cause config errors, not 404. Missing allow causes access denied, not 404.

3. Final Answer:

   The stub_status module is not compiled or enabled in nginx -> Option C

4. Quick Check:

   Missing stub_status module = 404 error [OK]

Hint: 404 on stub_status means module missing or disabled [OK]

Common Mistakes:

• Assuming syntax errors cause 404
• Confusing 404 with access denied errors
• Ignoring module compilation status

5. You want to identify if nginx worker processes are a bottleneck under high load. Which combined approach helps you best diagnose this?

hard

A. Check stub_status active connections and use top to monitor worker CPU usage

B. Only check nginx error logs for worker crashes

C. Increase worker_processes blindly without monitoring

D. Disable access logs to reduce disk usage

Solution

1. Step 1: Use stub_status for connection metrics

   stub_status shows active connections and requests, indicating load on workers.

2. Step 2: Monitor worker CPU usage with system tools

   Using top or similar tools shows if workers are maxing CPU, a sign of bottleneck.

3. Step 3: Combine metrics for diagnosis

   Both metrics together reveal if workers are overloaded or if other issues exist.

4. Final Answer:

   Check stub_status active connections and use top to monitor worker CPU usage -> Option A

5. Quick Check:

   Combine stub_status + CPU monitoring = diagnose bottleneck [OK]

Hint: Combine stub_status and CPU tools to find worker bottlenecks [OK]

Common Mistakes:

• Ignoring CPU usage of workers
• Changing config without data
• Relying only on logs or disabling logs