インテグレーションダッシュボードの作成

概要

Datadog ダッシュボードは、主要なメトリクスを表示・追跡することで、インフラストラクチャーやインテグレーションを効率的に監視することができます。Datadog は、多くの機能やインテグレーションに対して、すぐに使えるダッシュボードのセットを提供しています。これらのダッシュボードには、ダッシュボードリストからアクセスすることができます。

Datadog インテグレーションを作成した場合、インテグレーションのユーザーがより迅速にインテグレーションの価値を見出すことができるよう、すぐに使えるダッシュボードを作成したいと思うかもしれません。このガイドでは、インテグレーションダッシュボードを作成するための手順と、作成プロセスで従うべきベストプラクティスを説明します。

Datadog インテグレーションを作成するには、新しいインテグレーションの設定を参照してください。

インテグレーションダッシュボードの作成

新しいダッシュボードを作成する

Datadog で、新しいダッシュボードを作成します。

ダッシュボードに要素を追加する際は、本ガイドのベストプラクティスに従ってください。

ダッシュボードのエクスポート

ダッシュボードを JSON にエクスポートするには、エクスポートボタン (右上) を使用して、Export dashboard JSON を選択します。 ファイル名はダッシュボードのタイトルに合わせ、例えば your_integration_name_overview.json のようにします。

このファイルを、統合の assets/dashboards フォルダに保存します。 アセットを manifest.json ファイルに追加します。インテグレーションのファイル構造とマニフェストファイルの詳細については、インテグレーションアセットリファレンスを参照してください。

プルリクエストを開く

ダッシュボードの JSON ファイルと更新されたマニフェストファイルを integrations-extras GitHub リポジトリの対応するインテグレーションフォルダに追加するプルリクエスト (PR) を開きます。Datadog はすべての integration-extras の PR をレビューします。承認されると、Datadog は PR をマージし、インテグレーションダッシュボードは本番環境にプッシュされます。

ダッシュボードを本番環境で検証する

まず、関連するインテグレーションタイルが Datadog に Installed (インストール) されていることを確認します。関連するすぐに使えるダッシュボードを見るには、インテグレーションをインストールする必要があります。

ダッシュボードリストでダッシュボードを探します。ダッシュボードリストページとプリセットダッシュボード内でロゴが正しく表示されることを確認します。

ダッシュボードのベストプラクティスに従う

インテグレーションダッシュボードには、以下の情報が含まれている必要があります。

ダッシュボードの例
  • バナー画像、簡潔なコピー、便利なリンク、優れたタイポグラフィで注目を集める About グループ
  • 最も重要な統計情報を先頭に、簡単な注釈をつけた Overview グループ
  • シンプルなグラフのタイトルとタイトルケースのグループ名
  • 高密度モードでの対称性
  • 簡潔で整ったメモ
  • 関連グループ間、グループ内のメモ、グループ内のグラフのカラーコーディネート

一般的なガイドライン

  • 新しいダッシュボードを作成する際に、デフォルトのダッシュボードタイプを選択します。

  • ダッシュボードのタイトルにインテグレーション名を入れます。ダッシュボードのタイトルの例としては、Scylla や Cilium Overview などがあります。注: ダッシュボードの URL はタイトルから生成されるため、ダッシュボードのタイトルに - (ハイフン) を使用しないようにしてください。

  • ダッシュボードのヘッダーにロゴを追加します。インテグレーションロゴは、アイコンが存在し、integration_id がアイコン名と一致すれば、自動的にヘッダーに表示されます。

  • 簡単な説明と役立つリンクを含む、インテグレーションのための About グループを含めます。About セクションには、データではなく、コンテンツを含める必要があります。About セクションを全幅にすることは避けてください。

  • About セクションを編集し、バナー表示オプションを選択します。次に、次のファイルの場所に従って、バナー画像にリンクすることができます: /static/images/integration_dashboard/your-image.png

  • 最も重要なメトリクスをいくつか含む Overview グループを作成し、ダッシュボードの最上部に配置します。Overview グループには、データを含めることができます。

  • 幅 1280px と幅 2560px でダッシュボードの見え方を確認します。これは、小型のノートパソコンと大型のモニターで、それぞれダッシュボードがどのように表示されるかを示しています。ダッシュボードの最も一般的な画面幅は、1920、1680、1440、2560、1280px です。お使いのモニターが高密度モードに対応する大きさでない場合は、ブラウザのズームコントロールを使用してズームアウトしてください。

