Nginx Plus monitoring - Commands & Configuration

Introduction

Nginx Plus monitoring helps you see how your web server is performing and if it is handling traffic well. It shows you live data about connections, requests, and server health so you can fix problems quickly.

When you want to check how many users are connected to your web server right now.

When you need to see if your backend servers are healthy and responding.

When you want to track how many requests your server handles per second.

When you want to find out if your server is overloaded or running smoothly.

When you want to get detailed stats to improve your server setup.

Config File - nginx.conf

nginx.conf

worker_processes  1;

events {
    worker_connections  1024;
}

http {
    # Enable the status zone for Nginx Plus monitoring
    status_zone nginx_status;

    server {
        listen 8080;

        location /status {
            # Enable the Nginx Plus status module
            status;
        }
    }
}

This configuration enables the Nginx Plus status module on port 8080 under the /status path.

The status_zone directive creates a shared memory zone to store status data.

The location /status block activates the status endpoint that provides live monitoring data.

Commands

Check the Nginx configuration file for syntax errors 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

Reload Nginx to apply the new configuration without stopping the server.

Terminal

sudo systemctl reload nginx

Expected Output

No output (command runs silently)

Fetch the live status data from the Nginx Plus monitoring endpoint to see current server metrics.

Terminal

curl http://localhost:8080/status

Expected Output

{

  "connections": {

    "active": 10,

    "idle": 5,

    "reading": 1,

    "writing": 2,

    "waiting": 2

  },

  "requests": {

    "total": 12345,

    "current": 3,

    "per_second": 15

  },

  "upstreams": {

    "backend": {

      "servers": [

        {

          "server": "192.168.1.10:80",

          "state": "up",

          "requests": 6000

        },

        {

          "server": "192.168.1.11:80",

          "state": "up",

          "requests": 6345

        }

      ]

    }

  }

}

Key Concept

If you remember nothing else from this pattern, remember: Nginx Plus monitoring gives you real-time data about your server’s health and traffic through a special status endpoint.

Common Mistakes

Not enabling the status module in the configuration.

Without enabling the status module, the /status endpoint will not provide monitoring data.

Add the 'status;' directive inside the location block and define a status_zone in the http block.

Forgetting to reload Nginx after changing the configuration.

Nginx will continue running with the old configuration until reloaded or restarted.

Run 'sudo systemctl reload nginx' to apply configuration changes without downtime.

Trying to access the status endpoint on the wrong port or path.

The status endpoint is only available on the configured port and path, so accessing elsewhere returns errors.

Use the exact URL configured, for example, 'http://localhost:8080/status'.

Summary

Configure Nginx Plus to enable the status module on a specific port and path.

Test the configuration syntax and reload Nginx to apply changes safely.

Use curl to fetch live monitoring data from the status endpoint to check server health.

Practice

1. What is the main purpose of the Nginx Plus monitoring API endpoint?

easy

A. To provide live data about server traffic and health

B. To serve static website files

C. To configure SSL certificates automatically

D. To block unwanted IP addresses

Solution

1. Step 1: Understand Nginx Plus monitoring role

   Nginx Plus monitoring API endpoint is designed to show live server data such as traffic, errors, and health.

2. Step 2: Identify the correct purpose

   Serving static files, configuring SSL, or blocking IPs are unrelated to monitoring API.

3. Final Answer:

   To provide live data about server traffic and health -> Option A

4. Quick Check:

   Monitoring API = live server data [OK]

Hint: Monitoring API shows live server info, not config or files [OK]

Common Mistakes:

• Confusing monitoring API with static file serving
• Thinking it manages SSL certificates
• Assuming it blocks IP addresses

2. Which configuration snippet correctly enables Nginx Plus monitoring API at the path /api?

easy

A. location /api { api; }

B. location /api { proxy_pass http://backend; }

C. location /api { return 404; }

D. location /api { root /var/www/html; }

Solution

1. Step 1: Recall correct syntax for enabling Nginx Plus API

   The directive api; inside a location block enables the monitoring API endpoint.

2. Step 2: Compare options

   Only location /api { api; } uses api; directive. Others proxy, return 404, or serve files, which do not enable monitoring API.

3. Final Answer:

   location /api { api; } -> Option A

4. Quick Check:

   Enable API = location with api; directive [OK]

Hint: Use 'location /api { api; }' to enable monitoring [OK]

Common Mistakes:

• Using proxy_pass instead of api directive
• Returning 404 disables the endpoint
• Serving files does not enable API

3. Given this Nginx Plus config snippet, what will be the output when accessing /api?

location /api {
    api;
}

medium

A. A 404 Not Found error

B. A JSON response with live server metrics

C. The contents of /api directory on disk

D. A redirect to another URL

Solution

1. Step 1: Understand the api; directive effect

   The api; directive enables the Nginx Plus monitoring API, which returns live server data in JSON format.

2. Step 2: Analyze the response type

   Accessing /api returns JSON with metrics, not a 404, file contents, or redirect.

3. Final Answer:

   A JSON response with live server metrics -> Option B

4. Quick Check:

   api; returns JSON metrics [OK]

Hint: api; returns JSON live metrics at /api [OK]

Common Mistakes:

• Expecting file contents instead of JSON
• Thinking it returns 404 error
• Assuming it redirects

4. You added this config to enable Nginx Plus monitoring but get a 404 error when accessing /api:

location /api {
    api
}

What is the likely cause?

medium

A. The api directive requires a parameter

B. Wrong location path, should be /monitor

C. Nginx Plus monitoring is not supported on this server

D. Missing semicolon after api directive

Solution

1. Step 1: Check syntax of the api directive

   The api directive must end with a semicolon (api;). Missing it causes config errors and 404 responses.

2. Step 2: Evaluate other options

   The location path /api is correct, monitoring is supported, and api directive takes no parameters.

3. Final Answer:

   Missing semicolon after api directive -> Option D

4. Quick Check:

   Directive missing semicolon = 404 error [OK]

Hint: Always end directives with semicolon ; [OK]

Common Mistakes:

• Omitting semicolon after api directive
• Changing location path unnecessarily
• Assuming api directive needs parameters

5. You want to monitor multiple Nginx Plus servers centrally. Which approach using the monitoring API is best?

hard

A. Use location /api { proxy_pass http://backend; } to forward monitoring requests

B. Set up a single Nginx Plus server with location /api { api; } and proxy all traffic through it

C. Configure each server with location /api { api; } and use a script to fetch JSON from each server's /api endpoint

D. Disable the monitoring API and use log files only

Solution

1. Step 1: Understand monitoring API usage per server

   Each Nginx Plus server exposes its own live data at /api when configured with api;.

2. Step 2: Centralize monitoring by fetching data

   A script or tool can query each server's /api endpoint to collect and aggregate metrics centrally.

3. Step 3: Evaluate other options

   Proxying all traffic through one server or disabling API loses direct live data. Proxy_pass does not enable monitoring API.

4. Final Answer:

   Configure each server with location /api { api; } and use a script to fetch JSON from each server's /api endpoint -> Option C

5. Quick Check:

   Each server exposes API; central script collects data [OK]

Hint: Enable api; on each server, fetch data centrally via script [OK]

Common Mistakes:

• Trying to proxy monitoring API through one server
• Disabling API and relying only on logs
• Misusing proxy_pass for monitoring API