インテグレーション モニター テンプレートを作成する

概要

本ガイドでは、モニター テンプレートの作成手順と、作成時に従うべきベスト プラクティスを説明します。

Datadog モニターは、キーとなるメトリクスを追跡するので、インフラストラクチャーやインテグレーションを効率的に監視することができます。Datadog は、多くの機能やインテグレーションに対して、すぐに使えるモニターを提供しています。これらのモニターは、Monitors Template リストで表示できます。

Datadog インテグレーションからユーザーが価値を見いだせるよう、すぐに使えるモニターを作成します。Datadog インテグレーションを作成するには、新しいインテグレーションの作成 を参照してください。

モニターの作成

Datadog サンドボックスでモニターを作成します。

Datadog の Monitors Template リスト

このガイドに記載されているベストプラクティスに従ってモニターを構成します。

モニターをアップロードする

Integration Developer Platform 内の該当インテグレーションで Content タブに移動します。そこから import monitor を選択し、利用可能なモニターのリストから選びます。インテグレーションに含めるモニターは最大 10 個まで選択できます。

Integration Developer Platform の Content タブ

モニターを本番環境で検証する

すぐに使えるモニターを確認するには:

  1. Monitor Template リストで検出ルールを見つけてクリックし、展開します。
  2. ロゴが正しく表示されることを確認します。
  3. モニターが有効になっていることを確認します。

Monitors Template リストでモニターを検索します。Monitors Template リストページでロゴが正しく表示されることを確認します。

構成のベストプラクティス

モニター定義に加えて、モニター テンプレートには タイトル、 説明、および Tags フィールドが必須です。タグは “integration:<app_id>” に設定し、利用可能なその他のモニター タグは こちら を参照してください。詳細は モニターの設定 のドキュメントを参照してください。

タイトル

タイトルは、アラートが対象とする基盤となる障害モードをユーザーが素早く理解できるようにします。

  • 能動態を用い、目的語から始めて動詞を続けます。
  • テンプレート変数は使用しないでください。
要修正より良い最良
未 ACK メッセージの高水準が {{host.name}} で報告未 ACK メッセージの高水準が報告未 ACK メッセージが通常より多い

Description

説明は、障害モードに関する追加のコンテキストと、このモードがシステムに与えうる影響についても提供します。これにより、ユーザーはこのテンプレートからモニターを作成することが自分に関連するかどうかを一目で判断できるようにします。

  • これはタイトルのコピーではありません。
  • タイトルで述べられた問題を定義します。
  • なぜアラートするに値する問題なのかを説明します。
  • 問題の影響を説明します。
要修正より良い最良
未確認メッセージが多い場合は、チームに通知してください。未 ACK メッセージとは、コンシューマに配信されたものの、処理またはハンドリング済みとしての確認応答 (ACK) が行われていないメッセージを指します。このモニターは、未 ACK メッセージの比率を追跡します。未 ACK メッセージとは、コンシューマに配信されたものの、処理またはハンドリング済みとしての確認応答 (ACK) が行われていないメッセージを指します。このモニターは、メッセージ処理の遅延につながりうる潜在的なボトルネックを回避するため、未 ACK メッセージの比率を追跡します。

参考資料

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

モニターの構成ドキュメント more more