簡単! Mackerel Pluginの作り方

2018/02/11

mackerel

t f B! P L

Mackerel、それは鯖管のためのサービス

Mackerel(日本語では鯖)はいわゆる監視サービス。監視データを送るagentを動かせば、データを受け取ってグラフにし、指定した条件になった場合にはアラートをメールやチャットで送ることができる。

監視対象項目はプラグインで拡張することができる。公式のPluginも用意されており、有名どころのミドルウェアやWebのアクセス監視はカバーされている。

プラグインの作り方

「アプリケーションのログを監視したい」「公式プラグインでは用意されていないxxxというソフトのログを監視したい」という場合、プラグインを作る必要がある。ただ、プラグインはSensuと互換性があり、また、MuninのPluginを動かすためのプラグインもあるので、それらをプラグインを探すのはアリだと思う。

とはいえ、なければ作る必要がある。

名前 値 時刻
を標準出力に出せばよいので、作ると言っても、基本的にはそれほど大げさなものにはならない。
名前
Mackerelのグラフでは、「custom.名前」で表示される。
  • ピリオドを2つ以上含むこと
  • 一番右のピリオドより右側にあるものが、グラフになる
値。測定値とか、グラフにする値。
時刻
値はいつの時点だったかを示す時刻。過去の時刻でもよい。
Bash scriptだと
#!/bin/bash
NAME='sample.script.test1'
D=$(date +%s)
V=1
echo $NAME $V $D
でOK。適当に名前をつけて(ただしtestという名前はやめておくこと)実行できるようにchmodしておく。
agentの設定ファイルであるmackerel-agent.confの最後の方に
[plugin.metrics.sample]
command = "上記scriptのフルパス"
と書き足してagentをreloadすれば、準備完了。2,3分でグラフが描かれる。

プラグイン自体、標準出力に値を出力するだけなので、debugもしやすい。ただ、実行時間が1分に制限されているので、ネットワーク越しに値を持ってくるときなどは注意しておいた方がよい。

ここまで抑えると、他人の書いたプラグインも読みやすくなる。例えば、mackerelでWeb Siteのステータスをチェックするも、このルールの中で行っているし、さらに、「名前」「値」「時刻」を複数行出すのもOKだということが読み取れる。

アプリのログを監視する

「〜という文字列が現れたら警告してほしい」というのであれば、check-log プラグインで十分対応できる。出現回数に対してアラートを出すまでの閾値も設定でき、柔軟性も高い。
しかし、「出現の傾向をグラフ化したい」となると、プラグインを作る必要がある。

単純にログファイルをgrep -cしてしまうと、累積値になってしまう。そこで、監視対象の期間に絞り込んだログファイルを一時的に生成する。

#!/bin/bash
ORG_LOG="/var/log/sample.log"
LOG="/tmp/$(basename $0).tmp.$$"

TARGET="$(date +%Y%m%d%H%M -d '1 minute ago')"
grep $TARGET $ORG_LOG > $LOG

NAME='sample.script.test2'
D=$(date +%s)
V=$(grep -c '対象文字列' $LOG)
echo $NAME $V $D

rm -f $LOG
ポイントは、TARGET=の行とその次のgrep。
ログファイルと同じ日付フォーマットを、dateコマンドで出力させる。ただし、「秒」は出力させない。そうすることで、1分の間に出力されたログに絞り込むことができる。
もう1つ、'1 minute ago'オプション。単純に時分までで絞り込むと、プラグインが10秒くらいで起動された時、対象のログは10秒分しか存在していないことになってしまう。1分程度のズレを許容すればこの2行で1分分のログを抽出できるので、妥協するかどうか、判断が必要になるところではある。そもそも、そこまで正確な値が必要であれば、アプリケーション側でそういったメトリクス収集の口を用意すべきだとは思うが。

細かい設定も可能だが

単純に「名前」「値」「時刻」を出力するだけだと、グラフのタイトルに「custom」というprefixがついてしまう。もちろん、これを回避する方法はあるのだが、プラグインが少し複雑になってしまう。ホストのカスタムメトリックを投稿する - Mackerel ヘルプにちゃんと記載されているので、頑張りたい人はそちらを見てほしい。あ、「名前」「値」「時刻」はタブで区切るべきなのか。ヘルプはちゃんと読まないと。

お決まりの一文。本サイトに掲載する情報に関しては、正しいものを提供することを務めていますが、掲載内容から、いかなる損失や損害などの被害が発生しても、責任は負いません。自己責任でご活用ください。


楽天で探す
楽天市場
にほんブログ村 IT技術ブログへ

人気の投稿

ブログ アーカイブ

自己紹介

開発からSREにクラスチェンジしました。

アフィリエイト

  • 当ブログ「Hiroaki's blog」は、amazon.co.jpを宣伝しリンクすることによってサイトが紹介料を獲得できる手段を提供することを目的に設定されたアフィリエイト宣伝プログラムである、Amazonアソシエイト・プログラムの参加者です。
  • 当ブログでは、第三者配信による広告サービスを利用しています。このような広告配信事業者は、ユーザーの興味に応じた商品やサービスの広告を表示するため、当サイトや他サイトへのアクセスに関する情報 (氏名、住所、メール アドレス、電話番号は含まれません) を使用することがあります。このプロセスの詳細やこのような情報が広告配信事業者に使用されないようにする方法については、ここをクリックしてください。
  • アクセストレードアフィリエイトプログラムに参加しています。
  • A8.netアフィリエイトプログラムに参加しています。
  • バリューコマースアフィリエイトプログラムに参加しています。
  • もしもアフィリエイトプログラムに参加しています。

プライバシーポリシー

当サイトにアクセスされる場合、IPアドレスなどの情報または閲覧状況に関するデータが機械的に生成され、場合によっては個人情報と関連付けられる可能性があります。プライバシー保護に関する適用法に準じて、これらの通信および閲覧に関するデータを収集、処理、および利用することがあります。
当サイトにアクセスされる場合、非個人情報(ブラウザの種類、OSの種類、ドメイン名、訪問数、平均滞在時間、ページ・ビューなど個人を特定できない情報)が自動収集される場合があります。当サイトのパフォーマンスやコンテンツを改善する目的で、これらの情報を利用する場合があります。
アフィリエイトでは成果を把握するためにcookie等を利用しています。それ以外の目的で使用されることはありません。詳しくは各社のページにて確認してください。
本サイトに掲載する情報に関しては、正しいものを提供することを務めていますが、掲載内容から、いかなる損失や損害などの被害が発生しても、当ブログでは責任を追いかねます。

QooQ