コンテンツにスキップ

スクリプト開発 / コネクターオブジェクト DFF.CONN / Prometheus

Prometheus コネクターの操作オブジェクトは、主に Prometheus を操作するメソッドを提供します。

本コネクターは HTTP プロトコルに基づいて Prometheus に接続してアクセスします

DFF.CONN(...) のパラメータは次のとおりです。

パラメータ 必須 / デフォルト値 説明
connector_id str 必須 コネクター ID
timeout int/float 10 現在の操作オブジェクトのデフォルト HTTP リクエストタイムアウト時間(秒)

.query(...)

Prometheus へ HTTP リクエストを送信するためのパラメータは次のとおりです。

パラメータ 必須 / デフォルト値 説明
method str 必須 リクエストメソッド。例: GETPOST; "GET /path" と書くこともできます
path str None リクエストパス。省略時は method から分割されます
query dict None URL クエリパラメータ
body dict None JSON リクエストボディ
timeout int/float None このリクエストのタイムアウト時間。省略時は操作オブジェクトのデフォルト値を使用します
1
2
3
4
5
6
result = prom.query('GET', '/api/v1/query_range', query={
  'query': 'up',
  'start': '2024-01-01T00:00:00Z',
  'end'  : '2024-01-02T00:00:00Z',
  'step' : '60s',
})

querystartend を同時に含む場合、コネクターはその両方を時間に変換し、時系列に並べ替えて、ISO 8601 文字列として出力します。その他のパラメータは Prometheus HTTP API に直接渡されます。

レスポンスが JSON または XML の場合は解析後のオブジェクトを返し、それ以外の場合は生のバイトを返します。HTTP ステータスコードが 400 以上の場合は例外をスローします。

Prometheus HTTP API については、Prometheus 公式ドキュメント / Querying / HTTP API を参照してください。