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

Need a 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
}

Need a 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

Need a 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

Need a hint?

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