maehachi08 Anything Blog

今回は、Muninプラグインの書き方について書いていきます。また、自分も１から勉強しているところなので、１つMuninプラグインを書き上げようと思います。

Muninプラグインは誰でも作れる

Muninプラグインはすでにあるものを利用することが多いですが、必要なら誰にでも作れるものです。

Muninプラグインはmunin-nodeに対して特定のフォーマットで(RRDの構成に基づく)グラフ情報とリソース値を返すことが出来ればいいので、perl、ruby、shellのようなスクリプト言語で簡単に作成できます。もちろん、C言語などで書いてコンパイルしたバイナリでも同様の出力が得られるように書けば問題ありません。

Munin公式ページの How to write Munin plugins ではLoad Averageの値を監視するためのプラグインをshellで書く行程を説明しており、実際シンプルなshellスクリプトです。まさにMuninプラグインのHello World!なので一度目を通すだけでも価値はあると思います。

プロセスごとのSwapサイズをグラフ化するMuninプラグインを作ろう

• LinuxでプロセスごとのSwap Sizeを確認する方法

上記の記事で書いたPerlスクリプトを参考にMuninプラグインを書いてみたいと思います。

Muninプラグインの構成

自分はMuninプラグインは大きく2つのプログラムから成ると考えています。

1. リソース値を取得するプログラム

• 監視対象となる値を取得するプログラム
• /proc/[PID]/status の VmSwap の値を取得し単位をKBからBytesへ整形します

今回作成するMuninプラグインは、 /usr/share/munin/plugins/proc_swapsize_ として配置し、 /etc/munin/plugins/proc_swapsize_httpd のように末尾に監視したいプロセス名を付加したファイル名で /etc/munin/plugins ディレクトリにシンボリックリンクを作成することで動作します。

したがって、ファイル名末尾のプロセス名を抽出して対象プロセスのスワップサイズを取得します。コードとしては以下のようなものです。

#--------------------------------------------------------------------------
# Data processing section
#--------------------------------------------------------------------------
my $process_name_small     = basename( $0 )=~ s/.*_//r;
my $process_name_camelcase = ucfirst $process_name_small;
my @pids                   = `/usr/bin/pgrep $process_name_small | /bin/sort -n`;

my @process_swaps;
foreach my $pid ( @pids ) {

    chomp $pid;

    if ( ! -f "/proc/$pid/status" ) {
        # file not found! next.
        next;
    }

    my $swap_size_kb = `/bin/grep VmSwap /proc/$pid/status | /bin/awk '{print \$2}'`;
    chomp $swap_size_kb;
    my $swap_size = $swap_size_kb * 1024;
    push( @process_swaps, $swap_size );
}

my $process_count = @process_swaps;

2. munin-nodeに情報を渡すプログラム

• 取得した監視対象の値をmuninマスタがrrdgraphに引き渡す画像生成オプション群(graph_から始まるオプション)などをmunin-nodeに渡すプログラム
• 渡すといっても具体的にはprintfなどで標準出力するだけ

コードとしては以下のようなものです。

#--------------------------------------------------------------------------
# Print attributes section
#--------------------------------------------------------------------------
if ( $mode eq 'config' ) {

    # Global attributes
    printf "graph_category swap\n";
    printf "graph_title    $process_name_camelcase processes swap size\n";
    printf "graph_args     --base 1024 --lower-limit 0\n";
    printf "graph_vlabel   Bytes\n";
    printf "graph_vtitle   Swap size\n";
    printf "graph_scale    yes\n";
    printf "graph_info     This graph shows the swap size of $process_name_small processes.\n";
    printf "graph_total    total\n";

}


# Datasource-specific plugin attributes
for ( my $i=1; $i<=$process_count; $i++ ) {
    my $value_name = "$process_name_small" . "_" . "$i";
    my $swap_size_per_proc = shift( @process_swaps );

    if ( $mode eq 'config' ) {
        if ( $i == 1 ) {
            print "$value_name" . "." . "draw " . "AREA" . "\n";
        } else {
            print "$value_name" . "." . "draw " . "STACK" . "\n";
        }

        print "$value_name" . "." . "type "  . "GAUGE"  . "\n";
        print "$value_name" . "." . "label " . "$value_name"  . "\n";
    }

    print "$value_name" . "." . "value " . "$swap_size_per_proc" . "\n";
}

printするオプションにはどのようなものがあるかを次項でリストにしました。

Muninプラグインからmunin-nodeに渡す情報

1) Global attributes

• refs http://munin-monitoring.org/wiki/protocol-config

Global attributesはプラグイン全体に影響する設定群です。

2) Datasource-specific plugin attributes

• refs http://munin-monitoring.org/wiki/protocol-config#Datasourceattributes
• refs http://munin-monitoring.org/wiki/fieldnames

個別のデータソースに対して影響する設定群です。attributesの設定は、各attributes名をデータソース名( fieldname )とドットで連結して指定します。

以上がMuninプラグインにおけるmunin-nodeに渡すことができるオプションです。

プラグインのドキュメントフォーマット(perl)

Muninプラグインを書く中で、使い方や環境変数オプション等についてドキュメントを作成しておいた方が便利でしょうし、公開することを想定するならドキュメントは作成するべきです。

今回は、http://munin-monitoring.org/browser/munin-contrib/plugins/system/dar_memusage を参考にしました。

perlドキュメントの書き方については、 http://perldoc.jp/docs/perl/5.6.1/perlpod.pod などを参考にします。

以下で、どのような項目をドキュメントとして作成すべきなのか、纏めてみました。

MAGIC MARKERSの補足

MAGIC MARKERS の設定をしておくことで、munin-node-configure コマンドでプラグインを管理することが出来ます。munin-node-configureコマンドは、Muninプラグイン設定補助ツールです。

単体で使用できる(非ワイルドカードプラグイン)では以下のように設定します。

 #%# family=auto
 #%# capabilities=autoconf

今回のようにワイルドカードプラグインの場合は以下のように設定します。こうすることで、munin-node-configureは、suggest引数付きでワイルドカードプラグインを実行します。

#%# family=auto
#%# capabilities=autoconf suggest

ということでプラグイン作成しました

https://github.com/maehachi08/munin-plugins-proc_swapsize_

proc_swapsize_ という名前の、ワイルドカードプラグインを作成しました。

ワイルドカードプラグインとはファイル名末尾がアンダースコア( _ )で終わっていてるプラグインのことで、アンダースコアの後にキーワードを付加することでそのキーワードに対応した動作をする必要があります。ワイルドカードプラグインについては、 http://munin-monitoring.org/wiki/PluginWildcard を参照してください。

注意点としては、Perl バージョン 5.14.0以降が必須である ことでしょうか。

これは、正規表現置換において、非破壊置換オプション( /r option )を利用しているためです。

該当部分を書き直せば、Perl バージョン 5.14.0より古いバージョンでも使用できるかと思います。(検証はしていませんが)