Splunkを使った仕事に関わらせてもらっています。

Splunk自体は中々作り込まれていて、画面をカスタマイズしたり、外部からRESTのAPIで操作する分には色々とでき、ドキュメントもそれなりにあります。

ただ、Splunkの上で動くSplunk Appという形で開発をする場合、ドキュメントが足りず、他のアプリの実装を見たり、試行錯誤するしかない部分も多いと感じました。

 

そんなわけで調べて見て分かったことを少しまとめておこうと思います。

Splunk Appの作成は、Splunkの管理画面から行うことができます。細かな手順は画面に従って行えばよいので省略しますが、作成すると、

$SPLUNK_HOME/etc/apps/<アプリ名>

というディレクトリが作成され、この中にSplunk Appのファイルが格納されます。

また、このディレクトリを手動で作成してもSplunk Appと認識します。

ただし、Splunk Appの中身を変えた場合は、Splunkの再起動を行う必要があります。行わないと、変更前のものとなるので、注意してください。

 

では、Splunk Appの中身は、次のディレクトリから構成されます。

  • default アプリケーションの設定を格納
  • local 個々の環境ごとの設定を格納
  • static 画像やHTMLファイル、JavaScriptライブラリなどの静的なリソースを格納
  • bin スクリプトを格納
  • appserver サーバサイドで動作するものを格納します。
そして、開発時はSplunkで提供される部品の組み合わせだけで開発できる場合は、defaultディレクトリの中のファイルを編集することになります。defaultディレクトリは次のようなものから構成されます。
  • app.conf アプリに関する情報を設定する
  • data/ui/nav アプリのメニューに関する設定ファイルを格納する
  • data/ui/views アプリのビューに関する設定ファイルを格納する
この他、Manuals for Splunk Administratorに記載のある設定ファイルが必要がある場合もあるかと思います。