From 765daac32cc92a29e59246f1d71eab8b774a152d Mon Sep 17 00:00:00 2001 From: Masahiro Nagano Date: Fri, 4 Sep 2026 23:19:34 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=97=A5=E6=9C=AC=E8=AA=9E=E3=81=A7?= =?UTF-8?q?=E3=81=AE=20README=20=E3=81=AE=E5=86=85=E5=AE=B9=E3=82=92?= =?UTF-8?q?=E8=BF=BD=E5=8A=A0=E3=81=97=E3=80=81=E3=82=A4=E3=83=B3=E3=82=B9?= =?UTF-8?q?=E3=83=88=E3=83=BC=E3=83=AB=E6=96=B9=E6=B3=95=E3=82=84=E4=BD=BF?= =?UTF-8?q?=E7=94=A8=E4=BE=8B=E3=82=92=E6=98=8E=E7=A2=BA=E5=8C=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 79 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 61 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index be30e68..64b62de 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,42 @@ # mackerel-plugin-httping -Custom mackerel plugin for measuring http/https latency +HTTP/HTTPS のレイテンシを計測する Mackerel カスタムプラグインです。 -mackerel-plugin-httping does +mackerel-plugin-httping は以下の処理を行います。 -- preflight request for keepalive and dnscache before measure latency -- request to the url 10 times sequentially -- use first byte timing as latency -- calculate min, max, 90%tile and average +- レイテンシ計測の前にプリフライトリクエストを送信し、Keep-Alive と DNS キャッシュを準備します +- 指定した URL に対して順次リクエストを送信します +- 応答の最初の 1 バイトを受信するまでの時間をレイテンシとして計測します +- min / max / 90 パーセンタイル / average を算出します -# Usage +## インストール方法 + +リリースページからバイナリをダウンロードするか、`mkr` コマンドを利用してインストールできます。 + +```sh +mkr plugin install monitoring-forge/mackerel-plugin-httping +``` + +`mkr` の詳細については [mkr コマンドのドキュメント](https://mackerel.io/ja/docs/entry/advanced/cli) を参照してください。 + +## 簡単な使い方 + +```sh +mackerel-plugin-httping --url https://example.com/ --key-prefix example +``` + +### 出力例 + +``` +httping.example_rtt_count.success 10.000000 1581488858 +httping.example_rtt_count.error 0.000000 1581488858 +httping.example_rtt_ms.max 111.961772 1581488858 +httping.example_rtt_ms.min 108.004440 1581488858 +httping.example_rtt_ms.average 109.899642 1581488858 +httping.example_rtt_ms.90_percentile 110.906144 1581488858 +``` + +### オプション ``` % ./mackerel-plugin-httping -h @@ -27,22 +54,38 @@ Application Options: Help Options: -h, --help Show this help message - ``` -## output sample +## mackerel-agent の設定方法 +`/etc/mackerel-agent/mackerel-agent.conf` に plugin 設定を追加します。 + +```conf +[plugin.metrics.httping] +command = ["/usr/local/bin/mackerel-plugin-httping", "--url", "https://example.com/", "--key-prefix", "example", "--count", "10", "--interval", "200"] ``` -% ./mackerel-plugin-httping --key-prefix example --url http://example.com/ -httping.example_rtt_count.success 10.000000 1581488858 -httping.example_rtt_count.error 0.000000 1581488858 -httping.example_rtt_ms.max 111.961772 1581488858 -httping.example_rtt_ms.min 108.004440 1581488858 -httping.example_rtt_ms.average 109.899642 1581488858 -httping.example_rtt_ms.90_percentile 110.906144 1581488858 + +設定後、`mackerel-agent` を再起動してください。 + +```sh +sudo systemctl restart mackerel-agent ``` +Mackerel 上では `custom.httping.example_rtt_ms.*` などのメトリクス名でグラフが作成されます。 + +## 出力されるメトリクスの意味 + +| メトリクス名 | 単位 | 説明 | +| --- | --- | --- | +| `httping._rtt_count.success` | count | 成功したリクエスト数 | +| `httping._rtt_count.error` | count | 失敗したリクエスト数 | +| `httping._rtt_ms.max` | ms | 成功したリクエストのレイテンシの最大値 | +| `httping._rtt_ms.min` | ms | 成功したリクエストのレイテンシの最小値 | +| `httping._rtt_ms.average` | ms | 成功したリクエストのレイテンシの平均値 | +| `httping._rtt_ms.90_percentile` | ms | 成功したリクエストのレイテンシの 90 パーセンタイル | + +なお、`rtt_ms.*` の各メトリクスは成功したリクエストのみを対象に算出されます。すべてのリクエストが失敗した場合は `rtt_ms.*` のメトリクスは出力されません。 -## Install +## License -Please download release page or `mkr plugin install monitoring-forge/mackerel-plugin-httping`. \ No newline at end of file +MIT License