Skip to content

Latest commit

 

History

History
80 lines (49 loc) · 4.61 KB

README_ja.md

File metadata and controls

80 lines (49 loc) · 4.61 KB

mackerel-statsd

概要

mackerel-statsdは、StasDプロトコルに則ったメトリックの合計値、あるいは最小値・最大値・平均を計算してMackerelに投稿するための、StasDサーバーです。

StatsDはメトリックを送信するシンプルなUDPプロトコルおよび処理系（Etsy社のブログおよびオリジナルのStasDのGitHub）で、アプリケーション開発者がメトリック送信を実装するのは容易です。

mackerel-statsdがなぜ必要か

2023年2月時点で、Mackerelは1分ごとにメトリックを受け取ります。つまり、監視している対象の値がその1分の中で激しく変動していたとしても、Mackerelに格納されるメトリックは取得時点の値だけです。

mackerel-statsdは、この問題を解決する一助となります。アプリケーションからStatsDプロトコルで投稿されるメトリックをmackerel-statsdが保管し、1分ごとにそれらの合計値、あるいは最小値・最大値・平均値をMackerelに投稿します。これにより、1分よりも短い間に起きた変化を捉えることができます。

mackerel-statsdは、StatsDプロトコルのうち、Counting（カウンタ値を受け取り、期間中の値の合計のメトリックとなる）とTiming（ミリ秒を受け取り、最小値・最大値・平均値のメトリックとなる）をサポートしています。

使い方

Goの開発環境を用意し、以下のコマンドでインストールを実行します。

go install github.com/mackerelio-labs/mackerel-statsd@latest

これで、$GOPATH/bin に mackerel-statsdファイルが用意されます。

起動は以下の書式です。

MACKEREL_APIKEY=MackerelのAPIキー $GOPATH/bin/mackerel-statsd -host ホストID
  • MACKEREL_APIKEY: MackerelのオーガニゼーションのAPIキーを指定します。書き込み（Write）を有効にしたAPIキーを生成してください。
  • -host: メトリックを紐付けるスタンダードホストのホストIDを指定します。

サンプル

example フォルダにサンプルを置いています。それぞれのフォルダ内で go run main.go を実行することで試すことができます。

  • sample-client : サイコロを10回振った出目の合計のメトリック（custom.statsd.sample.dice）と、はてな社トップページへのリクエストの10回のレイテンシーの平均・最大・最小のメトリック（custom.statsd.sample.http.hatena.average/max/min）を投稿します。間を置いて何度か実行してみてください。
  • sample-http-server : ローカルホストの8080ポートでWebサーバーが待ち受け、リクエスト処理のレイテンシーの平均・最大・最小のメトリック（custom.statsd.sample.http.request_.average/max/minおよびcustom.statsd.sample.http.request_favicon.ico.average/max/min）を投稿します。ブラウザでhttp://localhost:8080を開き、何度かリロードしてみてください。

sample-http-serverの実行例

自動サービス化

Linuxのsystemd環境向けのサービスファイルを用意しています。

  1. 各ファイルをシステムにコピーします。

    sudo cp mackerel-statsd /usr/local/bin
sudo cp example/systemd/mackerel-statsd.service /lib/systemd/system
sudo mkdir -p /etc/sysconfig
sudo cp example/systemd/mackerel-statsd.sysconfig /etc/sysconfig/mackerel-statsd

  2. /etc/sysconfig/mackerel-statsdファイルを編集し、Mackerel APIキー（MACKEREL_APIKEY）とホストID（HOSTID）をお使いのものに置き換えてください。

    sudo vi /etc/sysconfig/mackerel-statsd

  3. systemdサービスを有効化します。

    sudo systemctl enable mackerel-statsd

ライセンス

Copyright 2023 Hatena Co, Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.