Common error diagnosis in Nginx - Commands & Configuration

Introduction

Sometimes your nginx web server does not work as expected. Common errors can stop your website from loading or cause wrong content to show. Diagnosing these errors helps you fix problems quickly and keep your site running smoothly.

When your website shows a 502 Bad Gateway error after nginx restart

When nginx fails to start due to configuration mistakes

When your site loads slowly or not at all and you want to check logs

When you want to verify if nginx is running and listening on the right port

When you want to test if your nginx configuration file has syntax errors

Commands

This command tests the nginx configuration file for syntax errors without starting the server. It helps catch mistakes before applying changes.

Terminal

sudo nginx -t

Expected Output

nginx: the configuration file /etc/nginx/nginx.conf syntax is ok

nginx: configuration file /etc/nginx/nginx.conf test is successful

This command shows if the nginx service is running or stopped. It also displays recent logs to help identify startup errors.

Terminal

sudo systemctl status nginx

Expected Output

● nginx.service - A high performance web server and a reverse proxy server

   Loaded: loaded (/lib/systemd/system/nginx.service; enabled; vendor preset: enabled)

   Active: active (running) since Fri 2024-06-07 10:00:00 UTC; 5min ago

 Main PID: 1234 (nginx)

    Tasks: 3 (limit: 4915)

   Memory: 5.0M

   CGroup: /system.slice/nginx.service

           ├─1234 nginx: master process /usr/sbin/nginx -g daemon on; master_process on;

           └─1235 nginx: worker process

This command shows detailed nginx logs from the last 10 minutes. It helps find specific error messages or warnings.

Terminal

sudo journalctl -u nginx --since "10 minutes ago"

Expected Output

Jun 07 10:00:00 hostname systemd[1]: Starting A high performance web server and a reverse proxy server...

Jun 07 10:00:00 hostname nginx[1234]: nginx: [emerg] bind() to 0.0.0.0:80 failed (98: Address already in use)

Jun 07 10:00:00 hostname systemd[1]: nginx.service: Failed with result 'exit-code'.

Jun 07 10:00:00 hostname systemd[1]: Failed to start A high performance web server and a reverse proxy server.

→

--since - Shows logs starting from a specific time

This command checks if any process is already using port 80, which nginx needs to listen on. It helps diagnose port conflicts.

Terminal

sudo netstat -tulnp | grep :80

Expected Output

tcp        0      0 0.0.0.0:80            0.0.0.0:*               LISTEN      5678/apache2

→

-tulnp - Shows TCP/UDP ports with process IDs and names

Key Concept

If you remember nothing else from this pattern, remember: always test your nginx config syntax and check service status and logs to find errors quickly.

Common Mistakes

Not running 'nginx -t' before restarting nginx

This causes nginx to fail starting if there are syntax errors, leading to downtime.

Always run 'sudo nginx -t' to verify configuration before restarting.

Ignoring service status and logs when nginx fails

Without checking logs, you miss important error messages that explain the problem.

Use 'sudo systemctl status nginx' and 'journalctl' to read error details.

Not checking if port 80 is already in use

If another process uses port 80, nginx cannot start and will fail with a bind error.

Run 'sudo netstat -tulnp | grep :80' to find and stop conflicting services.

Summary

Use 'sudo nginx -t' to check configuration syntax before restarting nginx.

Check nginx service status with 'sudo systemctl status nginx' to see if it is running.

Read recent nginx logs using 'sudo journalctl -u nginx' to find error messages.

Verify port 80 is free with 'sudo netstat -tulnp | grep :80' to avoid conflicts.

Practice

1. What is the primary command to check if the nginx configuration file has syntax errors before restarting the service?

easy

A. nginx -s reload

B. nginx -t

C. systemctl status nginx

D. nginx -v

Solution

1. Step 1: Understand the purpose of nginx -t

   The command nginx -t tests the syntax of the nginx configuration files without starting or restarting the service.