ウィジェットとグループ化

  • インテグレーションによってサポートされるメトリクスを調査し、関連するカテゴリにグループ化することを検討します。インテグレーションのパフォーマンスと概要の鍵となる重要なメトリクスは、一番上にあるべきです。

  • メモウィジェットではなく、グループウィジェットを使用してセクションのタイトルとグループ化を行います。グループを横に並べて表示するには、部分幅のグループを使用します。ほとんどのダッシュボードでは、グループ内のすべてのウィジェットを表示する必要があります。

    グループウィジェットの例

  • 時系列ウィジェットは、小さいディスプレイで潰れて表示されないように、少なくとも 4 列の幅が必要です。

  • ストリームウィジェットの幅は、読みやすさを考慮して、少なくとも 6 列、またはダッシュボードの幅の半分にする必要があります。ダッシュボードの末尾に配置すると、スクロールの妨げになりません。ストリームウィジェットを単独でグループ化し、折りたたむことができるようにすると便利です。イベントストリームは、ダッシュボードが監視するサービスがイベントを報告している場合にのみ追加します。sources:service_name を使用してください。

  • ウィジェットのタイプやサイズを組み合わせて使ってみます。ダッシュボードができるだけわかりやすいと確信できるまで、視覚化とフォーマットのオプションを検討します。ダッシュボード全体が時系列で構成されていても問題ない場合もありますが、さまざまなタイプのウィジェットを使用することで読みやすさが向上する場合もあります。最も一般的に使用されるメトリクスウィジェットは、時系列、クエリ値、テーブルです。利用可能なウィジェットタイプの詳細については、サポートされるダッシュボードウィジェットのリストを参照してください。

  • 高密度モードでは、ダッシュボードの左半分と右半分を対称にするようにしてください。大型モニターを使用するユーザーは、デフォルトで高密度モードでダッシュボードを見るため、グループの関係が理にかなっていて、ダッシュボードが美しく見えることが重要です。そのためには、グループの高さを調整したり、グループを左半分と右半分の間で移動させることができます。

    左右対称のダッシュボードの例

  • テンプレート変数を使用すると、ダッシュボード内の 1 つまたは複数のウィジェットを動的にフィルタリングすることができます。テンプレート変数は、監視対象のサービスを使用するすべてのユーザーまたはアカウントからアクセスできるユニバーサルなものである必要があります。すべての関連するグラフが、関連するテンプレート変数のフィルタをリッスンしていることを確認します。

    注: テンプレート変数として *=scope を追加すると、ユーザーが自分のタグすべてにアクセスできるようになるので便利です。

コピー

  • グラフのタイトルは、最も重要な情報から始まる簡潔なものを使用してください。一般的なフレーズは避けましょう。

    簡潔なタイトル (良い)冗長なタイトル (悪い)
    ノードあたりのイベント数ノードあたりの Kubernetes イベントの数
    保留タスク: [$ノード名][$ノード名]の保留中のタスクの総数
    読み/書き操作読み出し/書き込み操作の回数
    サーバー接続 - 率サーバーへの接続の率
    負荷Memcached の負荷

  • 特に、ウィジェットが同名のカスタムユニットを持つクエリ値である場合、グループ内のすべてのウィジェットでグループタイトルやインテグレーション名を繰り返すことは避けてください。

  • 時系列ウィジェットの場合は、常にエイリアス式を指定します。

  • グループのタイトルはタイトルケースを、ウィジェットのタイトルはセンテンスケースを使用します (英語の場合)。

  • 凡例を表示する場合は、エイリアスをわかりやすく表示するようにしましょう。

  • グラフのタイトルは、クエリされたメトリクスを要約する必要があります。単位はメタデータから自動的に表示されるため、グラフタイトルに単位を表示しないでください。ただし、クエリの計算が異なるタイプの単位を表している場合は例外です。

ビジュアルスタイル

  • メモを用途に合わせてフォーマットすることができます。キャプション」、「注釈」、「ヘッダー」のプリセットや、独自のスタイルの組み合わせを試してみてください。長いメモや、箇条書きやコードブロックのような複雑な書式を含むメモには、最小のフォントサイズを使用しないようにしましょう。

  • 色は重要な関係を強調し、読みやすさを向上させるために使用し、スタイルのために使用するのではありません。複数のグループが関連している場合は、すべてのグループに同じグループヘッダーカラーを適用します。あるグループの見出し色を緑にした場合、そのグループのメモも緑にしてみましょう。2 つのグループが関連しているが、どちらかがより重要である場合、重要なグループには「鮮やかな」色を、重要でないグループには「明るい」色を使ってみてください。グループのヘッダーを白にすることを恐れず、色の使いすぎに注意しましょう。例えば、ダッシュボード上のすべてのグループをビビッドブルーにするのはやめましょう。また、ヘッダーをグレーにするのも避けましょう。

    ダッシュボードにおける色関連データの例

  • 凡例は意味があるときに使います。凡例があれば、各系列にカーソルを合わせたり、ウィジェットを最大化したりしなくても、グラフを簡単に読むことができます。凡例が読みやすいように、必ず時系列のエイリアスを使用してください。凡例の自動モードは、スペースに余裕がないときは凡例を隠し、余裕があるときは凡例を表示する優れたオプションです。

    ダッシュボードにおける凡例の例

  • 2 つのグラフを並べて比較させたい場合は、X 軸が揃っていることを確認する必要があります。片方のグラフに凡例が表示され、もう片方には表示されていない場合、X 軸の位置は揃いません。両方のグラフに凡例が表示されているか、または表示されていないことを確認してください。

  • 時系列の場合、表示タイプはメトリクスのタイプに基づきます。

    メトリクスのタイプ表示タイプ
    ボリューム (例: 接続数)area
    カウント (例: エラー数)bars
    複数のグループまたはデフォルトlines