2015年5月15日金曜日

Android で default で使える drawable 一覧

概要

drawableはボタンやアイコンにするいわゆる画像のことです
普通は「drawable-hdpi」や「drawable-mdpi」といったフォルダに .png ファイルを配置して「@drawable/hoge」みたいな感じで png ファイルを参照します

ただ、よく使うアイコンはAndroid SDKにデフォルトで搭載されています
デフォルトで搭載されているアイコンを使えば、いちいち自分で画像を作成する手間も省けます

環境

  • Mac OS X 10.10.3
  • Android SDK 24.1.2

使えるアイコンの一覧

全ては上記に記載されています
ここに記載されているリソースはデフォルトで使用できます
例えばお気に入りとかで使用する星アイコンは以下のように参照することができます

<item
  android:id="@+id/favorite"
  android:icon="@android:drawable/star_off"
  android:showAsAction="ifRoom"
  android:orderInCategory="20"
  android:title="@string/favorite"/>

上記の例はオプションメニュー(ActionBar)内で表示する項目にアイコンを設定する際にデフォルトのアイコン「star_off」を使った例です
「android:」の部分はもしかしたら不要かもしれません

ポイントは冒頭に紹介した一覧にあるアイコンしかデフォルトでは使えないということです
Webで調べると「ic_menu_refresh」などがデフォルトで使えるという記載があるのですが、コンパイルエラーになります
自分も一覧を見るまでは使えると思っていたのですがいざ使ってみるとコンパイルエラーとなり確かに一覧にも載っていませんでした

なのでコンパイルエラーになる場合はまず一覧に存在するアイコンなのか調べてみるといいと思います
残念なのは一覧にリソース名でしか紹介がないので、どんなアイコンなのかは実際に使ってみるか、リソース名でGoogleで画像検索とかするとわかると思います

最後に

デザインできない開発者にとってはこういうアイコン集をデフォルトで用意してくれるのは嬉しいです
また、デフォルトで用意されているアイコンは他のアプリで使われている可能性も高いのでUX的にもいいと思います
そのアイコンのコンテキストが implicit で理解されているとわざわざラベルをつける必要もなくなると思います

2015年5月12日火曜日

ElasticSearch + LogStash の連携を検証してみる

概要

ElasticSearch + Logstash の連携を検証してみました
本当に触りの部分だけ試しています

環境

  • CentOS 6.6 64bit
  • Java 1.8.0_31
  • ElasticSearch 1.5.2
  • LogStach 1.4.2

Javaインストール

yum -y install java-1.8.0-openjdk
echo 'export JAVA_HOME=/usr/lib/jvm/java/' >> ~/.bashrc
source ~/.bashrc

ElasticSearch インストール

cd /var/tmp
wget 'https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-1.5.2.zip'
unzip elasticsearch-1.5.2.zip
mv elasticsearch-1.5.2 /usr/local/
cd /usr/local/
ln -nfs elasticsearch-1.5.2 elasticsearch
echo 'export PATH=$PATH:/usr/local/elasticsearch/bin' >> ~/.bashrc
source ~/.bashrc

LogStash インストール

cd /var/tmp
wget 'https://download.elastic.co/logstash/logstash/logstash-1.4.2.zip'
unzip logstash-1.4.2.zip
mv logstash-1.4.2 /usr/local/
cd /usr/local/
ln -nfs logstash-1.4.2/ logstash
echo 'export PATH=$PATH:/usr/local/logstash/bin' >> ~/.bashrc
source ~/.bashrc

ElasticSearchとLogStashの連携

LogStashでアプリのログをElasticSearchに投げてみたいと思います
今回はElasticSearchもLogStashも同一ホストで動作することを想定しています

ElasticSearch起動

elasticsearch

今回はsupervisorなどでデーモン化はしていません
起動中はターミナルを閉じないようにしてください
9200番でLISTENしていることを確認してください

LogStashからログを投げてみる

