ダッシュボード

どのようなものか

ダッシュボードは、クエリーを図にしたパネルを並べ、誰かに聞かなくて
も、対象の状態を読み取れるようにしたページです。同じ考え方には、別の
呼び名もあります。Prometheusの文書はコンソールと呼び、チームによって
は「ボード」や「壁の画面」と呼びます。Grafanaは、行やタブに並べた一
つ以上のパネルが「関連する情報をひと目で把握できる表示を提供する」と
説明しています。各パネルは、データソースへのクエリーから作った可視化
を収める枠です。データソースには、時系列データの保存先、SQLデータ
ベース、API、単なるCSVファイルも使えます。

パネルの形は、いくつかの種類に分けられます。時系列の線グラフは、過去
一日のメモリー使用量や、過去一週間の一分当たりリクエスト数など、傾向
を示します。一つの大きな数値は、「今どれだけか」に答えます。ゲージ
は、利用できるディスク全体に対する使用量のように、既知の範囲に対して
値を示します。テーブルは、注意を要するものを一件一行で並べます。状態
ランプは、稼働か停止かを示します。よいダッシュボードの多くは、問いに
合わせて二つか三つの形を選び、それぞれのパネルは、ごく少数に抑えま
す。

ウェブページ上では、パネルも普通のインターフェース部品です。W3Cの
ARIA Authoring Practices
Guideは、キーボードやスクリーンリーダーを使う人に対し、各部品がどう
動くべきかを説明しています。タブは表示を切り替え、一度に一つの内容パ
ネルを見せます。テーブルは、行とセルが並ぶ静的な表です。グリッドは、
それを矢印キーで移動できる、操作可能な形にしたものです。メーターは、
定めた範囲内の値を表すパターンです。アラートは、読者の作業を中断せず
に注意を引く、短く重要なメッセージです。メーターのパターンに従うゲー
ジは、範囲と現在値をテキストとしても伝えます。

```html
<div
    role="meter"
    aria-label="ディスク使用量"
    aria-valuemin="0"
    aria-valuemax="100"
    aria-valuenow="72"
    aria-valuetext="72%（空き31 GB）"
></div>
```

ダッシュボードは、見てもらうのを待ちます。そこが、近いものとの違いで
す。アラートは、何かが境界を超えると、人のところへ届きます。レポート
は、要求された時点で作られ、その後は固定されるスナップショットです。
ダッシュボードは現在の状態を示し、その価値は、誰かが向ける注意の分だ
けしかありません。

なぜ重要なのか

ダッシュボードは、状態についての共通の見方をチームへ与えます。なけれ
ば、同じ問いにも、端末を開いている人が独自の方法で答えます。障害対応
中の二人が、異なる数値を見ていたと気付くまで、何分も使う場合がありま
す。あれば、同じ図から話を始められ、自分でクエリーを書かない人も、シ
ステムの様子を確認できます。

「何かがおかしい」から「この部分がおかしい」までの道のりも縮めます。
Prometheusのコンソールの指針は、サービスごとにダッシュボードを作り、
それぞれに、そのサービスが通信する先の待ち時間とエラーを示すよう勧め
ています。依存関係の木の上から始め、悪い数値をたどって、原因となる
サービスまで進めるようにするためです。システムの構造に沿って並べれ
ば、その道のりが、数回のクリックになります。

コストもあります。パネルは、開いているすべての画面で、更新のたびにク
エリーを実行します。また、各パネルの内容は、背後のサービスの名前が変
わり、分割され、廃止されても、誰かが正しさを保つ必要がある主張です。
四十のパネルを持つダッシュボードには、その主張が四十あり、大半は読ま
れません。

実際の活用例

創業者は以前の業務で、ある組織で初となるオブザーバビリティーダッシュ
ボードを構築しました。このダッシュボードは、Dockerコンテナーも含め、
遠隔のLinuxサーバーから、SSH経由でCPU、RAM、ディスク、温度の測定値を
集めるところから始まりました。二つ目の版はGrafanaとPrometheusへ移
し、DevOpsチームとエンジニアリングチームで、表示するパネルを選びまし
た。CPU使用率、メモリー使用量、サービスの稼働時間、APIの待ち時間で
す。オフィスの大きなテレビに表示し、通りかかった誰でも本番環境の状態
を見られました。しきい値を超えたときのアラートも併用し、チームは、障
害の検知と解決を40%速く行えるようになりました。

