Fix pre-commit issues: trailing whitespace, line length, YAML, and TOC updates

Author: benjisho

.github/workflows/test-docker-compose-ci.yml

@@ -53,7 +53,7 @@ jobs:
       - name: Wait for services to be ready
         run: |
           echo "Waiting for services to be ready..."
-          
+
           # Wait for NGINX to be ready
           for i in {1..30}; do
             if curl -s http://localhost:8081/stub_status > /dev/null 2>&1; then
@@ -63,7 +63,7 @@ jobs:
             echo "Waiting for NGINX stub_status... (attempt $i/30)"
             sleep 2
           done
-          
+
           # Wait for NGINX Exporter to be ready
           for i in {1..30}; do
             if curl -s http://localhost:9113/metrics > /dev/null 2>&1; then
@@ -78,15 +78,15 @@ jobs:
         run: |
           echo "Verifying container status..."
           docker-compose ps
-          
+
           # Check if nginx-exporter container is running
           if ! docker-compose ps nginx-exporter | grep -q "Up"; then
             echo "❌ NGINX Exporter container is not running"
             docker-compose logs nginx-exporter
             exit 1
           fi
           echo "✓ NGINX Exporter container is running"
-          
+
           # Check if nginx container is running
           if ! docker-compose ps nginx | grep -q "Up"; then
             echo "❌ NGINX container is not running"