logstash -e 'input { stdin { } } output { elasticsearch { host => localhost } }'

とすることでインタラクティブモードで起動し入力した文字列をElasticSearchに投げてくれます
起動したら適当な文字列を入力してみてください

そしたらElasticSearchにデータが投入されているか確認してみます

curl 'http://localhost:9200/_search?pretty'

これで確認すると入力したデータが格納されていることがわかると思います

Tips

「-e」で渡した設定はファイルに記載することも可能です

  • cat interactive_input.conf
input {
  stdin {
  }
}
output {
  elasticsearch {
    host => localhost
  }
}

こんな感じで設定ファイルには記載して「-f」オプションを使ってファイルを指定します

  • logstash -f interactive_input.conf

これでもOKです

最後に

インストールはzipをダウンロードし適当なディレクトリに配置することで実施しましたがyumとapt用のリポジトリも用意されているようです
http://www.elastic.co/guide/en/logstash/current/package-repositories.html

普通に使う場合はログを解析して使うことになると思います
ログ連携はまた別の記事で紹介できればと思います

参考サイト

2015年5月8日金曜日

Maven でビルド時に CheckStyle を実行する

概要

Mavenビルド時に CheckStyle を適用したいと思います
CodeStyleの目的は

  • ソースの可読性をあげる
  • 無駄なコードを排除する
  • 複数人で開発している場合に変数名やクラス名などに統一性を持たせる

などあります
ビルド時に実施することで強制的にスタイルを合わせることができるので間違いも発見しやすくなります

今回はEclipseを使って基本的な設定から独自のルール設定をする方法まで紹介したいと思います

環境

  • Windows7 64bit
  • Java 1.8.0_25
  • Maven 3.2.2
  • maven-checkstyle-plugin 2.1.5
  • Eclipse 4.4 Luna
  • Eclipse CheckStyle Plugin 6.5.0

maven-checkstyle-plugin のインストール

pom.xmlを編集します
<build> -> <plugins>配下に以下を追記することでインストール可能です

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>2.15</version>
    <executions>
        <execution>
            <phase>test</phase>
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <configLocation>checkstyle.xml</configLocation>
        <encoding>UTF-8</encoding>
        <consoleOutput>true</consoleOutput>
        <failsOnError>true</failsOnError>
        <linkXRef>false</linkXRef>
    </configuration>
</plugin>

Mavenビルド時のtestフェーズでCheckstyleを実施します
<configLocation>に独自のCheckstyleルールを設定することができます
ここを指定しないとデフォルトで提供されるconfig/sun_checks.xmlというルールが適用されます
それを使っても問題ないのですが、ルールが結構厳しいので今回はもう少し緩めのルールを使いたいと思います

checkstyle.xmlを作成する

その緩めのルールを作成したいと思います
ルールはデフォルトで用意されているものをコピーして作成したいと思います
デフォルトのルールをコピーするのにEclipseの「Checkstyle Plug-in」をインストールします

Checkstyle Plug-inのインストール

Help -> Eclipse Marketplace -> Search

で「checkstyle」と入力してください
以下のプラグインが検索されるのでInstall -> Finishとしてインストールしましょう
install_checkstyle_plugin.png

途中利用規約に同意してEclipseの再起動を求められるので再起動してください

再起動が完了すればインストールが完了です

デフォルトで用意されているのcheckstyle.xmlをコピーする

Window -> Preferences -> Checkstyle

と移動します
デフォルトで用意されているCheckstyleのルールが表示されます

プラグインのバージョンにもよると思いますが3種類のデフォルトルールがありました
そのうち「Google Checks」というルールがプラグインではデフォルトで使われているようです
今回はこれではなく「Sun Checks (Eclipse)」のルールを元にcheckstyle.xmlを作成します
list_default_checkstyle.png

上記の画面から「Sun Checks (Eclipse)」を選択した状態で「Copy」をクリックしてください
Typeに「External Configuration File」を選択します
Locationにはcheckstyle.xmlを保存するパスを指定します
今回はプロジェクトのカレントディレクトリを指定しましょう
create_checkstyle.png

