適切なダッシュボードを維持するためのベストプラクティス
ダッシュボードの一覧ページが乱雑になると、適切なコンテンツを見つけるのが難しくなり、検索クエリが未使用または無関係の結果で汚染される可能性があります。一括削除とRecently Deleted (最近削除した) ダッシュボードを組み合わせることで、不要なダッシュボードを大規模に削除し、誤って削除したものを復元することができます。このガイドには以下が含まれます。
- 定期的に削除する未使用のダッシュボードを特定するための一般的なルール
- 管理しやすい一覧ページを維持するためのベストプラクティス
使われていないダッシュボードを探す
使われていないダッシュボードをひとつひとつ探すのは大変ですが、このガイドラインを参考にすれば、使われていないコンテンツの大部分を特定でき、ダッシュボードの乱雑さを大幅に軽減することができます。ダッシュボードの削除を始める前に、一覧ページに関するいくつかの注意事項を説明します。
- プリセットリストの All Custom から開始します。削除できるのはカスタムダッシュボードのみです
- チェックボックス列をクリックすると、現在のページ上のすべてのダッシュボードが選択されます
- 共有ダッシュボードを削除しないようにします。公開または認証された共有リンクがあるダッシュボードには、名前の横に SHARED が表示されます。これらのダッシュボードの削除は、公開ビューに影響を与える可能性があるため、避けた方が安全な場合があります。
誤って削除したものを復元するには、Recently Deleted の一覧に移動します。この一覧には、過去 30 日間に削除されたダッシュボードが表示され、自動的に最も最近削除されたダッシュボードが最初に表示されます。また、API を使用してダッシュボードを一括復元することもできます。
削除ガイドライン
1. 人気順の逆ソート
Popularity の列をクリックすると、人気順の逆順に並べ替えられます。このリストでは、最も最近更新されたダッシュボードが自動的に一番上に置かれます。これらのダッシュボードの人気が低く、過去 3 か月に変更されていない場合は、削除しても安全な場合があります。
注: 非公式な公開リポジトリである Datadog Miscellany には、過去 3 ヶ月間変更されていないダッシュボードやモニターを削除するスクリプトがあります。
2. デフォルトのタイトルを検索する
次のような用語を検索します。
- “’s timeboard”
- “’s screenboard”
- “’s dashboard”
これらの文字列を含む多くのダッシュボードには、デフォルトのタイトルがあります (たとえば、“Stephanie’s Dashboard Thu, Jun 3, 1:41:44 pm”)。デフォルトのタイトルは、テスト用ダッシュボードをすばやく作成し、名前を変更しなかったことを示す場合があります。これらのダッシュボードは、特に古いものや人気のないものは削除しても問題ない場合があります。たとえば、以下の画像は、All Custom にフィルタリングした検索で、"’s screenboard" を検索し、人気順で逆ソートしたものです。
注: 非公式な公開リポジトリである Datadog Miscellany には、タイトルに基づきダッシュボードを削除するスクリプトがあります。
3. “test” などのキーワードで検索
ダッシュボードが一時的にしか使用されていないことを示す、test や cloned といった用語を検索してください。これらの単語は、活発に使用されているダッシュボードのラベルとして使用されることがあるので、注意して削除するか、タイトルと一緒にダッシュボードの年齢と人気を確認します。
ダッシュボードの衛生管理に関するベストプラクティス
定期的な清掃は、ダッシュボードの乱雑さを軽減します。ダッシュボードを維持するための良い習慣は、さらに効果的です。これらのプラクティスは、ダッシュボードを長期的に管理できるようにするために役立ちます。
- カスタムリストを使って、必要なものを探しましょう。サービス名などのキーワードで検索し、複数のダッシュボードを選択してリストに追加します。
- 単発の調査はノートブックやクイックグラフに保存します。個々のメトリクスやグラフを調査する場合、削除が必要な新しいダッシュボードを作成するよりも、デフォルトで保存されないノートブックやクイックグラフを試してみてください。
- ダッシュボードの詳細を使用して、ダッシュボードが何のためにあり、どのように使用するかを説明します。これにより、チームメイトがダッシュボードの目的を理解しやすくなり、より多くの人にダッシュボードが役立つようになります。
また、ダッシュボードの一括削除や一括復元を行うエンドポイントを含む Dashboards API を使用して、プログラムによるダッシュボードの管理も可能です。
付録
注: Datadog Miscellany は非公式な公開リポジトリであり、Datadog によって積極的にメンテナンスされているわけではありません。
