ローカル環境にprometheusをインストール

概要

このドキュメントでは、ローカル環境にprometheusをインストールする手順について説明します。
prometheusは、システムの監視やアラートの生成を行うためのツールです。
本手順では、Dockerを使用して作成したDjangoアプリケーションに対して、prometheusを導入します。

前提条件

• Dockerがインストールされていること
• Docker Composeがインストールされていること
• Djangoアプリケーションが作成されていること
• DjangoアプリケーションがDockerで動作していること

手順

1. prometheusの設定ファイルを作成します。
   prometheusの設定ファイルは、prometheus.ymlというファイル名で作成します。
   以下は、prometheusの設定ファイルの例です。

   scrape_configs:
   - job_name: 'django'
       static_configs:
       - targets: ['web:8080']  # Djangoのホストとポート
   - job_name: 'prometheus'
       static_configs:
       - targets: ['prometheus:9090']  # Prometheusのホストとポート
   

2. djangoにprometheusを導入するためのライブラリをインストールします。
   requirements.txtに以下のライブラリを追加します。

   django-prometheus # 追加
   

3. Djangoアプリケーションのsettings.pyに以下の設定を追加します。

   INSTALLED_APPS = [
       ...
       'django_prometheus', # 追加
   ]
   
   # MIDDLEWAREの最初と最後に以下の設定を追加
   MIDDLEWARE = [
       'django_prometheus.middleware.PrometheusBeforeMiddleware',
       ...
       'django_prometheus.middleware.PrometheusAfterMiddleware',
   ]
   
   # prometheusの設定
   PROMETHEUS_EXPORT_MIGRATIONS = True
   

4. prometheusを起動するためのdocker-compose.ymlを作成します。

5. docker-compose.ymlに以下の設定を追加します。

   version: '3'
   
   services:
   ...
   prometheus:
       image: prom/prometheus
       volumes:
       - ./prometheus.yml:/etc/prometheus/prometheus.yml
       ports:
       - 9090:9090
   

   - image : prometheusのイメージを指定します。 - volumes : prometheusの設定ファイルをマウントします。
   ./prometheus.ymlは、1で作成した設定ファイルのパスを指定します。 - ports : prometheusのポートを指定します。

6. prometheusを起動します。

   $ docker-compose up -d prometheus
   

   - -d : バックグラウンドで起動します。

7. ブラウザでhttp://localhost:9090にアクセスします。

8. prometheusのダッシュボードが表示されれば、インストールは完了です。

コメント