はじめに
Datadog で Sales Engineer をしている parupappa です
この記事は、Datadog Advent Calendar 2024の14日目の記事です。
突然ですが、みなさん、Datadog Notebook 使っていますか？
中の人間が言うのもなんですが、数ある Deatadog の機能の中では、なかなかニッチな(存在感が薄い)機能なのではないかと思っています🧐
今回は、そんな Datadog Notebook について改めて存在感をアピールしていこうという記事になっております！
Datadog Notebook
Datadog Notebook について知らない方はまずはこちらをご覧いただければなんとなく掴めると思います。
一言で言うと、Notion や Google Docs, Confluence などのドキュメントツールに、Datadog 独自のコンポーネントを組み込めるように拡張したものです。
Notebook ページの Template Gallery の中にも、How to use Daatadog Notebooks というテンプレートがあるのでそちらも合わせてご覧ください
主な使い方や Tips については 過去の Datadog Advent Calendar や Meetup で書かれた以下のブログがとても貴重なのでぜひご覧ください！
なので、ここではよりユースケースに当てはめた形でご紹介しようと思います。
How to use
Case1 - Document Library
１つ目の使い方は、ドキュメントライブラリーとして使用することです。
Datadog Notebook は Dashboard, Monitor, Log など Detadog 内で定義されるリソースに対して、ネイティブで統合されるため、コンポーネントを自由に埋め込むことが可能です
（スクリーンショットのような静的画像ではないので、時系列データとして保持したまま参照することが可能）
また、Dashboard のグラフなどは Notebook に対しても Datadog 内での操作感と同様に、ドラッグアンドドロップやコピペ（Cmd + C）で簡単に操作できるので、気持ちの良い UI/UX になっている点も推しポイントです☺️
Template Gallery
少し上でも触れましたが、 Datadog では、カスタマイズ可能なすぐに使える Notebook として Template Gallary を提供しています。
個人的に特にオススメなのは、以下のテンプレートです
具体的な内容については後述します。
Custom Temlates
またそれだけでなく、Custom Templates として、自分たちオリジナルのテンプレートを作成することができます。
なので例えば・・・
- team ごと（SRE, Platform, Application）での Datadog に関するオンボーディング Notebook
- team ごとのコストレポートの雛形
などなど、特に Notebook では team でのタグやフィルタリングを設定できるので、team ごとでのテンプレートを Custom Templates として用意してもらうと機能とマッチするのではないかと感じています。
Case2 - Incident Management
2つ目の使い方として、広くインシデントマネジメントに使えるという要素があります。
少し古いので UI の違いやアップデートが入っている部分もありますが、以下のブログを見ていただくとイメージがつくと思います。
- 2017年
- 2020年
特に、Template Gallery の Incident Report は、あらかじめ Incidet Report として必要な要素が詰まっており、何がどのくらい起きたら Incident と定義するかの Graph を設定するだけで、定期的に見ることができるダッシュボードのような使い方ができると思います。
また、左上の Add Template Variables を押すと、Notebook に対する変数を設定できるので、環境名や、cluster 名などお好きなタグを使用して、変数化したい部分を設定できるので、複数個同じようなテンプレートを用意する必要もないです。
また Notebook は Bits AI とも統合されているので、Bits AI が Incident の経緯をまとめてくれる機能(Bits AI Autonomous Investigations)も今年の DASH で発表されています。
具体的な使い方イメージは動画を見ていただけるとイメージがつくかと思います！
こちらのブログも併せてご覧ください
※ Bits AI Autonomous Investigations は現在、Preview での利用となっているため、気になる方はこちらから Request をしてみてください！
Case3 - Postmortem
すでに触れられている、Template Gallery の Incident Postmortem もオススメしたい内容です。
上で説明したような、Bits AI との統合により、Incident Postmortem のテンプレートをベースとして、各インシデントに合わせたユニークなケースを自動生成してくれるので、今後の機能拡充にさらにご期待ください！
こちらのブログで Incident Management から Postmortem までの使い方イメージが解説されています。
Others
Copy formatted Contents
Notebook の共有の方法として、Dashboard と同じような JSON での出力はもちろんのこと Copy formatted Contents という出力形式もあります。
これは、Notebook の内容を HTML としてコピーした状態になるので、HTML フォーマットに対応しているエディタ(Google Docs, MS Word)とかに貼り付けるとそのまま、
同じ見た目で PDF も Markdown も出力できるようになっています（ちなみに、Markdown はテキストだけではなく、base64エンコードされたグラフの画像もついてきます. Notion だとエクスポートすると、テキストと画像ファイルが別々にでてくるので煩わしさがあった😢）
なので、特に Datadog 上のデータを出力して自社のドキュメントライブラリーに統合させたいような場合には、このように様々な形式にエクスポートもできるので、 Tempolary 的な使い方として一次情報を残しておくという使い方も出来ると思います。
Terraform 対応
Datadog の terraform provier に2019年から Support for Notebook resources #261として issue が上がっていますが、今だ採用にはいたっていません...
issue の中で、機能実装を望む声は多く上がっていそうですが、使い方として難しいことが理由ではないかと推察しています。
datadog_dashboard と同じく、インタラクティブに操作することがメインとなる使い方なので、仮に実装されたとしても、resource の管理面や運用の仕方に工夫が必要そうですね
さいごに
Datadog Notebook のユースケースについて紹介する Advent Calendar をお送りしました。
他にもこんな使い方をしている！というのがあれば、ぜひぜひコメントください📝
コストはかからないので、ぜひ今後は Datadog Notebook を活用してみてください☺️
Discussion