2. Step 2: Compare with other commands

   nginx -s reload reloads the configuration but does not test it first. systemctl status nginx shows service status, and nginx -v shows version info.

3. Final Answer:

   nginx -t -> Option B

4. Quick Check:

   Test config syntax = nginx -t [OK]

Hint: Use nginx -t to test config syntax before restart [OK]

Common Mistakes:

• Using reload without testing config first
• Checking service status instead of config syntax
• Confusing version command with test command

2. Which of the following nginx configuration snippets will cause a syntax error?

easy

A. server { listen 80 server_name example.com; }

B. server { listen 443 ssl; server_name example.com; }

C. server { listen 80; server_name example.com; }

D. server { listen 8080; server_name localhost; }

Solution

1. Step 1: Identify correct syntax for directives

   Each directive must end with a semicolon. server { listen 80 server_name example.com; } misses a semicolon after listen 80, causing syntax error.

2. Step 2: Verify other options

   Options A, B, and D have correct semicolons and valid directives.

3. Final Answer:

   Missing semicolon after listen directive -> Option A

4. Quick Check:

   Every directive ends with ; [OK]

Hint: Check for missing semicolons in config lines [OK]

Common Mistakes:

• Omitting semicolons after directives
• Writing multiple directives without separators
• Confusing syntax for listen and server_name

3. Given this nginx error log line: [emerg] bind() to 0.0.0.0:80 failed (98: Address already in use), what is the most likely cause?

medium

A. Syntax error in nginx.conf

B. Missing SSL certificate files

C. Another process is already using port 80

D. Incorrect server_name directive

Solution

1. Step 1: Understand the error message

   The error bind() to 0.0.0.0:80 failed (98: Address already in use) means nginx tried to use port 80 but it is already occupied.

2. Step 2: Rule out other options

   Syntax errors or missing SSL files cause different errors. Incorrect server_name does not cause bind errors.

3. Final Answer:

   Another process is already using port 80 -> Option C

4. Quick Check:

   Port in use = bind() failed error [OK]

Hint: bind() failed means port is busy, check running services [OK]

Common Mistakes:

• Assuming syntax error causes bind failure
• Ignoring port conflicts
• Confusing SSL errors with port binding

4. You run systemctl restart nginx but nginx fails to start. Which command helps you find detailed error messages to diagnose the problem?

medium

A. netstat -tuln

B. nginx -v

C. ps aux | grep nginx

D. journalctl -u nginx.service

Solution

1. Step 1: Identify command for service logs

   journalctl -u nginx.service shows detailed logs for the nginx service, useful for error diagnosis after failure.

2. Step 2: Understand other commands

   nginx -v shows version, ps aux | grep nginx shows running processes, netstat -tuln shows network ports but not error logs.

3. Final Answer:

   journalctl -u nginx.service -> Option D

4. Quick Check:

   Service logs = journalctl -u [OK]

Hint: Use journalctl -u nginx.service for detailed error logs [OK]

Common Mistakes:

• Using version command instead of logs
• Checking processes without logs
• Looking at ports instead of error messages

5. You updated nginx.conf but after reload, nginx serves the old configuration. What is the best way to ensure nginx uses the new config without downtime?

hard

A. Run nginx -t to test config, then nginx -s reload

B. Restart the server machine

C. Stop nginx, edit config, then start nginx

D. Clear browser cache and refresh

Solution

1. Step 1: Test new configuration syntax

   Run nginx -t to confirm the new config has no errors before applying it.

2. Step 2: Reload nginx gracefully

   Use nginx -s reload to reload config without stopping the service, avoiding downtime.

3. Final Answer:

   Test config then reload nginx gracefully -> Option A

4. Quick Check:

   Test then reload = safe config update [OK]

Hint: Always test config before reload to avoid downtime [OK]

Common Mistakes:

• Restarting server unnecessarily
• Stopping nginx causing downtime
• Assuming browser cache causes config issues