Prometheus exporter in Nginx - Mini Project: Build & Apply

Setting Up a Prometheus Exporter for Nginx Metrics

📖 Scenario: You are managing a web server running Nginx. You want to monitor its performance using Prometheus, a popular monitoring tool. To do this, you need to set up the Prometheus exporter for Nginx, which exposes Nginx metrics in a format Prometheus can collect.

🎯 Goal: Learn how to configure Nginx to expose metrics for Prometheus by enabling the Prometheus exporter module and setting up the correct endpoint.

📋 What You'll Learn

Create a basic Nginx configuration file with a server block

Add a location block to expose metrics at /metrics

Configure the Prometheus exporter module settings

Verify the metrics endpoint is accessible and outputs metrics

💡 Why This Matters

🌍 Real World

Monitoring web servers is essential to keep websites fast and reliable. Prometheus collects metrics from Nginx to help detect issues early.

💼 Career

DevOps engineers often set up monitoring tools like Prometheus with exporters to maintain system health and performance.

1

Create basic Nginx server configuration

Create an Nginx configuration file with a server block listening on port 8080 and serving requests for localhost.

Nginx

# Your code here to create a server block listening on port 8080

Hint

Use server { ... } block with listen 8080; and server_name localhost;.

2

Add metrics location for Prometheus exporter

Inside the existing server block, add a location /metrics block that will serve the Prometheus metrics.

Nginx

server {
    listen 8080;
    server_name localhost;

    # Add location block for /metrics here
}

Hint

Use location /metrics { stub_status; allow 127.0.0.1; deny all; } to expose metrics only locally.

3

Enable stub_status module for metrics

Ensure the stub_status directive is enabled inside the location /metrics block to expose Nginx status metrics.

Nginx

# Confirm stub_status is enabled in location /metrics
# Your code here

Hint

The stub_status; directive is required to expose metrics.

4

Test the metrics endpoint

Run the command curl http://127.0.0.1:8080/metrics to display the Nginx metrics exposed by the Prometheus exporter.

Nginx

# Run curl command to test metrics endpoint
# Your code here

Hint

The output should include lines like Active connections: showing Nginx status.

Practice

1. What is the main purpose of the stub_status module in nginx when used with Prometheus?

easy

A. To expose basic nginx metrics like active connections and requests

B. To serve static web pages faster

C. To block unauthorized IP addresses

D. To cache dynamic content for faster delivery

Solution

1. Step 1: Understand stub_status role

   The stub_status module provides a simple status page with metrics like active connections, accepts, handled, and requests.

2. Step 2: Connect stub_status to Prometheus

   Prometheus scrapes these metrics from the URL where stub_status is enabled to monitor nginx performance.

3. Final Answer:

   To expose basic nginx metrics like active connections and requests -> Option A

4. Quick Check:

   stub_status exposes metrics = C [OK]

Hint: stub_status shows nginx metrics, not content or blocking [OK]

Common Mistakes:

• Thinking stub_status caches content
• Confusing stub_status with IP blocking
• Assuming stub_status serves web pages

2. Which nginx configuration snippet correctly enables stub_status at the URL /metrics and restricts access to 127.0.0.1?

easy

A. location /metrics { stub_status on; allow all; }

B. location /metrics { stub_status; }

C. location /metrics { stub_status; allow 127.0.0.1; deny all; }

D. location /metrics { stub_status on; }

Solution

1. Step 1: Check stub_status syntax

   The correct directive is stub_status; without 'on'. It must be inside a location block.

2. Step 2: Verify access control

   To protect metrics, use allow 127.0.0.1; and deny all; inside the location.

3. Final Answer:

   location /metrics { stub_status; allow 127.0.0.1; deny all; } -> Option C

4. Quick Check:

   stub_status syntax + IP allow/deny = A [OK]

Hint: stub_status has no 'on'; protect with allow/deny [OK]

Common Mistakes:

• Using 'stub_status on;' which is invalid
• Not adding IP allow/deny rules
• Missing semicolon after stub_status

3. Given this nginx stub_status output scraped by Prometheus:

Active connections: 5
server accepts handled requests
 100 100 200
Reading: 1 Writing: 2 Waiting: 2

What is the value of 'Active connections' metric?

medium

A. 1

B. 100

C. 200

D. 5

Solution

1. Step 1: Identify Active connections line

   The first line shows 'Active connections: 5', so the active connections count is 5.

2. Step 2: Differentiate other numbers

   Numbers 100 and 200 relate to accepts, handled, and requests, not active connections.

3. Final Answer:

   5 -> Option D

4. Quick Check:

   Active connections = 5 [OK]

Hint: Active connections is the first number after label [OK]

Common Mistakes:

• Confusing accepts or requests with active connections
• Picking the largest number instead of the labeled one
• Ignoring the label and choosing Reading/Writing values

4. You configured nginx with stub_status at /metrics but Prometheus shows 'connection refused'. What is the most likely cause?

medium

A. nginx is not running or listening on the expected port

B. The stub_status directive is misspelled as stubstatus

C. Prometheus URL is missing the trailing slash

D. The location /metrics block is missing a root directive

Solution

1. Step 1: Understand 'connection refused' meaning

   This error means Prometheus cannot connect to nginx, likely because nginx is down or not listening on the port.

2. Step 2: Check other options

   Misspelling stub_status causes config errors but not connection refused. Missing slash or root directive won't cause connection refused.

3. Final Answer:

   nginx is not running or listening on the expected port -> Option A

4. Quick Check:

   Connection refused = nginx down or port closed [OK]

Hint: Connection refused means no server listening on port [OK]

Common Mistakes:

• Assuming URL slash causes connection refused
• Thinking config typos cause connection refused
• Believing root directive is required for stub_status

5. You want to expose nginx metrics at /metrics only to Prometheus server IP 10.0.0.5. Which configuration snippet correctly achieves this?

hard

A. location /metrics { stub_status on; allow 10.0.0.5; deny all; }

B. location /metrics { stub_status; allow 10.0.0.5; deny all; }

C. location /metrics { stub_status; allow all; deny 10.0.0.5; }

D. location /metrics { stub_status; deny all; allow 10.0.0.5; }

Solution

1. Step 1: Use correct stub_status syntax

   The directive is stub_status; without 'on'. It must be inside the location block.

2. Step 2: Apply IP allow/deny rules correctly

   To allow only 10.0.0.5, use allow 10.0.0.5; then deny all;. Order matters: allow first, then deny.

3. Final Answer:

   location /metrics { stub_status; allow 10.0.0.5; deny all; } -> Option B

4. Quick Check:

   Correct stub_status + allow IP then deny all = B [OK]

Hint: Allow IP first, then deny all; stub_status has no 'on' [OK]

Common Mistakes:

• Using 'stub_status on;' which is invalid
• Reversing allow and deny order
• Allowing all and denying the IP instead