Hitachi

JP1 Version 13 JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス


5.20.1 Prometheus serverのリロード

機能

Prometheus serverの定義ファイル(jpc_prometheus_server.yml,jpc_alerting_rules.yml,ファイルディスカバリ定義ファイルなど)を再読み込みし,Prometheus serverの動作に反映します。

Prometheus serverのリロードは,Prometheus serverの再起動と比べて処理が速く,通知失敗時の状態を維持します。

APIの動作に関する特記事項
  • すべての定義項目がリロードされます。

  • アラートルールのしきい値を変更してリロードを行うと,アラートのステータスが変更したしきい値に該当するステータスに変化します。

  • 不正な定義ファイルをリロードした場合,すべての定義項目が更新されません。リロードする前に,promtool check configコマンドで,設定ファイルの書式チェックを実施することを推奨します。

形式
リクエスト行
POST /-/reload HTTP/1.1
リクエストヘッダー

ヘッダー名

設定値

Host

APIの接続先のPrometheus serverのホストの情報を,ヘッダーの値として次の形式で指定します。

ホスト名またはIPアドレス:ポート番号

:ポート番号」は省略可能です。

  • ホスト名またはIPアドレス

    Prometheus serverのホスト名またはIPv4アドレスを指定します。

  • ポート番号

    Prometheus serverに接続する際に使用するポート番号を指定します。

このヘッダーは省略不可です。

リクエストのメッセージボディー

なし。

レスポンスのメッセージボディー

リロードに成功した場合,レスポンスはなしです。

リロードに失敗した場合,失敗した要因を示すメッセージ(Prometheus serverが出力する値)が設定されます。

ステータスコード

ステータスコード

メッセージ

説明

200

OK

リロードに成功した。

200以外

OK以外

リロードに成功した。

使用例

OSSのcurlコマンドを利用して,このAPIを実行した場合の使用例を,次に示します。

リロード成功時:

>curl --request POST "http://localhost:20713/-/reload"
 
>

リロード失敗時:

>curl --request POST "http://localhost:20713/-/reload"
failed to reload config: couldn't load configuration (--config.file="C:\\jp1pccs\\conf\\jpc_prometheus_server.yml"): parsing YAML file C:\\jp1pccs\\conf\\jpc_prometheus_server.yml: yaml: unmarshal errors:
  line 10: field test not found in type config.plain
>