@@ -99,12 +99,12 @@ jobs:
         run: |
           echo "Testing NGINX stub_status endpoint..."
           response=$(curl -s http://localhost:8081/stub_status)
-          
+
           if [[ -z "$response" ]]; then
             echo "❌ NGINX stub_status endpoint returned empty response"
             exit 1
           fi
-          
+
           # Check if response contains expected metrics
           if echo "$response" | grep -q "Active connections:"; then
             echo "✓ NGINX stub_status endpoint is working correctly"
@@ -118,12 +118,12 @@ jobs:
         run: |
           echo "Testing NGINX Exporter metrics endpoint..."
           response=$(curl -s http://localhost:9113/metrics)
-          
+
           if [[ -z "$response" ]]; then
             echo "❌ NGINX Exporter metrics endpoint returned empty response"
             exit 1
           fi
-          
+
           # Check if response contains expected NGINX metrics
           if echo "$response" | grep -q "nginx_connections_accepted"; then
             echo "✓ NGINX Exporter metrics endpoint is working correctly"
@@ -136,20 +136,20 @@ jobs:
       - name: Verify metrics collection
         run: |
           echo "Verifying metrics collection..."
-          
+
           # Generate some traffic to NGINX
           echo "Generating traffic to NGINX..."
           for i in {1..5}; do
             curl -s http://localhost:80 > /dev/null || true
             sleep 1
           done
-          
+
           # Wait a moment for metrics to be updated
           sleep 3
-          
+
           # Check if metrics are being collected
           metrics=$(curl -s http://localhost:9113/metrics)
-          
+
           # Verify nginx_up metric exists and is 1
           if echo "$metrics" | grep -q "nginx_up 1"; then
             echo "✓ NGINX Exporter is successfully collecting metrics"
@@ -159,7 +159,7 @@ jobs:
             echo "$metrics" | grep "nginx_up" || echo "nginx_up metric not found"
             exit 1
           fi
-          
+
           # Verify connection metrics exist
           if echo "$metrics" | grep -q "nginx_connections_accepted"; then
             echo "✓ Connection metrics are being collected"
@@ -171,7 +171,7 @@ jobs:
       - name: Test service connectivity
         run: |
           echo "Testing service connectivity..."
-          
+
           # Test that services can communicate internally
           docker exec nginx-prometheus-exporter curl -f http://nginx:8081/stub_status > /dev/null
           echo "✓ Services can communicate internally"
@@ -214,13 +214,13 @@ jobs:
       - name: Wait for all services to be ready
         run: |
           echo "Waiting for all services to be ready..."
-          
+
           # Wait for all services to be healthy
           services=("nginx:8081/stub_status" "nginx-exporter:9113/metrics" "prometheus:9090/-/ready" "grafana:3000/api/health")
-          
+
           for service in "${services[@]}"; do
             IFS=':' read -r host_port path <<< "$service"
-            
+
             for i in {1..60}; do
               if curl -s "http://localhost:${host_port}${path}" > /dev/null 2>&1; then
                 echo "✓ Service ${host_port} is ready"
@@ -235,10 +235,10 @@ jobs:
         run: |
           echo "Verifying all containers are running..."
           docker-compose ps
-          
+
           # Check that all expected services are up
           services=("nginx" "nginx-exporter" "prometheus" "grafana" "app")
-          
+
           for service in "${services[@]}"; do
             if ! docker-compose ps "$service" | grep -q "Up"; then
               echo "❌ Service $service is not running"
@@ -251,7 +251,7 @@ jobs:
       - name: Test full stack integration
         run: |
           echo "Testing full stack integration..."
-          
+
           # Test Prometheus can scrape NGINX Exporter
           prometheus_targets=$(curl -s http://localhost:9090/api/v1/targets)
           if echo "$prometheus_targets" | grep -q "nginx-exporter:9113"; then
@@ -260,7 +260,7 @@ jobs:
             echo "❌ Prometheus is not configured to scrape NGINX Exporter"
             exit 1
           fi
-          
+
           # Test Grafana is accessible
           grafana_health=$(curl -s http://localhost:3000/api/health)
           if echo "$grafana_health" | grep -q "ok"; then

README.md

@@ -27,6 +27,7 @@ NGINX Prometheus exporter makes it possible to monitor NGINX or NGINX Plus using
   - [Prerequisites](#prerequisites)
   - [Running the Exporter in a Docker Container](#running-the-exporter-in-a-docker-container)
   - [Running the Exporter Binary](#running-the-exporter-binary)
+  - [Docker Compose Setup](#docker-compose-setup)
 - [Usage](#usage)
   - [Command-line Arguments](#command-line-arguments)
 - [Exported Metrics](#exported-metrics)
@@ -157,21 +158,25 @@ in a Docker container.
 
 ### Docker Compose Setup
 
-For a complete monitoring stack including NGINX, NGINX Prometheus Exporter, Prometheus, and Grafana, see the [Docker Compose example](./examples/docker-compose/README.md).
+For a complete monitoring stack including NGINX, NGINX Prometheus Exporter, Prometheus, and Grafana,
+see the [Docker Compose example](./examples/docker-compose/README.md).
 
 The Docker Compose setup provides:
+
 - NGINX server with stub_status enabled
 - NGINX Prometheus Exporter for metrics collection
 - Prometheus for time-series storage
 - Grafana for visualization with pre-configured dashboards
 - Sample web application for testing
 
 Quick start (nginx-exporter only):
+
 ```console
 docker-compose up -d nginx-exporter
 ```
 
 For a complete monitoring stack with all services:
+
 ```console
 docker-compose up -d
 ```

docker-compose.test.yml

@@ -1,13 +1,11 @@
-version: '3.8'
-
 services:
   # Sample web application
   app:
     image: nginx:alpine
     container_name: sample-app
     volumes:
-      - ./docker/app/nginx.conf:/etc/nginx/nginx.conf
-      - ./docker/app/html:/usr/share/nginx/html
+      - ./examples/docker-compose/app/nginx.conf:/etc/nginx/nginx.conf
+      - ./examples/docker-compose/app/html:/usr/share/nginx/html
     ports:
       - "8080:80"
     networks:
@@ -21,8 +19,8 @@ services:
     depends_on:
       - app
     volumes:
-      - ./docker/nginx/nginx.conf:/etc/nginx/nginx.conf
-      - ./docker/nginx/conf.d:/etc/nginx/conf.d
+      - ./examples/docker-compose/nginx/nginx.conf:/etc/nginx/nginx.conf
+      - ./examples/docker-compose/nginx/conf.d:/etc/nginx/conf.d
     ports:
       - "80:80"
       - "8081:8081"  # stub_status port
@@ -45,6 +43,51 @@ services:
       - nginx-monitoring
     restart: unless-stopped
 
+  # Prometheus
+  prometheus:
+    image: prom/prometheus:latest
+    container_name: prometheus
+    depends_on:
+      - nginx-exporter
+    volumes:
+      - ./examples/docker-compose/prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
+      - prometheus_data:/prometheus
+    ports:
+      - "9090:9090"
+    networks:
+      - nginx-monitoring
+    restart: unless-stopped
+    command:
+      - --config.file=/etc/prometheus/prometheus.yml
+      - --storage.tsdb.path=/prometheus
+      - --web.console.libraries=/etc/prometheus/console_libraries
+      - --web.console.templates=/etc/prometheus/consoles
+      - --storage.tsdb.retention.time=200h
+      - --web.enable-lifecycle
+
+  # Grafana
+  grafana:
+    image: grafana/grafana:latest
+    container_name: grafana
+    depends_on:
+      - prometheus
+    volumes:
+      - grafana_data:/var/lib/grafana
+      - ./examples/docker-compose/grafana/provisioning:/etc/grafana/provisioning
+      - ./examples/docker-compose/grafana/dashboards:/var/lib/grafana/dashboards
+    ports:
+      - "3000:3000"
+    networks:
+      - nginx-monitoring
+    restart: unless-stopped
+    environment:
+      - GF_SECURITY_ADMIN_PASSWORD=admin123
+      - GF_USERS_ALLOW_SIGN_UP=false
+
+volumes:
+  prometheus_data:
+  grafana_data:
+
 networks:
   nginx-monitoring:
     driver: bridge