Application Real-Time Monitoring Service:Pushgateway を使用したメトリックデータのプッシュ

仕組み

データソースが Pushgateway へメトリックをプッシュし、Prometheus サーバーが定期的に Pushgateway からデータをプルします。

この構成を設定するには、以下の手順を実行します。

1. Pushgateway エンドポイントを取得する Managed Service for Prometheus コンソールから。

2. [メトリックデータのプッシュ] を curl または Pushgateway SDK（Go、Java）を使用して実行します。

3. [オプション] トークン認証の有効化：プッシュ可能なユーザーを制限します。

前提条件

開始する前に、以下を確認してください。

• モニタリング対象の Prometheus インスタンスが存在すること。作成方法については、以下をご参照ください。

  • ACK クラスターのモニタリング

  • ECS インスタンスのモニタリング

  • Alibaba Cloud サービスのモニタリング

サポートされるデータ形式

手順 1：Pushgateway エンドポイントの取得

1. ARMS コンソール にログインします。左側ナビゲーションウィンドウで、Managed Service for Prometheus → インスタンス を選択します。

2. Prometheus インスタンスの名前をクリックして、詳細ページを開きます。

   

3. 左側ナビゲーションウィンドウで、設定項目 をクリックします。設定項目 タブの Push Gateway URL セクションから、パブリック URL をコピーします。

   

手順 2：メトリックデータのプッシュ

Pushgateway SDK または curl を使用してメトリックデータをプッシュします。

completionTime := prometheus.NewGauge(prometheus.GaugeOpts{
    Name: "db_backup_last_completion_timestamp_seconds",
    Help: "The timestamp of the last successful completion of a DB backup.",
})
completionTime.SetToCurrentTime()

url := "https://cn-hangzhou.arms.aliyuncs.com/prometheus/52b12ea9cf4bb9e35****/16727530178****/1df8lj***/cn-hangzhou/api/v2"
pusher := push.New(url, "test").
    Collector(completionTime).Client(http.DefaultClient).
    Grouping("key1", "test1").Grouping("key2", "dfdf/sdsd/").
    Format(expfmt.FmtProtoDelim)

if err := pusher.Push(); err != nil {
    fmt.Println("Could not push completion time to PushGateway: ", err)
}

CollectorRegistry registry = new CollectorRegistry();
Gauge duration = Gauge.build()
        .name("my_batch_job_duration_seconds")
        .help("Duration of my batch job in seconds.")
        .register(registry);
Gauge.Timer durationTimer = duration.startTimer();

try {
    // Your code here.

    // This is only added to the registry after success,
    // so that a previous success in the Pushgateway isn't overwritten on failure.
    Gauge lastSuccess = Gauge.build()
            .name("my_batch_job_last_success")
            .help("Last time my batch job succeeded, in unixtime.")
            .register(registry);
    lastSuccess.setToCurrentTime();
} finally {
    durationTimer.setDuration();
    PushGateway pg = new PushGateway(new URL(
        "https://cn-hangzhou.arms.aliyuncs.com/prometheus/52b12ea9cf4bb9e35****/16727530178****/1df8lj***/cn-hangzhou/api/v2"
    ));
    pg.pushAdd(registry, "my_batch_job");
}

echo "some_metric 3.14" | curl -H "Content-Type: text/plain; version=0.0.4; charset=utf-8" \
  --data-binary @- \
  https://cn-hangzhou.arms.aliyuncs.com/prometheus/51bbea9ck41b9e35****/16727530178****/1df8lj***/cn-hangzhou/api/v2/metrics/label_key_1/label_value_1/label_key_2/label_value_2

手順 3（オプション）：トークン認証による Pushgateway のセキュア化

デフォルトでは、Pushgateway エンドポイントを知っているクライアントであれば誰でもデータをプッシュできます。アクセスを制限するには、JSON Web トークン（JWT）を生成し、すべてのリクエストに含めてください。

リクエストへのトークンの付与

トークンを含めるには、以下のいずれかの方法をご使用ください。

方法 1：リクエストヘッダーへの追加

すべてのプッシュリクエストの Authorization ヘッダーに JWT を追加します。有効なトークンを含まないリクエストは拒否されます。

方法 2：BasicAuth（SDK 対応）の使用

方法 1 は開発コストの増加を招く可能性があります。代わりに、Pushgateway SDK は BasicAuth をサポートしていますが、JWT は直接サポートしていません。この制約を回避するため、パスワードフィールドにトークン値を設定することで、BasicAuth インターフェイス経由でトークンを渡すことができます。サーバーはこの方法を許容します。

pusher := push.New(url, "test").
    Collector(completionTime).Client(http.DefaultClient).
    Grouping("key1", "test1").Grouping("key2", "dfdf/sdsd/").
    BasicAuth("admin", "<your-token-value>").
    Format(expfmt.FmtProtoDelim)

<your-token-value> を、コンソールで生成したトークンに置き換えてください。

結果の確認

Grafana でクエリを実行し、メトリックデータが正しく到着していることを確認します。

1. 左側ナビゲーションウィンドウで、ダッシュボード をクリックし、次に ApiServer をクリックします。

2. 左側ナビゲーションウィンドウの アイコンにマウスを合わせて、Explore をクリックします。

3. ドロップダウンリストからご利用のリソースを選択し、プッシュしたメトリックをクエリします。