Prometheus + Loki + Grafana for Ubuntu構築スクリプト

[更新: 2022年6月24日]

さくらのクラウドのスタートアップスクリプト「Prometheus + Loki + Grafana for Ubuntu」に関するページです。

1. 概要

新規で作成したUbuntuサーバ上に監視基盤を構築し、さくらのクラウド上のリソースを簡単に監視できるようにするスクリプトです。
本スクリプトでは、各種メトリクスの収集用にPrometheus、ログ収集用にLoki、それらの可視化用にGrafanaをインストールします。
また、さくらのクラウド用の監視エージェントである「sakuracloud-exporter」を同時にインストールするため、サーバや各種アプライアンスなどのリソース情報をサーバ起動後すぐにGrafanaのダッシュボード経由で監視いただけます。

本スクリプトでインストールされるツール群

  • Prometheus (v2.36.2)
  • sakuracloud_exporter (0.17.1)(任意)
  • Loki (v2.5.0)
  • Grafana(v9.0.1-oss)

対応ディストリビューション

  • Ubuntu 20.04/22.04

※2022年6月24日現在

2. 事前準備とスクリプトの処理内容

お客様の作業内容

項目 概要
APIキーの作成(sakuracloud_exporterをインストールする場合) こちら を参考に、APIキーを作成します
スタートアップスクリプトの実行 サーバ作成時にスタートアップスクリプト「Prometheus + Loki + Grafana for Ubuntu」を選択します

スタートアップスクリプトの処理内容

項目 処理内容
Prometheusのインストール Prometheusのインストールをし、sakuracloud_exporterと接続できるようにprometheus.ymlを変更します
sakuracloud_exporterのインストール(任意) 「利用する」にチェックを入れることで、sakuracloud_exporterをインストールし、APIキーを使用してさくらのクラウドのリソースにアクセスできるように設定します
Grafanaのインストール Grafanaをインストールし、Adminアカウントのパスワードを変更します
Lokiのインストール Lokiをインストールし、Grafanaから参照できるように変更します
nginxのインストール Grafanaのダッシュボードにアクセスするためのリバースプロキシを設定します

3. 利用手順

本スクリプトを使用する場合は、以下の手順でサーバ作成とダッシュボードへのアクセスを行ってください。

サーバ作成

  • 左メニューで「サーバ」を選択し、右上の「追加」ボタンをクリックします
  • 右上にある「シンプルモード」のチェックを外します
  • ディスクのアーカイブに、Ubuntu Server 20.04 または Ubuntu Server 22.04 を選択します
  • スタートアップスクリプトで「Shell」を選択します
  • 配置するスタートアップスクリプトで「Prometheus + Loki + Grafana for Ubuntu」を選択します
  • 「usacloudをインストールする」のチェックを外します
  • 「Sakura Cloud Exporter」をインストールする場合は、利用するにチェックを入れます
  • 「Sakura Cloud Exporter」をインストールする場合、「Sakura Cloud Exporterが利用するAPIキー」に、事前に作成したAPIキーを入力します
  • 「GrafanaのAdminアカウントのパスワード」に、GrafanaのAdminアカウントのパスワードとして設定したい文字列を入力します
  • 「Prometheus UIのBasic認証に利用するユーザー名」に、PrometheusのUIを表示するために利用するユーザー名を入力します
  • 「Prometheus UIのBasic認証に利用するパスワード」に、PrometheusのUIを表示するために利用するパスワードを入力します

Prometheus・Grafanaのダッシュボードへのアクセス

  • http://<本スクリプトを実行したサーバのIPアドレス>/grafana/ にアクセスします
  • 以下のページが表示されましたら構築完了です
  • Prometheusの監視ダッシュボードは http://<本スクリプトを実行したサーバのIPアドレス>/prometheus/ からアクセスできます
  • なお、Basic認証が設定されていますので、サーバ作成時にスタートアップスクリプトオプションで設定したユーザ名とパスワードをご入力ください

3. 本スクリプトの範囲外となる内容

httpsを用いたPrometheus・Grafanaダッシュボードへのアクセス

本スクリプトで構築されるPrometheusとGrafanaのダッシュボードはTLSで暗号化されていません。
httpでご利用する場合、ローカルネットワークでご使用ください。

オブジェクトストレージへの監視メトリクス保存

本スクリプトで構築したPrometheusはサーバのディスクに監視メトリクスを保存します。
オブジェクトストレージなど外部ストレージに監視メトリクスを保存する場合は、お客様で追加の設定作業をお願いいたします。

さくらのクラウド以外のリソースに関する監視メトリクス収集

お客様で監視対象サーバなどに監視エージェント(Exporter)の導入をお願いいたします。

Lokiを使用する際に各サーバに導入するエージェント

お客様で収集対象サーバにエージェント(promtail)の導入をお願いいたします。