Splunkの異常値、外れ値検出コマンド（anomalies, anomalousvalue, anomalydetection, outlier）

#はじめに

異常値や外れ値を検出したり、それを使ってイベントをフィルタかけたり、したいですよね。

・普段とは異なるイベントが出たら教えてほしい
・リアルタイムで、異常値が出たらすぐに教えてほしい
・一定期間で、異常値がx件以上発生したら教えてほしい
・オンデマンド分析で、異常値を持つイベントの件数や推移を調べたい

実はSPL一行で出せます。


なお、MLTKを使ってもDensity Functionでモデル化した異常検知とかもできます。

https://qiita.com/maroon/items/12d83e9d440d6c19ee4d


これもものすごく有用ですが、そこまで厳密じゃなくてもいいからさっと使いたいという場合に役に立つと思います。

#コマンドの概要

使えるコマンドについて私なりの理解でまとめました。

| コマンド名 | 概要 | 対象フィールド |
|:-|:-| :-|
| anomalies  | 特定のフィールドについて、直近n件（デフォルト100件）の類似度を元に「意外さ」を計算し、異常イベント抽出。 | 数値、文字列 |
| anomalousvalue | イベントの全フィールドまたは指定したフィールドについて、イベント全体から見た発生頻度や平均値からの乖離を用いて異常スコアを計算し、異常イベント抽出。 |数値、文字列 |
| anomalidetection  | イベントの全フィールドまたは指定したフィールドについて、指定したモード（anomalousvalueとoutlierを含む）で異常値を計算し、異常イベント抽出。 |数値、文字列 |
| outlier | イベントの全フィールドまたは指定したフィールドについて、四分位範囲（IQR）を用いて外れ値を検出し、外れ値を削除もしくは閾値に置き換え。 |数値 |

#テストデータ

こちらの地震情報をお借りします。過去30日分の全世界の地震情報です。
https://earthquake.usgs.gov/earthquakes/feed/v1.0/csv.php

とりあえず取り込み。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/5c037356-3215-1ba5-ce61-9688e2fb8b9a.png)

・マグニチュードのヒストグラム
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/83da5237-9371-a4a1-9b32-9632c380e458.png)

・地域ごとの発生数（アラスカも多いんですね）
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/fc5c7852-acac-a06e-92e2-bca88ab5e876.png)

・マグニチュード5以上の発生数時系列
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/a8cfaffb-3c73-57ee-12ed-203c1e3baea2.png)

それでは異常検知してみましょう。

#anomalies

https://docs.splunk.com/Documentation/Splunk/latest/SearchReference/Anomalies

「意外さ（unexpectedness）」を以下のように計算します。
`unexpectedness =  [s(P and X) - s(P)] / [s(P) + s(X)]`

s()は「どれだけ類似しているか」を計算する関数、Pは直近n件（デフォルト100件）のイベント、Xは対象のイベントです。
※残念ながらs()の詳細はありませんでした。

意外な場所（placeフィールド）で起こった地震を抽出するようにしてみます。

```go:SPL
| inputlookup earthquake.csv
``` placeの値に「10km SSE of Cabazon, CA」みたいなのがあったりするのでカンマ以降を抽出 ```
| rex field=place mode=sed "s/^.+,\s*//g" 
| anomalies field=place
```

下図の結果のように「unexpectedness」フィールドが新たに追加されています。
thresholdはデフォルト0.01で、それを上回る意外なイベントのみ抽出されています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/1c6e5175-140f-b80c-8249-02beacef575d.png)


全件14,200件のうち、1,639件が異常値とされています。
なんだか多い気がしますね。
値が結構バラバラだから直近100件だとあまり意外さが出にくいのかもしれません。
maxvaluesオプションで直近1,000件にしてみます。

```go:SPL
| inputlookup earthquake.csv
``` placeの値に「10km SSE of Cabazon, CA」みたいなのがあったりするのでカンマ以降を抽出 ```
| rex field=place mode=sed "s/^.+,\s*//g" 
| anomalies field=place maxvalues=1000
```
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/5d95cb4f-5269-4e6f-266f-7e74af988414.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/06ec7567-a859-5c23-407f-9f967262dd42.png)

26件まで減り、より意外な地域で起きた地震が分かるようになりました。

他のオプションとして`by`でグルーピング、`denylist`で意外ではないイベント一覧をルックアップファイルで指定、`labelonly=true`でunexpectedness値計算のみができたりします。

あまりチューニングする余地がないので扱いにくいですが「たまに変な値が生じるかもしれない」みたいなイベントであれば、それが何であれ拾ってくれるので有効かもしれません。


#anomalousvalue

https://docs.splunk.com/Documentation/Splunk/latest/SearchReference/Anomalousvalue

各フィールドについて頻度や平均値からの乖離を元に異常スコアを計算します。

```go:SPL
| inputlookup earthquake.csv
| anomalousvalue
```