こんな感じで入力してOKをクリックしましょう
するとプロジェクトの直下に「checkstyle.xml」というファイルができていると思います
これがCheckstyleするときに適用されるルールになります

ビルドしてみる

この状態でMavenビルドすればCheckStyleをかけることができます
testフェーズで実施されるのでmvn packageあたりでビルドすればOKです

初回はプラグインのダウンロード等が発生するので遅いですが2回目以降はスムーズに終了すると思います
maven-checkstyle-pluginのログの部分だけ抜粋すると以下のようになっていました

[INFO] --- maven-checkstyle-plugin:2.15:check (default) @ test-webapp ---
[INFO] Starting audit...
Audit done.

最終的にはBUILD SUCCESSになっていればOKです

ルールを独自に編集してみる

ルールの詳細はこちらを御覧ください

今回用意したcheckstyle.xmlはかなり緩く、そして結構謎なチェックルールが多いです
ほとんどコーティングしていない環境であれば警告はほぼでないと思いますが、結構開発していてコード量も多い場合は平気で1000とかの単位で警告が出ます
そんな場合はルールを変更して警告を無視するようなことをよくやります

例えば以下のようなコードを追加するだけで結構な警告が出るようになります

package test;

public class Test {

    private String name;

    public Test(String name) {
        super();
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

出現する警告は以下の通り

[INFO] --- maven-checkstyle-plugin:2.15:check (default) @ test-webapp ---
[INFO] Starting audit...
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:0: warning: Missing package-info.java file.
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:3: warning: Javadoc コメントがありません。
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:5:5: warning: Javadoc コメントがありません。
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:7:5: warning: Javadoc コメントがありません。
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:7:17: warning: Parameter name should be final.
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:7:24: warning: 'name' がフィールドを隠しています。
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:12:5: warning: Javadoc コメントがありません。
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:12:5: warning: メソッド 'getName' は拡張するように設計されていません - abstract か final か空である必要があります。
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:16:5: warning: Javadoc コメントがありません。
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:16:5: warning: メソッド 'setName' は拡張するように設計されていません - abstract か final か空である必要があります。
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:16:25: warning: Parameter name should be final.
C:\Users\kakakikikeke\workspace\test-webapp\src\main\java\test\Test.java:16:32: warning: 'name' がフィールドを隠しています。
Audit done.

今回の設定の場合は緩いルールを使っているので警告として怒られるのでビルド自体は最後までいきます
主に怒られるのはJavadoc系になると思います
Eclipse等のIDEで開発している場合IDE自体がある程度フォーマットしてくれるのでスペースがない等のエラーはあまり見ないと思います
ではこの警告の一部を無視する設定を紹介します

Checkstyleの警告を無視する設定を追加する

設定はEclipseであればGUIを使って行うことができます
もちろんcheckstyle.xmlを直接編集してXMLを書き直すでもOKです

Window -> Preferences -> Checkstyle

でプラグインに登録されているルールの一覧を表示したら今回のプロジェクトが使っているルールをダブルクリックしてください
するとルールを設定するウィンドウが表示されるのでここで

Javadoc Comments -> Package Javadoc

のチェックボックスをOFFにしてください
OFFにしたらOKでウィンドウを閉じてください
ignore_package_info_warning.png

これでcheckstyle.xmlの方にも設定を反映することができます
一旦ウィンドウを閉じて再度mvn packageでビルドしてみてください

再度ビルドしてみる

ビルドの結果を見てみましょう
すると先ほど警告されていた先頭の

warning: Missing package-info.java file.

が警告されなくなっているのがわかると思います

こんな感じでルールの編集を行うことができます
GUIからだと割りと直感的にルールを編集することができます
それでも英語のkeywordから何を設定しているのかを読み解く部分も出てくると思いますので
その場合はドキュメントを読むなりWebで調べるなりする必要が出てきます

最後に

導入自体は割りと簡単に行えますが導入後に自分でルールを調整しなければいけなく、XMLとの戦いを避けられないのが辛いところです

それでも一度導入できてしまえば再度変更することはほとんどないと思うので、それと比較するとCheckStyleを導入する恩知は大きいと思います

個人で開発する分には導入するメリットはそれほど無いかもしれませんが、チームで開発していたりオープンソースとして公開することを目標にしているのであれば
むしろ導入は必須と言っていいかもしれません

2015年5月7日木曜日

buildnumber-maven-plugin を使って war ファイル内の Manifest.MF にリビジョン情報を埋め込む

概要

作成したwarの中にgitのリビジョン情報があると何かと便利です
いつのコミットから生成されたwarなのか知りたいケースは多いと思います
Mavenを使ってリビジョン情報を埋め込むことができたので紹介します

環境

  • Windows7 64bit
  • Java 1.8.0_25
  • Maven 3.2.2
  • buildnumber-maven-plugin 1.3
  • maven-war-plugin 2.6

Mavenでサンプル用のWebアプリプロジェクトを作成

適当に作成すればOKです
すでにmvn packageでwarが作成できるプロジェクトがあればそれでもいいです
ない場合はこちらを参考に作成してください
Eclipseの場合はMavenプロジェクトを作成する際にアーティファクトIDにmaven-archetype-webappを選択してサンプルプロジェクトを作成してください

また、今回はプロジェクト自体がgitリポジトリで管理されていることを想定しているのでプロジェクトをgit化してください
リモートリポジトリはなくてもいいのでgit initできていればOKです
Eclipseの場合は

Team -> Share Project -> Git -> Use or create repository in parent folder or project -> Create Repository

としてgit化してください

そしてgit add->git commitとしてはじめのコミットを作成しておきましょう

buildnumber-maven-pluginの設定

pom.xmlを編集します
<build> -> <plugins>タグ内に以下のプラグインを追加します

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>buildnumber-maven-plugin</artifactId>
    <version>1.3</version>
    <executions>
        <execution>
            <phase>validate</phase>
            <goals>
                <goal>create</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <doCheck>false</doCheck>
        <doUpdate>false</doUpdate>
    </configuration>
</plugin>

上記を記載することでbuildnumber-maven-pluginが有効になります

ポイントはdoCheckとdoUpdateのタグの部分です
falseを設定することで以下の効果があります

  • git statusを使って差分チェックをしなくなります
  • git pullをして最新のソースをremoteからマージしなくなります

上記が有効だとmvnビルドするのにいちいちgitコミットしなければいけないのとgit pullをするための認証情報の設定を別途記載する必要があります
trueでも設定さえちゃんとされていればビルドは次に進みますが個人的にはyak shavingしているだけの印象だったのでfalseを設定しました
また、falseを設定することでgitコマンド自体が不要になるのでEclipse上でmvnビルドしている場合は

[ERROR] ‘git’ は、内部コマンドまたは外部コマンド、操作可能なプログラムまたはバッチ ファイルとして認識されていません。

というエラーが出るのを回避することもできます

warをアーカイブするときにManifest.MFを拡張

Manifest.MFを拡張するにはmaven-war-pluginを定義し直します
pom.xmlを編集します
<build> -> <plugins>タグ内に以下のプラグインを追加します

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-war-plugin</artifactId>
    <version>2.6</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>war</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <archive>
            <manifestEntries>
                <Implementation-ScmBranch>${scmBranch}</Implementation-ScmBranch>
                <Implementation-Build>${buildNumber}</Implementation-Build>
            </manifestEntries>
        </archive>
    </configuration>
</plugin>

ポイントは<archive> -> <manifestEntries>内の2つの宣言で特にvalueの変数が重要です
buildnumber-maven-pluginを有効にすることで${scmBranch}と${buildNumber}という変数が使えるようになります
ここで指定するタグは何でもOKです
記載したタグ情報がそのままManifest.MFに記載されることになります

scm の設定を追記

どこのgitのリビジョン情報を参照するのかpom.xml内に記載する必要があります
この設定は<project>タグ直下に記載してください

この定義がないとcreate failed: The scm url cannot be null.という言われて怒られます
以下の設定をpom.xmlに記載します

<scm>
    <connection>scm:git:file://.</connection>
    <developerConnection>scm:git:file://.</developerConnection>
    <url>scm:git:file://.</url>
    <tag>HEAD</tag>
</scm>

今回の想定はプロジェクト自体がgitで管理されていることを想定しています
なのでプロジェクト自体を指し示すようにscmを定義します
もちろんここにはGithubのURLやイントラネット内にあるgitリポジトリを指定することも可能です

ビルドしてみる

ここまで設定できたらビルドしてみましょう
コマンドで実行する場合は
mvn package
でOKです

Eclipseで実行する場合はRun As -> Maven build でgoalsにpackageを指定して実行しましょう

ビルドが成功するとtargetディレクトリ配下にwarファイルが作成できています
このwarファイルを解凍してMETA-INF/Manifest.MFを見てみましょう
以下のようにリビジョン情報とビルドしたブランチ情報が追記されていればOKです

Manifest-Version: 1.0
Built-By: kakakikikeke
Build-Jdk: 1.8.0_25
Implementation-ScmBranch: master
Created-By: Apache Maven 3.2.1
Implementation-Build: 29fb55a9daa2afc3961b9759d0f4e50ca3cac281
Archiver-Version: Plexus Archiver

紹介は以上です
今回はリビジョン情報を埋め込みましたがManifest.MFには他にもいろいろな情報を埋め込めるので好きな情報を埋め込むといいと思います

参考サイト

2015年4月30日木曜日

cannot send list of active checks to [$IP]: host [$HOSTNAME] not found

概要

Zabbix Proxy で監視設定をしている際にタイトルのエラーがずっと発生していつまで経ってもホストの監視が有効にならなかった

環境

  • CentOS 6.6 64bit
  • Zabbix Server 2.0.5
  • Zabbix Proxy 2.0.14
  • Zabbix Agent 2.0.14

エラーの詳細

エージェント側とプロキシ側で以下のログがずっと出続けいる状態が発生しました

  • プロキシ側
    cannot send list of active checks to …
  • エージェント側
    no active checks on server …

監視対象のZabbix Agentの設定、分散監視するZabbix Proxyの設定はすでに完了しているものとします
設定とは具体的にはzabbix_agentd.confやzabbix_proxy.confの記載が完了していてプロセスも起動している状態です
またACL等も問題なく設定されている状態です

この状態で当該エラーが発生してホストの監視がずっと行われていませんでした

原因調査

Zabbix Agent側の設定やZabbix Proxy側の設定を散々変更してみたのですが、一向に解消されませんでした
原点に立ち返って再度ログを眺めてみると/var/log/zabbix/zabbix_proxy.logに以下のようなログが出ていました

failed to update local proxy configuration copy: invalid field name "items.filter"

このログを頼りに調査を続けるとどうやらZabbix Proxyに必要なMySQLのスキーマがおかしいことがわかりました

Zabbix ProxyはZabbix Serverとデータの同期を行っています
具体的にはホストの監視設定(アイテム等)になります
このときにZabbix Proxy側のスキーマがZabbix Server側のスキーマとあわずにうまくのデータが同期できていなかったようです

ここまで来てピンと来たのですが、Zabbix Serverは古くから使われているサーバでバージョンが古く「2.0.5」でした
対してZabbix ProxyとZabbix Agentは最近構築したサーバでここには最新のZabbix ProxyとZabbix Agentをインストールしていました
最新バージョンは2.4.5になります

対応方法

結論は

2.4.5のZabbix ProxyとZabbix Agentを一旦アンインストールして2.0.14のProxyとAgentを再インストールしました

になります
すべてyumで管理していたので

yum erase zabbix_proxy
yum erase zabbix_agent
yum erase zabbix

で最新バージョンのパッケージを削除し

rpm -ivh http://repo.zabbix.com/zabbix/2.0/rhel/6/x86_64/zabbix-release-2.0-1.el6.noarch.rpm
yum clean all
yum install zabbix-proxy
yum install zabbix-agent

で再度インストールしたあとに

mysql -u user -p zabbix < /usr/share/doc/zabbix-proxy-mysql-2.0.14/create/schema.sql

という感じで2.0系のDBスキーマをZabbix Proxy用に当ててあげれば問題なく動作しました

最後に

今回学んだ教訓は

Zabbix Serverのバージョンに合わせてZabbix ProxyとZabbix Agentのバージョンも合わせよう
そうしないとDBのスキーマが異なりうまく監視データをZabbix Proxy上に登録することができない

ということです
本当はセキュリティの関係とかもあって最新版を使いたいところなのですが、どうやらDBのスキーマの関係で無理なようです
マイナーバージョンは異なっていても問題ないようです

  • Zabbix Server 2.0.5 <–> Zabbix Proxy 2.0.14 の組み合わせでは問題なく動作した

新規でZabbix Serverも構築する場合は今回のような問題に遭遇することは少ないと思いますが
Zabbix Proxyを使って監視対象の新規サービスを増やす場合などに陥りそうです

2015年4月28日火曜日

CentOS に公式の MySQL の最新版を yum でインストールする方法

概要

CentOSにMySQLの最新版をyumコマンドでインストールしてみました
備忘録として残しておきます

環境

  • CentOS 6.6 64bit
  • MySQL 5.6.24

インストール

  • MySQL公式のリポジトリをインストール
rpm -ivh http://dev.mysql.com/get/mysql-community-release-el6-5.noarch.rpm
  • clean 後にインストール
yum clean all
yum -y install mysql-community-server

mysql-community-client, mysql-community-common, mysql-community-libs, mysql-community-libs-compat も同時にインストールされます

  • 動作確認
service mysqld start

mysql -u root
  • 自動起動
chkconfig mysqld on
  • アドミンのパスワード設定
/usr/bin/mysqladmin -u root password 'new-password'
  • 任意のユーザ作成
select password('hogehoge');

でハッシュ化されたパスワードを作成して

grant select on test.* to 'test_r'@'localhost' IDENTIFIED BY PASSWORD 'ハッシュ化されたパスワードを入力';

2015年4月24日金曜日

CentOS でsupervisor を使ってシェルスクリプトとデーモン化してみた

概要

Supervisor は launchd, daemontools, runit のようなプロセスをデーモン化するためのツールです
デーモン化をプログラム上で実装するのが面倒くさい場合に使えるツールです
今回はCentOS上で supervisor を使ってシェルスクリプトをデーモン化してみました

環境

  • CentOS 6.3 64bit
  • supervisor 2.1.9

Supervisorのインストール

今回はepelリポジトリを追加してyumでsupervisorをインストールします
理由はインストールが簡単なのと起動スクリプトなど必要なリソースが揃っているからです
ただ、最新版のsupervisorをインストールしたい場合はyumではなくpythonのパッケージ管理の仕組みであるpiporeasy_installを使ってインストールすることをおすすめします
もしくはCentOSの6.6以上を使えばepelでも3系がインストールできるかもしれません
supervisorの2系はバージョン的にはかなり古く特にconfigファイルの書き方が3系とは全然違うのでご注意ください

rpm -ivh http://ftp.riken.jp/Linux/fedora/epel/6/x86_64/epel-release-6-8.noarch.rpm
yum clean all
yum -y install supervisor

バージョンを確認してみます

rpm -qa | grep supervisor

supervisor-2.1-9.el6.noarch

デーモン化するシェルスクリプトの準備

基本は何でもOKです

今回は自分がGistで公開しているシェルスクリプトを使ってみます
何をするシェルスクリプトか説明すると

  • 指定したディレクトリ配下にあるファイルを別の指定したディレクトリに1ファイルずつ移行するシェルスクリプト

になります
以下一応、実行するためのインストール用のコマンドを記載しておきます

mkdir /opt/supervisor
cd /opt/supervisor
wget https://gist.githubusercontent.com/kakakikikeke/10dc7dc6dca2f0675989/raw/342f9defd96862a97573a3e08a2ac6737ce9ee6b/dir2dir.sh
wget http://www.mitchy-world.jp/itmemo/shell/download/06.zip
unzip 06.zip
mv 06/common1.sh .
sed -i -e 's/LOG_DIR=\/home\/mitchy\/log\//LOG_DIR=`pwd`"\/"/' common1.sh
sed -i -e 's/SYSTEM_LOG_LEVEL=INFO/SYSTEM_LOG_LEVEL=DEBUG/' common1.sh
sed -i -e 's/.\/common1.sh/\/opt\/supervisor\/common1.sh/' dir2dir.sh

デーモン化するためのsupervisorスクリプトを作成

supervisor.confという設定ファイルがあるのでこれに直接記載します
[include]という仕組みがありこれを使って別ファイルに設定を切り出すことも可能です

  • vim /etc/supervisord.conf
[program:dir2dir]
command=sh /opt/supervisor/dir2dir.sh /opt/supervisor/target_dir/ /path/to/source_dir/
autostart=true
autorestart=true
logfile=/var/log/supervisor/dir2dir.log

commandはそのまんまでsupervisor上で動作させるコマンドを記述します
シェル内でファイルの参照などで相対パスを記載している場合にうまく動作しない場合があるので絶対パスで記載しておくといいです
autostartはsupervisorの起動と同時にプログラムを起動するかのオプションです
trueの場合は自動で起動します
autorestartは起動しているプログラムがハングしたり何かしたらの影響で停止したときに自動で再起動させるかどうかを指定します
trueの場合はsupervisorが自動で再起動してくれます

他にもいろいろとオプションが存在しています
Webで検索するか/etc/supervisord.conf内にサンプルもあるので参考にするといいと思います

Supervisorを起動

ではsupervisorを起動してみましょう

service supervisord start

でOKです
supervisorには管理用のコマンドが用意されておりsupervisorctlを使うと現在supervisor上で動作しているプロセスの状態を確認することができます

supervisorctl で状態の確認

まずsupervisorctlを実行してみましょう
するとsupervisor>というプロンプトに変更すると思います
この状態でsupervisorctl用のコマンドを発行するができます

主に使用するのは以下の通りです

  • status
    動作中のプラグラムの一覧を表示します
    起動中のプログラムはRUNNINGになっています、FATALはプログラム自体が壊れている可能性があるのでプラグラムの修正が必要です
  • start
    指定したプログラムを起動します
  • stop
    指定したプログラムを停止します
  • reload
    supervisor.confを書き換えた場合にgracefulに設定を反映することができます

上記以外のコマンドはhelpというコマンドで確認できます
更に詳細にコマンドを確認したい場合はhelpのあとに確認したいコマンドを付与して実行すればOKです

ログを確認してみる

ログはプログラム本体が吐くログはもちろん出力されます
それとは別にsupervisorが各プログラムごとにログを出力してくれています
今回の場合はsupervisor.confに記載したlogfileという項目のパスに出力してくれています
基本的には何も出力されませんが、supervisorがプログラムを再起動した場合や開始、終了時にログを残してくれます

最後に

今回はバージョン2で実施しました
冒頭も記載しましたがバージョン3ではconfigファイルの書き方が変わっているのでご注意ください
また、今回のシェルもそうですがシェル自体が終了してしまうシェルの場合リトライを何度か実施して最終的にはFATALのステータスになります
supervisorの使いどころとしてはnohupや&でバックグラウンド実行していたプログラムをsupervisorに移行する感じでだと思います