後のGrafanaとPrometheusによる監視ダッシュボードは、最も重要な部分を
説明しています。忙しそうに見えるだけで何も伝えない見栄えの数値ではな
く、意味のあるメトリクスです。そのメトリクスにアラートのしきい値を設
定し、まだ対応する時間があるうちに、チームの目に入る場所へ示しまし
た。チームは、火消しから、小さいうちに問題を見つける運用へ移りまし
た。

メモリーが464
MBのホストでは、同じ種類の問いにも、別の答えになります。七つの読み取
り専用ロールが、稼働中のホストをMarkdownレポートにします。必要なとき
に実行し、アクセス、トラフィック、メトリクス、セキュリティーなどを扱
います。メトリクス基盤は収まらず、仮に収まっても、そのコストに見合わ
ないためです。守る規則は、どのダッシュボードにも通じます。その実行で
測った数値だけを出すことです。もっともらしい数値で空白を埋めるレポー
トは、空白を残すものより悪いためです。

問題が起きるところ

ダッシュボードは、正常に見えても、人を誤らせることがあります。その多
くは、何を載せたかから生じます。

得られる数値を、すべて画面へ載せます。
システムが測れるものを、すべて見せたくなります。Prometheusの指針は、
それでは、専門家にも読みにくいほど密なコンソールになると警告していま
す。一つのコンソールで最大五つのグラフ、一つのグラフで最大五本の線を
勧めています。起こりそうな故障から考え、それらを見分ける情報を示しま
す。

見栄えだけの数値が、場所を取ります。
公開以来の累計リクエスト数は、増える一方です。登録者数も、今日の状態
をほとんど伝えません。忙しそうには見えても、判断は変わりません。変化
すれば誰かが行動する数値に、パネルを割り当てます。

一つのダッシュボードで、全員に応えようとします。
夜間の障害対応を担当する技術者が知りたいのは、何が壊れたかです。機能
を作っている開発者が知りたい、特定のエッジケースに何人が遭遇したかと
は異なります。Prometheusの指針も、一組のコンソールが両方に役立つこと
はまれで、二組の方がよいと明言しています。

色だけで、すべてを伝えます。
赤と緑の点を並べるだけでは、両者を区別できない人には情報が伝わらず、
単色の画面でも意味を読み取れません。WCAG
2.2の達成基準1.4.1、レベルAは、情報を伝える視覚的な手段を色だけにし
てはならないとします。語、形、位置を加えます。レベルAAの1.4.11では、
グラフを理解するために必要な部分は、隣り合う色に対して3:1以上のコン
トラスト比が必要です。白い背景に細いパステル色の系列では、満たさない
ことがよくあります。

存在しない上限を、ゲージが示します。
APGのメーターパターンは、定めた範囲内の値のためのものです。意味のあ
る最大値がない値や、進捗には使わないよう、注記もあります。一秒当たり
のリクエスト数には自然な上限がないため、ダイヤル表示は上限を作り出
し、普通に忙しい時間帯を、緊急事態のように見せます。代わりに、時系列
の線グラフを使います。

見る人が帰宅しても、画面は待ち続けます。
午前三時のオフィスのテレビでは、誰もダッシュボードを見ていません。人
が対応すべき問題は、アラートへ回します。Prometheusのアラート指針は、
利用者が感じる症状で通知し、原因となるコンポーネントを探せるコンソー
ルへ、各アラートからリンクするよう勧めています。アラートが人を呼び、
ダッシュボードは、その人が到着する先です。

参考資料

  * Grafana：ダッシュボード — 広く使われるツールでの、パネル、行、
データソース、クエリー、変換の定義です。

  * WAI-ARIA Authoring Practices Guide：パターン —
キーボードやスクリーンリーダーを使う人に対し、タブ、テーブル、グリッ
ド、メーター、アラートがどう動くべきかを説明します。

  * Prometheus：コンソールとダッシュボード — グラフ五つ、線五本の指
針と、一組ごとに利用者層を絞る理由を説明します。

  * Prometheus：アラート — 症状に基づく通知と、それを説明するコン
ソールへのリンクを扱います。

  * WCAG 2.2の解説：色の使用 — 色だけで状態を伝えられない理由を、例
で説明します。

  * WCAG 2.2の解説：非テキストのコントラスト —
グラフの線やインターフェース部品に必要な、3:1のコントラストを説明し
ます。

hこのページのウェブ版	URL:https://engineer.company/ja/glossary/dashboard/	engineer.company	70
