ようへいの日々精進XP

よかろうもん

Grafana v2.6 の Raw Document についてちょっと調べた雑なメモ

ちょっと調べて雑にメモりました。

tl;dr

docs.grafana.org

Raw Document について聞かれたけど、全然知らなくて申し訳ないなと思ったのでちょっと調べてみた。


メモ

Raw Document とは

If you want to show documents from Elasticsearch pick Raw Document as the first metric.

ドキュメントの冒頭には上記のように書かれている。ざっくり意訳すると...

  • Elasticsearch をデータソースとして利用している場合に
  • ドキュメント数を取得することが出来そう

This in combination with the JSON Data table transform will allow you to pick which fields in the document you want to show in the table.

さらに上記を読み解くと...

  • どうやら Table パネルで利用出来そう
  • Elasticsearch のドキュメントから任意の JSON キーを指定してその値を時系列で出力できる

うんちくではイマイチわからないので...

以下のような環境を作って試してみた。

f:id:inokara:20160305093358p:plain

Grafana のデータソースとして Elasticsearch を指定する

f:id:inokara:20160305090034p:plain

  • Type には Elasticsearch
  • URL には Elasticsearch の Endpoint URL
  • Access タイプは Elasticsearch の Endpoint URL を直接指定するので Proxy を選択
  • Index 名は Kibana で指定する場合と同様に [] 名前を指定して YYYY.MM.DD でタイムスタンプを指定する
  • 時系列フィールドとして @timestamp フィールドを指定する

Table パネルで Raw Document を指定する

  • まずは Add Panel で Table Panel を選択する

f:id:inokara:20160305091010p:plain

  • Metrics タブの Metric で Raw Document を選択する

f:id:inokara:20160305091020p:plain

  • Options タブの To Table Transform で JSON Data を選択する

f:id:inokara:20160305091030p:plain

JSON Data を選択する Elasticsearch のドキュメントフィールドが指定可能になるので、試しに @timestampsizecode を指定すると以下のように。

f:id:inokara:20160305091611p:plain


まだまだ疑問が残るけど

Raw Document とは

  • Elasticsearch をバックエンドとする際にドキュメント数を可視化することが出来ると思われる
  • 例えば、Elasticsearch にログを突っ込んでいる場合にはログの件数とか
  • 同様に table パネルを利用すると Kibana の Table panel のような使い方が出来ると思われる

気になったところ

  • Raw Document で JSON Data 指定する場合には Thresholds でカラムや文字に色を付けられない→仕様なのかな?
  • Grafana が解析出来ないクエリを設定してしまうと下図のような Warning となってしまい Query フィールドを閉じることが出来ない(× で閉じない)→この環境だけなのかな?

f:id:inokara:20160305092852p:plain

以上、メモでした。