Debug mode in Nginx - Mini Project: Build & Apply

Enable and Test Debug Mode in Nginx

📖 Scenario: You are managing a web server using Nginx. Sometimes, errors happen and you want to see detailed logs to understand what went wrong. Enabling debug mode in Nginx helps you get detailed information about requests and errors.

🎯 Goal: Enable debug mode in the Nginx configuration and verify that debug logs are generated.

📋 What You'll Learn

Create a basic Nginx configuration file with a server block

Add a debug log level setting

Reload Nginx to apply the configuration

Check the error log output to confirm debug mode is active

💡 Why This Matters

🌍 Real World

Debug mode in Nginx helps system administrators and developers find detailed information about web server requests and errors, making troubleshooting easier.

💼 Career

Knowing how to enable and check debug logs in Nginx is a key skill for DevOps engineers and system administrators managing web servers.

1

Create a basic Nginx configuration file

Create a file called nginx.conf with a http block containing a server block that listens on port 8080 and serves requests with a root directory /usr/share/nginx/html.

Nginx

# Your code here

Hint

Use http {} and inside it add server {} with listen 8080; and root /usr/share/nginx/html;.

2

Add debug log level to the error_log directive

Inside the http block in nginx.conf, add an error_log directive that writes to /var/log/nginx/error.log with the log level set to debug.

Nginx

http {
    # Add error_log directive with debug level here
    server {
        listen 8080;
        root /usr/share/nginx/html;
    }
}

Hint

Place error_log /var/log/nginx/error.log debug; inside the http block but outside the server block.

3

Reload Nginx to apply the new configuration

Write the command to reload Nginx so it applies the new nginx.conf configuration without stopping the server. Use sudo.

Nginx

# Your command here to reload Nginx

Hint

Use sudo nginx -s reload to reload Nginx gracefully.

4

Check the error log for debug messages

Write the command to display the last 5 lines of the Nginx error log file /var/log/nginx/error.log to verify debug messages are present.

Nginx

# Your command here to show last 5 lines of error log

Hint

Use tail -n 5 /var/log/nginx/error.log to see recent log entries.

Practice

1. What does enabling debug mode in nginx do?

easy

A. Shows detailed logs to help find problems

B. Stops nginx from running

C. Deletes all log files

D. Automatically fixes errors

Solution

1. Step 1: Understand debug mode purpose

   Debug mode is designed to provide detailed information about what nginx is doing internally.

2. Step 2: Identify effect of enabling debug mode

   It shows detailed logs that help find and fix problems in nginx configuration or operation.

3. Final Answer:

   Shows detailed logs to help find problems -> Option A

4. Quick Check:

   Debug mode = detailed logs [OK]

Hint: Debug mode means detailed logs for troubleshooting [OK]

Common Mistakes:

• Thinking debug mode stops nginx
• Believing debug mode deletes logs
• Assuming debug mode auto-fixes errors

2. Which is the correct syntax to enable debug mode in nginx's error log?

easy

A. error_log debug /var/log/nginx/error.log;

B. error_log /var/log/nginx/error.log info;

C. error_log /var/log/nginx/error.log debug;

D. error_log /var/log/nginx/error.log off;

Solution

1. Step 1: Recall error_log syntax

   The correct syntax is: error_log <file_path> <level>; where level can be debug, info, etc.

2. Step 2: Identify correct option

   error_log /var/log/nginx/error.log debug; uses correct order: file path first, then debug level.

3. Final Answer:

   error_log /var/log/nginx/error.log debug; -> Option C

4. Quick Check:

   error_log file_path debug; = error_log /var/log/nginx/error.log debug; [OK]

Hint: error_log path then level debug; is correct syntax [OK]

Common Mistakes:

• Swapping file path and level order
• Using info instead of debug for debug mode
• Setting level to off disables logging

3. Given this nginx config snippet:

error_log /var/log/nginx/error.log debug;
server {
  listen 80;
  server_name example.com;
}

What will happen when nginx receives a request?

medium

A. Detailed debug logs will be written to /var/log/nginx/error.log

B. No logs will be created

C. Only error messages will be logged

D. Nginx will refuse connections

Solution

1. Step 1: Analyze error_log level

   The error_log is set to debug level, which logs detailed info about requests.

2. Step 2: Understand effect on request handling

   When nginx receives a request, it logs detailed debug info to the specified file.

3. Final Answer:

   Detailed debug logs will be written to /var/log/nginx/error.log -> Option A

4. Quick Check:

   debug level logs detailed info [OK]

Hint: debug level logs detailed info on requests [OK]

Common Mistakes:

• Thinking debug disables logging
• Assuming only errors are logged
• Believing nginx refuses connections with debug

4. You set error_log /var/log/nginx/error.log debug; but see no debug logs. What is a likely cause?

medium

A. Debug mode disables logging

B. Nginx was not reloaded after config change

C. The log file path is missing

D. The debug level is misspelled

Solution

1. Step 1: Check if config changes are active

   After changing nginx config, you must reload nginx to apply changes.

2. Step 2: Identify why no debug logs appear

   If nginx is not reloaded, it uses old config without debug logging.

3. Final Answer:

   Nginx was not reloaded after config change -> Option B

4. Quick Check:

   Reload nginx after config change [OK]

Hint: Reload nginx after config changes to activate debug [OK]

Common Mistakes:

• Forgetting to reload nginx
• Thinking debug disables logs
• Misspelling debug level

5. You want to enable debug mode only temporarily to avoid large log files. Which is the best approach?

hard

A. Delete log files manually to reduce size

B. Permanently set debug mode in nginx.conf

C. Disable logging completely during debugging

D. Set error_log /var/log/nginx/error.log debug;, reload nginx, then revert after debugging

Solution

1. Step 1: Understand temporary debug enabling

   Temporarily enable debug by changing error_log level and reloading nginx.

2. Step 2: Revert changes after debugging

   To avoid large logs, revert error_log level back and reload nginx again.

3. Final Answer:

   Set error_log /var/log/nginx/error.log debug;, reload nginx, then revert after debugging -> Option D

4. Quick Check:

   Temporary debug = enable then revert [OK]

Hint: Enable debug, reload, then revert to avoid big logs [OK]

Common Mistakes:

• Leaving debug mode enabled permanently
• Deleting logs instead of controlling debug level
• Disabling logging disables debug info