Prometheus設定 - Prometheusドキュメント

このページはPrometheus公式ドキュメント和訳+αの一部です。

設定

Prometheusは、コマンドラインフラグと設定ファイルを通して設定される。 コマンドラインフラグは、不変のシステムパラメーター(ストレージの場所、ディスクやメモリに保持するデータ量など)を設定し、設定ファイルは、どのルールファイルを読み込むかに加えて、スクレイピングのジョブとインスタンスに関する全てを定義する。

利用可能な全てのコマンドラインフラグを見るには、./prometheus -hを実行する。

Prometheusは、実行時に設定を読み込み直すことが出来る。 もし、新しい設定が正しい形式でなければ、変更は適用されない。 設定を読み込み直させるには、PrometheusプロセスにSIGHUPを送るか、(--web.enable-lifecycleフラグが有効な場合)エンドポイント/-/reloadにHTTP POSTリクエストを送る。

設定ファイル

どの設定ファイルを読み込むか指定するには、フラグ--config.fileを使う。

設定ファイルは、以下に記すスキームで定義されたYAML形式で書かれる。 ブラケットは、パラメーターがオプションであることを表す。 リストでないパラメーターは、指定されたデフォルト値にセットされる。

一般的なプレースホルダーは以下の通り。

  • <boolean>: 値としてtrueまたはfalseを取ることが出来るブーリアン
  • <duration>: 正規表現[0-9]+(ms|[smhdwy])にマッチする時間幅
  • <labelname>: 正規表現[a-zA-Z_][a-zA-Z0-9_]*にマッチする文字列
  • <labelvalue>: Unicodeの文字列
  • <filename>: ワーキングディレクトリ内のパス
  • <host>: ホスト名またはIP、オプションでポート番号から成る文字列
  • <path>: URLパス
  • <scheme>: 値としてhttpまたはhttpsを取ることが出来る文字列
  • <string>: 文字列
  • <secret>: パスワードのような秘密の文字列
  • <tmpl_string>: 利用前にテンプレートで展開される文字列

そのほかのプレースホルダーは、個別に定義される。

ここでサンプルファイルを見ることが出来る。

グローバルな設定は、他の全ての部分で有効なパラメーターを指定する。 これらは、他の部分での設定のデフォルト値にもなる。

global:
  # デフォルトでターゲットをスクレイプする頻度
  [ scrape_interval: <duration> | default = 1m ]

  # スクレイプのリクエストがタイムアウトするまでの時間
  [ scrape_timeout: <duration> | default = 10s ]

  # ルールを評価する頻度
  [ evaluation_interval: <duration> | default = 1m ]

  # 外部システム(federation、remote storage、Alertmanager)と通信するときに
  # 全ての時系列やアラートに追加するラベル
  external_labels:
    [ <labelname>: <labelvalue> ... ]

# ルールファイルはグロブのリストを指定する。
# マッチした全てのファイルからルールとアラートが読み込まれる
rule_files:
  [ - <filepath_glob> ... ]

# スクレイプの設定のリスト
scrape_configs:
  [ - <scrape_config> ... ]

# alertingはAlertmanagerに関する設定をする
alerting:
  alert_relabel_configs:
    [ - <relabel_config> ... ]
  alertmanagers:
    [ - <alertmanager_config> ... ]

# remote write機能に関する設定
remote_write:
  [ - <remote_write> ... ]

# remote read機能に関する設定
remote_read:
  [ - <remote_read> ... ]

参考リンク

和訳活動の支援

Prometheusドキュメント和訳が役に立った方は、以下QRコードからPayPayで活動を支援して頂けるとありがたいです。

PayPayによる支援用QRコード
上のQRコードからPayPayによる支援

入門 Prometheus ―インフラとアプリケーションのパフォーマンスモニタリング

入門 Prometheus ―インフラとアプリケーションのパフォーマンスモニタリング

Prometheus: Up & Running: Infrastructure and Application Performance Monitoring

Prometheus: Up & Running: Infrastructure and Application Performance Monitoring

入門 監視 ―モダンなモニタリングのためのデザインパターン

入門 監視 ―モダンなモニタリングのためのデザインパターン

SRE サイトリライアビリティエンジニアリング ―Googleの信頼性を支えるエンジニアリングチーム

SRE サイトリライアビリティエンジニアリング ―Googleの信頼性を支えるエンジニアリングチーム