目次

はじめに

この本の対象読者
この本でどんな知識が得られるのか
Splunkのバージョン
Web UIのメニューについて
免責事項
表記関係について
底本について

第1章 Splunk Appとは

1.1 ダッシュボードとは

第2章 Splunk Appの新規作成

2.1 Splunk Appのファイル構成

第3章 開発環境の準備

3.1 Dockerコンテナの利用方法
3.2 Splunk管理コマンドの実行
3.3 Splunk Appの開発環境から本番環境への移行

第4章 データの入力・フィールドの抽出

4.1 最初に:各設定のApp定義について
4.2 データ入力
4.3 どのようにデータを取り込むか
4.4 IndexとSource type
4.5 必要な情報(フィールド)の抽出

第5章 ダッシュボードの作成

5.1 ダッシュボードの作成方法
5.2 Dashboard editor
5.3 ダッシュボードに配置可能なコンポーネント
5.4 ナビゲーションメニュー

第6章 パネルの基礎知識

6.1 パネルに掲載可能なVisualizationの種類
6.2 サーチ画面によるVisualization用クエリーの検討
6.3 可視化フォーマットの変更
6.4 Trellis layout

第7章 パネル作成のためのクエリー

7.1 パネル作成のためのクエリーの基本形
7.2 必要なイベントの抽出
7.3 加工系コマンド
7.4 統計出力
7.5 地図情報用のクエリーについて

第8章 フォームを使う

8.1 フォームとは
8.2 フォームの種類
8.3 トークン
8.4 フォームの作成
8.5 Time フォームの利用(Shared Time Picker)

第9章 ドリルダウンを使う

9.1 ドリルダウンとは

第10章 Simple XMLの編集

10.1 ソースエディターについて
10.2 Simple XMLの基本的な構造
10.3 Simple XML上でのパネルの表現
10.4 サーチの定義
10.5 共通のサーチ(Base search)の作成と利用
10.6 トークンの値の設定

第11章 Appのパッケージング

11.1 パッケージングにあたっての準備
11.2 パッケージングの実行
11.3 他のSplunkでのパッケージのインストール
11.4 SplunkbaseでのAppの公開について

第12章 ユーザーにとって使いやすいダッシュボードを目指す

12.1 ユーザーへのヒアリング
12.2 パネルのレイアウト
12.3 ドリルダウンの活用:サマリから詳細へ
12.4 適切なテキストの付加
12.5 参考:ダッシュボードデザインのガイドライン

おわりに

はじめに

 「Splunk Appの作りかた ダッシュボードApp編」を手にとっていただき、ありがとうございます。本書ではタイトルのとおり、多くの企業で使われているSIEM製品「Splunk」上で、Splunk Appを作る方法を解説しています。またサブタイトルに「ダッシュボードApps編」とあるように、この本でフォーカスしているのは一番手軽に作成できるダッシュボードのみのAppの作り方です1

 Splunkのダッシュボード機能は非常に充実しています。クエリーを利用してさまざまな形でデータを抽出できますし、また「トークン」(通常のプログラムにおける変数にあたるものです)を利用することで、入力フォームやドリルダウンなども簡単に実装でき、高度なダッシュボードを作成することができます。

 しかし、Splunkでのダッシュボードを作るのは敷居が高い……と感じる方も多いようです。特に必要なデータを抽出するためのクエリーについては、どのように書けばよいのかよくわからないと思われているかもしれません。

 本書ではそんな方に向けてダッシュボードの作り方、そしてそれをSplunk Appとして配布可能なパッケージとする方法についてノウハウをまとめました。またその前段として、収集したデータから必要なフィールド情報を抽出する方法なども収録しています。ダッシュボードAppを作る上で必要な情報がひととおり載ったリファレンスとして活用してください。

この本の対象読者

 ・Splunkのダッシュボードでどんなことができるのか、興味がある方

 ・Splunkをすでに利用しているが、ダッシュボードの作り方がよくわからない方。もしくは、パネルを並べるくらいはできるがそれ以上の使い方を知りたい方

この本でどんな知識が得られるのか

 ・Splunkダッシュボードの概要

 ・必要なデータの抽出方法

 ・パネルの作り方

 ・フォームやドリルダウンなど、トークンを利用したダッシュボードの高度な使い方

Splunkのバージョン

 本書執筆にあたって筆者が利用したSplunkバージョンは7.0.3です。

サンプルログ

 本書では、クエリーを記述する際、基本的にApacheのアクセスログを利用しています。また、実際に解析するログは、「体系的に学ぶ 安全なWebアプリケーションの作り方」(徳丸浩氏著、SBクリエイティブ刊)2で紹介されている実習用仮想マシン「wasbook」から取得しました(この仮想マシンを動かし、アクセスした際のログをSplunkに取り込んでいます)。

Web UIのメニューについて

 SplunkのWeb UIのメニューについては、英語版での表記を採用しています。日本語へは適宜読み替えてください。

免責事項

 本書に記載された内容は、情報の提供のみを目的としています。したがって、本書を用いた開発、製作、運用は、必ずご自身の責任と判断によって行ってください。これらの情報による開発、製作、運用の結果について、著者はいかなる責任も負いません。

表記関係について

 本書に記載されている会社名、製品名などは、一般に各社の登録商標または商標、商品名です。会社名、製品名については、本文中では©、®、™マークなどは表示していません。

底本について

 本書籍は、技術系同人誌即売会「技術書典5」で頒布されたものを底本としています。

1. より正確には、Simple XMLのみを使ったAppの作り方、です。なお公式には特に「ダッシュボードApp」というカテゴリーがあるわけではなく、便宜上そのように本書で呼んでいるだけですので、この点ご留意ください。

2. https://www.sbcr.jp/products/4797393163.html

試し読みはここまでです。
この続きは、製品版でお楽しみください。