Dockerで作る開発環境：nginx-exporterの導入

よっしー

こんにちは。よっしーです(^^)

今日は、dockerで構築した開発環境において、nginx-exporterを導入した手順をご紹介します。

実行環境
背景
ディレクトリ構造
動作確認
解説
1. nginx-exporterについて
おわりに

実行環境

この記事は、特定の開発環境を前提として書かれています。もし興味がある場合は、その開発環境を構築するための説明が書かれている記事を参考にしてください。該当記事は下記になります。

Dockerで作る開発環境：nginxの導入

よっしーこんにちは。よっしーです(^^) 今日は、dockerで構築した開発環境において、nginxを導入した手順をご紹介します。実行環境この記事は、特定の開発環境を前提として書かれています。もし興味がある場合は、その開発環境を構築す...

ただ、この記事で紹介している修正内容がたくさんあるので、その修正を反映した最新版のプログラムをダウンロードして、参照することをおすすめします。該当のプログラムの詳細については、下記のページで確認できます。

Release v2023.05.03 · Gate-Yossi/Titawin

yossi-note.com 2023.05.03

背景

nginx-prometheus-exporterは、NginxのWebサーバーからメトリクスを収集し、Prometheusのメトリクス収集機能と統合するためのツールです。

Nginxは、HTTPリクエストを処理するための非常に人気のあるWebサーバーであり、リバースプロキシ、ロードバランシング、コンテンツ配信などの機能を提供しています。nginx-prometheus-exporterを使用することで、Nginxサーバーの稼働状況を監視し、可視化することができます。Nginxサーバーの可用性を向上させるために、nginx-prometheus-exporterを導入することをお勧めします。

ディレクトリ構造

ディレクトリ構造は下記のようになっています。赤字の箇所が新規＆更新、削除になります。

.
├── LICENSE
├── Makefile
├── README.md
└── app
    ├── apache-exporter
    ├── compose.yml
    ├── flyway
    ├── grafana
    │   ├── dashboard.yml
    │   └── dashboards
    │          └── nginx.json
    ├── influxdb
    ├── k6
    ├── memcached
    ├── memcached-exporter
    ├── nginx
    │   └── default.conf
    ├── nginx-exporter
    │   └── Dockerfile
    ├── php-fpm
    ├── php-fpm-exporter
    ├── mongo
    ├── mysql
    ├── mysqld-exporter
    ├── prometheus
    │   └── prometheus.yml
    ├── schemaspy
    ├── web
    └── xhgui

compose.yml

下記の内容をファイル(compose.yml) 225-236 行目に追加します。

  nginx-exporter:
    build: ./nginx-exporter
    container_name: nginx-exporter
    ports:
      - "9113:9113"
    restart: unless-stopped
    entrypoint: nginx-prometheus-exporter -nginx.scrape-uri=http://nginx/nginx_status
    networks:
      - net
    depends_on:
      - nginx

nginx/default.conf

下記の内容をファイル(nginx/default.conf) 15-23行目に追記します。

    location /nginx_status {
        stub_status on;
        access_log off;
        allow 127.0.0.1;
        allow 172.18.0.0/16;  # This is my local docker IP range
        allow 192.168.0.0/16; # This is my production server IP range
        deny all;
    }

nginx-exporter/Dockerfile

下記の内容でファイル(nginx-exporter/Dockerfile) を更新します。

FROM nginx/nginx-prometheus-exporter:0.10.0

prometheus/prometheus.yml

下記の赤字内容でファイル(prometheus/prometheus.yml) を更新します。

global:
  scrape_interval: 5s
scrape_configs:
  - job_name: 'docker-for-mac'
    static_configs:
      - targets: ['docker.for.mac.host.internal:9323']
  - job_name: 'apache'
    static_configs:
      - targets: ['apache-exporter:9117']
  - job_name: 'php-fpm'
    static_configs:
      - targets: ['php-fpm-exporter:9253']
  - job_name: 'nginx'
    static_configs:
      - targets: ['nginx-exporter:9113']
  - job_name: 'memcached'
    static_configs:
      - targets: ['memcached-exporter:9150']
  - job_name: 'mysql'
    static_configs:
      - targets: ['mysqld-exporter:9104']

grafana/dashboard.yml

下記の赤字内容をファイル(grafana/dashboard.yml) 26-36行目に追記します。

  - name: 'nginx'
    orgId: 1
    folder: 'Service'
    type: file
    disableDeletion: false
    updateIntervalSeconds: 10
    allowUiUpdates: false
    options:
      path: /var/lib/grafana/dashboards/nginx.json
      foldersFromFilesStructure: false