メトリクスの送信: カスタム Agent チェック

関数は、カスタム Agent チェックを使用してメトリクスを送信する際に使います。メトリクスタイプに応じ、さなざまな関数が利用できます。使用した関数により、Datadog 内に保存されるメトリクスタイプと送信時のものが異なる場合があります。

関数

self.monotonic_count(name, value, tags=None, hostname=None, device_name=None)

self.count(name, value, tags=None, hostname=None, device_name=None)

self.gauge(name, value, tags=None, hostname=None, device_name=None)

self.rate(name, value, tags=None, hostname=None, device_name=None)

self.histogram(name, value, tags=None, hostname=None, device_name=None)

チュートリアル

以下の手順に従い、すべてのメトリクスタイプを定期的に送信するカスタム Agent チェックを作成します。

1. Agent のコンフィギュレーションディレクトリのルートにある conf.d/ フォルダーにディレクトリ metrics_example.d/ を作成します。

2. metrics_example.d/ フォルダーに次の内容で空のコンフィギュレーションファイルを作成し、metrics_example.yaml と名付けます。

   instances: [{}]
   

3. conf.d/ フォルダーの 1 つ上のレベルで、checks.d/ フォルダーに移動します。次の内容でカスタムチェックファイルを作成し、metrics_example.py と名付けます。

   import random
   
   from datadog_checks.base import AgentCheck
   
   __version__ = "1.0.0"
   
   class MyClass(AgentCheck):
       def check(self, instance):
           self.count(
               "example_metric.count",
               2,
               tags=["env:dev","metric_submission_type:count"],
           )
           self.count(
               "example_metric.decrement",
               -1,
               tags=["env:dev","metric_submission_type:count"],
           )
           self.count(
               "example_metric.increment",
               1,
               tags=["env:dev","metric_submission_type:count"],
           )
           self.rate(
               "example_metric.rate",
               1,
               tags=["env:dev","metric_submission_type:rate"],
           )
           self.gauge(
               "example_metric.gauge",
               random.randint(0, 10),
               tags=["env:dev","metric_submission_type:gauge"],
           )
           self.monotonic_count(
               "example_metric.monotonic_count",
               2,
               tags=["env:dev","metric_submission_type:monotonic_count"],
           )
   
           # Calling the functions below twice simulates
           # several metrics submissions during one Agent run.
           self.histogram(
               "example_metric.histogram",
               random.randint(0, 10),
               tags=["env:dev","metric_submission_type:histogram"],
           )
           self.histogram(
               "example_metric.histogram",
               random.randint(0, 10),
               tags=["env:dev","metric_submission_type:histogram"],
           )
   

4. Agent を再起動します。

5. Agent の status サブコマンドを使用して、カスタムチェックが正しく実行されていることを確認します。Checks セクションで metrics_example を探します。

   =========
   Collector
   =========
   
     Running Checks
     ==============
   
       (...)
   
       metrics_example (1.0.0)
       -----------------------
         Instance ID: metrics_example:d884b5186b651429 [OK]
         Total Runs: 2
         Metric Samples: Last Run: 8, Total: 16
         Events: Last Run: 0, Total: 0
         Service Checks: Last Run: 0, Total: 0
         Average Execution Time : 2ms
   
       (...)
   

6. メトリクスの概要ページでメトリクスが Datadog に報告を行っているかを確認します。

その他の参考資料

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

Agent カスタムチェックの書き方ドキュメント