下図のように、各フィールドについて異常スコアを計算し（Anomaly_Score_Num(...)、Anomaly_Score_Cat(...)）、閾値（デフォルト0.01）を下回るスコアを持つイベントのみを抽出しています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/b8bb2019-9050-4992-13aa-15513ef0a8e6.png)

オプションとして、異常スコアの閾値微調整、計算対象フィールド指定（複数フィールドも可）、`action=annotate`で除外なし、`action=summary`で各フィールドの異常値の各統計情報を計算したりなど、諸々できます。

例えば`anomalies`と同じようにplaceのみで異常検知してみました。閾値がデフォルトだと0件だったのでpthread=0.02とし緩めています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/4f1ea03d-6351-61d0-a810-75ccfde37235.png)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/d85152e8-2ce2-c6ed-1617-cf70eb659af7.png)
少々結果のメンツが違います。`anomalies`は直近n件と比較する一方、`anomalousvalue`は全体からの頻度を見ているので違っているのかもしれません。
（地震なので連続して発生しがちなため`anomalies`だと意外さが薄れたり？）

`anomalies`と比べるとイベント全体、複数フィールドを元に異常を判断してくれます。
使い勝手はこちらの方が良さそうです。

#anomalydetection

https://docs.splunk.com/Documentation/Splunk/latest/SearchReference/Anomalydetection

`anomalydetection`はコマンドのWrapperです。

`method`にhistogram、zscore、iqrを指定することで、それぞれのメソッドを使い異常検知してくれます。

<b>histogram (デフォルト)</b>: 詳細はありませんでした。[Histogram Based Outlier Detection](https://www.scutum.jp/information/waf_tech_blog/2018/03/waf-blog-055.html)かもしれません。
<b>zscore</b>: anomalousvalueを呼び出します
<b>iqr</b>: outlierを呼び出します

zscore、iqrはそれぞれのコマンドのオプションが使えます（全てではないですが）。

とりあえずデフォルトのhistogramで実行。
かなり厳しく、1件のみヒットしました。
（pthreshオプションで閾値調整もできます）

```go:SPL
| inputlookup earthquake.csv
| anomalydetection 
```
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/ddcf700b-fda8-e4ff-f14a-5f707d845d8e.png)

method=zscoreとし、anomalousvalueと同じ条件でplaceフィールドの異常検知をしたら同じ結果が得られました。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/147e5548-08cb-26b1-9437-15bd5b3e092f.png)

色々なメソッドで試したい場合に便利ですね。

#outlier

https://docs.splunk.com/Documentation/Splunk/latest/SearchReference/Outlier

これまでのanomaly系とは趣が異なり、以下ロジックで外れ値を検出し、値を削除または置き換えすることができます。
※anomaly系は異常値のあるイベントを抽出。

`フィールド値 < (25th percentile) - param*IQR または フィールド値 > (75th percentile) + param*IQRの場合は外れ値とみなす`
<b>param</b>: 閾値。デフォルト2.5。
<b>IQR</b>: 75パーセンタイルと25パーセンタイルの間の差（IQR = Q3 - Q1）。

デフォルトの動作（action=transform）は外れ値を閾値に置き換えます。
置き換えられる「閾値」は以下です。
`(75th percentile) + param*IQR`

さて、数値データであるdepthについて試してみましょう。

```go:SPL
| inputlookup earthquake.csv
| fields depth
| stats
```
distinct_countを見ると元データのdepthは3,948のユニークな値があることが分かります。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/b8297b4b-406e-f6ad-e110-5985412d2e6b.png)
outlierしてみます。

```go:SPL
| inputlookup earthquake.csv
| outlier depth
| fields depth
| stats
```
3,101件に減りました。他の統計値も変わっています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/372a39e0-5dbd-ea13-a09f-2ae9cd163155.png)



`mark=true`を付けると、変更した値の頭に000を付けてくれます。
これで試すと値が置き換わっていることが分かります。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/6565d99c-7331-56d3-a74e-68399edcad54.png)

action=removeにすると外れ値を削除します。

```go:SPL
| inputlookup earthquake.csv
| outlier depth action=remove
| fields depth
| stats
```
depthの件数が14,200件 → 13,060件になりました。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/0d1bb01c-e7cb-b38f-97ee-4b1ca63f093c.png)
外れ値がnullになっています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1218403/a578497e-8f9a-8f18-c7c8-36e45d96599d.png)

イベントごと削除したい場合はmark付けてsearchで除外すればOKですね。


#おまけ（自力計算）

もし既存のコマンドに頼らず自分で計算する場合もSplunkならちょろいです。
例えば平均値 ± 2σを閾値とする場合：

```go:SPL
| inputlookup earthquake.csv 
| eventstats avg(depth) as depth_avg, stdev(depth) as depth_stdev 
| eval upper_threshold = depth_avg + (depth_stdev * 2)
| eval lower_threshold = depth_avg - (depth_stdev * 2)
| eval is_outlier = case(depth > upper_threshold, 1, depth < lower_threshold, 1, true(), 0)
```