サービススコアカード

概要

サービススコアカードは、サービスの健全性とパフォーマンスを向上させるための情報に基づいたアクションを実行するために、効果的な監視、優先順位付け、計画、コミュニケーションを支援します。各スコアカードには、本番環境準備、観測可能性ベストプラクティス、ドキュメントとオーナーシップのステータスが表示されます。サービスカタログで定義されたメタデータを持つすべてのサービスは、一連の成功/失敗の基準に対して自動的に評価されます。

スコアカードの表示に使用するルールを選択し、チームの Slack チャンネルに直接送信されるレポートを生成して、スコアカードの結果を定期的に報告することができます。

スコアカードのセットアップ

デフォルトのスコアカードごとに、すぐに使えるルールのどれを評価するかを選択するには

1. サービスカタログの Scorecards ページを開きます。
2. スコアの計算方法をカスタマイズするルールを有効または無効にします。
3. View your scores をクリックすると、定義されたサービス全体で選択したルールの進捗状況の追跡が開始されます。

カスタムルールの作成

スコアカード API を使用してスコアカードダッシュボードにカスタムルールを追加するには

1. ルールの名前、所属するスコアカード、ルールの説明、/scorecard/rules に渡す所有者を指定します。
2. 評価する {rule, service} タプルごとに pass、fail、skip の結果を /scorecard/outcomes/batch に送信します。
3. スコアカードダッシュボードで結果の概要を表示します。

初期セットアップ後も、API を通じてルールを有効または無効にすることもできます。

サービスの評価方法

デフォルトのスコアカードがセットアップされると、サービスカタログの Scorecards ページに、すぐに使えるルールのリストと、そのルールに成功したサービスの割合が表示されます。ルールをクリックすると、成功したサービス、失敗したサービス、およびそれらを所有するチームの詳細が表示されます。

本番環境準備 (Production readiness)

すべてのサービスの本番環境準備スコアは (特に明記されていない限り)、以下のルールに基づいています。

SLO の定義がある

サービスレベル目標 (SLO) は、アプリケーションパフォーマンスに関する明確な目標を定義するためのフレームワークを提供します。これは、一貫したカスタマーエクスペリエンスを提供し、機能開発とプラットフォームの安定性のバランスをとり、社内外のユーザーとのコミュニケーションを改善するのに役立ちます。

モニターの定義がある

モニターは、環境の問題にチームが迅速に対応できるようにすることで、ダウンタイムを削減します。推奨モニターを確認してください。

オンコールの指定

サービスの明確なオーナーシップを確立することで、全員のオンコール体験を向上させます。これにより、インシデント発生時にオンコールエンジニアに適切な連絡先が提供され、インシデントの解決にかかる時間が短縮されます。

最後のデプロイが過去 3 か月以内に行われた

APM または USM で監視されているサービスの場合。アジャイル開発を実践することで、ユーザーからのフィードバックに迅速に対応し、エンドユーザーにとって最も重要な機能の開発に軸足を移すことができます。

観測可能性ベストプラクティス (Observability best practices)

観測可能性ベストプラクティススコアは、以下のルールに基づいています。

デプロイメント追跡がアクティブ

APM または USM で監視されているサービスの場合。統合サービスタグ付けによるバージョンタグの実装でスムーズなロールアウトを実現します。機能の新バージョンをロールアウトすると、Datadog はエラーレートやリクエスト数などのバージョン間の違いをキャプチャしてアラートを送信します。これにより、エンドユーザエクスペリエンスを向上させるために、以前のバージョンにロールバックするタイミングを把握することができます。

ログの相関がアクティブ

APM サービスの場合。APM とログの相関は、エンドユーザーのトラブルシューティングの速度を向上させ、インシデントや障害発生時の時間を節約します。

オーナーシップとドキュメント (Ownership and documentation)

オーナーシップとドキュメントのスコアは、以下のルールに基づいています。

チームの定義

チームを定義することで、オンコールスタッフは、自分が詳しくないサービスが問題の根本的な原因である場合に、どのチームにエスカレーションすべきかを簡単に知ることができます。

連絡先の定義

連絡先を定義することで、オンコールスタッフが別のサービスのオーナーにエスカレーションする時間が短縮され、障害やインシデントからの迅速なサービス復旧に役立ちます。

コードリポジトリの定義

コードリポジトリを特定することで、エンジニアはサービスの担当チームに連絡することなく、問題の初期調査を行うことができます。これにより、コラボレーションが向上し、インテグレーションポイントに関するエンジニアの全体的な理解が深まります。

ドキュメントの定義

サービスカタログの Other Links セクションで、ランブック、ダッシュボード、その他の内部ドキュメントなどのリソースへの追加リンクを指定します。これは初期調査に役立ち、障害やインシデントの緊急修復ランブックにすばやくアクセスできるようになります。

スコアの計算方法

すぐに使える各スコアカード (Production Readiness、Observability Best Practices、Ownership & Documentation) は、デフォルトのルールセットで構成されています。これらは単純な成功/失敗条件を反映しています。サービスのスコア計算から特定のルールを除外するには、スコアカード API でその結果を skip に設定します。

個々のルールには、データの利用可否に基づく制限がある場合があります。例えば、デプロイメント関連のルールは、APM の統合サービスタグ付けを介したバージョンタグの利用可否に依存しています。

各ルールには、成功したサービスの割合のスコアが表示されます。各スコアカードには、すべてのルールを対象に成功したサービスの数を合計する総合スコアのパーセンテージがあります。これは、すべてのルールに成功したサービスの数ではありません。スキップされたルールや無効なルールは、この計算に含まれません。

サービスレベルの詳細とスコアを表示する

スコアカードのサマリーは、サービスカタログの Explore ページの Ownership タブの Scorecards 列からアクセスできます。特定のサービスまたはサービスのサブセットが各スコアカードでどのように機能しているか、および各スコアカード内のルールを確認することができます。

スコアカードから View Details をクリックするか、サービス詳細のサイドパネルを開いて Scorecards タブを表示します。ここには、すべてのスコアカード、ルール、各ルールに対するサービスの成功/失敗スコアが表示されます。

スコアカードレポートの生成

スコアカードレポートを生成することで、スケジュールされたスコアカード情報の概要をチームの Slack チャンネルに送信し、サービスやチームが期待される基準をどの程度満たしているかを全員が理解できるようにすることができます。レポートを作成すると、Datadog Workflow Automation を使用してワークフローが生成され、スケジュールされた時間に実行されます。

レポートを作成するには

1. Scorecards ページの Create Report をクリックします。
2. 組織全体のすべての定義済みサービスを含めるか、特定のチームのサービスを含めるかを選択します。
3. これらのレポートを受信する日時と頻度を設定します。
4. レポートを送信する Slack ワークスペースとチャンネルを設定します。選択したチャンネルは公開されており、Datadog Slack アプリがインストールされている必要があります。
5. Enable this Workflow をクリックします。

Datadog は、この情報を使用して、最もスコアの高いルール、最もスコアの低いサービス、チームに関するレポートを送信します。

スコアカードレポートの管理

ワークフローを編集または削除するには、Scorecards ページで Manage Reports をクリックし、ワークフローを選択します。Settings メニューを使用して、ワークフローを編集または削除します。

その他の参考資料

お役に立つドキュメント、リンクや記事:

サービスカタログDOCUMENTATION サービススコアカードでサービスの健全性とパフォーマンスを改善ブログ