StatsD がメトリクスのみを受け付けるのに対して、DogStatsD は、Datadog の主要な 3 種類のデータタイプ、すなわちメトリクス、イベント、サービスチェックをすべて受け付けます。ここでは、メトリクスタイプごとの一般的な使用例を示し、DogStatsD だけが持つサンプリングレートおよびメトリクスのタグ付けオプションを紹介します。

COUNTGAUGESETは、StatsD ユーザーにお馴染みのメトリクスタイプです。StatsD の TIMER は DogStatsD の HISTOGRAM のサブセットです。また、DogStatsD を使い、HISTOGRAMDISTRIBUTION メトリクスタイプを送信できます。

: 使用する送信方法によっては、Datadog 内に保存される実際のメトリクスタイプが、送信されたメトリクスタイプと異なる場合があります。DogStatsD で RATE メトリクスタイプを送信する場合、メトリクスはアプリ内で GAUGE として表示され、異なる Agent 間で適切な比較ができるようにします。

関数

DogStatsD をインストールすると、Datadog へメトリクスを送信する際、メトリクスタイプに応じて以下の関数を使用できます。関数には、次の共有パラメーターがあります。

パラメータータイプ必須説明
<METRIC_NAME>文字列はい送信するメトリクスの名前。
<METRIC_VALUE>Doubleはいメトリクスに関連付けられている値
<SAMPLE_RATE>Doubleいいえメトリクスに適用するサンプリングレート。0(全てがサンプリングされ何も送信されない)〜1 (サンプル無し)の値を利用。詳細は、サンプリングレートセクションをご覧ください。
<タグ>文字列のリストいいえメトリクスに適用するタグのリスト。詳細は、メトリクスのタグ付けセクションをご覧ください。

COUNT

increment(<METRIC_NAME>, <SAMPLE_RATE>, <TAGS>)
COUNT メトリクスをインクリメントするために使用されます。Datadog に RATE タイプとして保存されます。時系列に保存される値は、StatsD フラッシュ期間全体のメトリクス値の時間正規化された差分です。
decrement(<METRIC_NAME>, <SAMPLE_RATE>, <TAGS>)
COUNT メトリクスをデクリメントするために使用されます。Datadog に RATE タイプとして保存されます。時系列に保存される値は、StatsD フラッシュ期間全体のメトリクス値の時間正規化された差分です。
count(<METRIC_NAME>, <METRIC_VALUE>, <SAMPLE_RATE>, <TAGS>)
任意の Value から COUNT メトリクスをインクリメントするために使用されます。Datadog に RATE タイプとして保存されます。時系列に保存される値は、StatsD フラッシュ期間全体のメトリクス値の時間正規化された差分です。
注: count は Python ではサポートされていません。

: COUNT タイプのメトリクスは、フラッシュ間隔で正規化され 1 秒あたりの単位数を報告するため、Datadog 内で少数を表示できます。

コード例

RATE メトリクスとして保存された COUNT メトリクスを Datadog に送信します。 COUNT タイプについては、メトリクスのタイプ に関するドキュメントを参照してください。

次のコードを実行して、DogStatsD の COUNT メトリクスを Datadog に送信します。必要がなくなったら、クライアントを「フラッシュ」/「閉じる」ことを忘れないでください。

const tracer = require('dd-trace');
tracer.init();

tracer.dogstatsd.increment('example_metric.increment', 1, { environment: 'dev' });
tracer.dogstatsd.decrement('example_metric.decrement', 1, { environment: 'dev' });

上のコードを実行すると、メトリクスデータを Datadog でグラフ化できます。

インクリメントデクリメント

値は COUNT として送信されるため、Datadog に RATE として保存されます。Datadog で未加工のカウントを取得するには、累積合計積分 などの関数を系列に適用します。

Cumsum でインクリメントデクリメント

GAUGE

gauge(<METRIC_NAME>, <METRIC_VALUE>, <SAMPLE_RATE>, <TAGS>)
Datadog に GAUGE タイプとして保存されます。時系列に保存される値は、StatsD フラッシュ期間の間にメトリクスに送信された最後のゲージ値です。

コード例

GAUGE メトリクスとして保存された GAUGE メトリクスを Datadog に送信します。 GAUGE タイプについては、メトリクスのタイプ に関するドキュメントを参照してください。

次のコードを実行して、DogStatsD の GAUGE メトリクスを Datadog に送信します。必要がなくなったら、クライアントを「フラッシュ」/「閉じる」ことを忘れないでください。

注: メトリクス送信の呼び出しは非同期です。メトリクスを確実に送信したい場合は、プログラムが終了する前に flush を呼び出してください。

const tracer = require('dd-trace');
tracer.init();

let i = 0;
while(true) {
  i++;
  tracer.dogstatsd.gauge('example_metric.gauge', i, { environment: 'dev' });
}

上のコードを実行すると、メトリクスデータを Datadog でグラフ化できます。

ゲージ

SET

set(<METRIC_NAME>, <METRIC_VALUE>, <SAMPLE_RATE>, <TAGS>)
Datadog に GAUGE タイプとして保存されます。時系列に保存される値は、フラッシュ期間の間に StatsD に送信されたメトリクスの一意の値のカウントです。

コード例

GAUGE メトリクスとして保存された SET メトリクスを Datadog に送信します。

次のコードを実行して、DogStatsD の SET メトリクスを Datadog に送信します。必要がなくなったら、クライアントを「フラッシュ」/「閉じる」ことを忘れないでください。

from datadog import initialize, statsd
import time
import random

options = {
    'statsd_host':'127.0.0.1',
    'statsd_port':8125
}

initialize(**options)
i = 0
while(1):
  i += 1
  statsd.set('example_metric.set', i, tags=["environment:dev"])
  time.sleep(random.randint(0, 10))

上のコードを実行すると、メトリクスデータを Datadog でグラフ化できます。

設定

HISTOGRAM

histogram(<METRIC_NAME>, <METRIC_VALUE>, <SAMPLE_RATE>, <TAGS>)
複数のメトリクスが送信されるので、保存されるメトリクスタイプ (GAUGE, RATE) はメトリクスに依存します。詳細については、ヒストグラムメトリクスタイプに関するドキュメントを参照してください。

構成

  • Datadog に送信する集計を、datadog.yaml 構成ファイルhistogram_aggregates パラメーターで構成します。デフォルトでは、maxmedianavgcount の各集計だけが送信されます。
  • Datadog に送信するパーセンタイル集計を、datadog.yaml 構成ファイルhistogram_percentiles パラメーターで構成します。デフォルトでは、95pc のパーセンタイルだけが送信されます。

コード例

HISTOGRAM メトリクスタイプは DogStatsD だけのものです。GAUGE および RATE メトリクスとして保存された HISTOGRAM メトリクスを Datadog に送信します。HISTOGRAM タイプについては、メトリクスのタイプに関するドキュメントを参照してください。

次のコードを実行して、DogStatsD の HISTOGRAM メトリクスを Datadog に送信します。必要がなくなったら、クライアントを「フラッシュ」/「閉じる」ことを忘れないでください。

from datadog import initialize, statsd
import time
import random

options = {
    'statsd_host':'127.0.0.1',
    'statsd_port':8125
}

initialize(**options)

while(1):
  statsd.histogram('example_metric.histogram', random.randint(0, 20), tags=["environment:dev"])
  time.sleep(2)

上のインスツルメンテーションは、以下のメトリクスを生成します。

メトリクス説明
example_metric.histogram.countこのメトリクスがサンプリングされた回数
example_metric.histogram.avgサンプリングされた値の平均
example_metric.histogram.medianサンプリングされた値の中央値
example_metric.histogram.maxサンプリングされた値の最大値
example_metric.histogram.95percentileサンプリングされた値の 95 パーセンタイル

上のコードを実行すると、メトリクスデータを Datadog でグラフ化できます。

ヒストグラム

タイマー

DogStatsD の TIMER メトリクスタイプは HISTOGRAM メトリクスタイプとして実装されています(標準 StatsD に含まれるタイマーと混同しないでください)。また、コードセクションの実行にかかる時間など、タイミングデータのみを測定します。

timed(<METRIC_NAME>, <METRIC_VALUE>, <SAMPLE_RATE>, <TAGS>)
複数のメトリクスが送信されるので、保存されるメトリクスタイプ (GAUGE, RATE) はメトリクスに依存します。詳細については、ヒストグラムメトリクスタイプに関するドキュメントを参照してください。
構成

TIMER には、HISTOGRAM コンフィギュレーションルールが適用されます。

コード例

GAUGE および RATE メトリクスとして保存された TIMER メトリクスを Datadog に送信します。HISTOGRAM タイプについては、メトリクスのタイプ に関するドキュメントを参照してください。必要がなくなったら、クライアントを「フラッシュ」/「閉じる」ことを忘れないでください。

Python では、タイマーはデコレーターで作成されます。

from datadog import initialize, statsd
import time
import random

options = {
    'statsd_host':'127.0.0.1',
    'statsd_port':8125
}

initialize(**options)

@statsd.timed('example_metric.timer', tags=["environment:dev,function:my_function"])
def my_function():
  time.sleep(random.randint(0, 10))

while(1):
  my_function()

または、コンテキストマネージャーを使用します。

from datadog import statsd
import time
import random

def my_function():

  # First some stuff you don't want to time
  sleep(1)

  # Now start the timer
  with statsd.timed('example_metric.timer', tags=["environment:dev"]):
    # do something to be measured
    sleep(random.randint(0, 10))

while(1):
  my_function()

DogStatsD はタイマーメトリクスデータを受け取ると、レンダリング時間の統計的分布を計算し、次のメトリクスを Datadog に送信します。

メトリクス説明
example_metric.timer.countこのメトリクスがサンプリングされた回数
example_metric.timer.avgサンプリングされた値の平均時間
example_metric.timer.medianサンプリングされた値の中央値
example_metric.timer.maxサンプリングされた値の最大値
example_metric.timer.95percentileサンプリングされた値の 95 パーセンタイル

DogStatsD は TIMERHISTOGRAM メトリクスとして扱います。使用するメトリクスのタイプが TIMER であろうと HISTOGRAM であろうと、Datadog に送信されるのは同じデータです。上のコードを実行すると、メトリクスデータを Datadog でグラフ化できます。

タイマー

DISTRIBUTION

distribution(<METRIC_NAME>, <METRIC_VALUE>, <TAGS>)
Datadog に DISTRIBUTION タイプとして保存されます。詳細は、ディストリビューションドキュメントを参照してください。

コード例

DISTRIBUTION メトリクスタイプは DogStatsD だけのものです。DISTRIBUTION メトリクスとして保存された DISTRIBUTION メトリクスを Datadog に送信します。 DISTRIBUTION タイプについては、メトリクスのタイプ に関するドキュメントを参照してください。

次のコードを実行して、DogStatsD の DISTRIBUTION メトリクスを Datadog に送信します。必要がなくなったら、クライアントを「フラッシュ」/「閉じる」ことを忘れないでください。

const tracer = require('dd-trace');
tracer.init();

while(true) {
  tracer.dogstatsd.distribution('example_metric.distribution', Math.random() * 20, { environment: 'dev' });
  await new Promise(r => setTimeout(r, 2000));
}

上のインスツルメンテーションは、合計カウント平均最小最大50 パーセンタイル (中央値)、75 パーセンタイル90 パーセンタイル95 パーセンタイル99 パーセンタイルの各データを計算します。ディストリビューションは、アップロードされたファイルのサイズ、教室でのテストの得点など、「あらゆる」種類の値の分布の測定に使用できます。

メトリクスの送信オプション

サンプリングレート

高パフォーマンスを必要とするコードパスにとっては、UDP パケットを送信する際のオーバーヘッドが大きすぎる可能性があるため、DogStatsD クライアントはサンプリングをサポートし、一定割合の時間にのみメトリクスを送信することができます。サンプリングするメトリクスが多く、DogStatsD クライアントが DogStatsD サーバーと同じホスト上にない場合に有用ですが、トラフィックが減る代わりに精度と粒度を失います。

サンプリングレート 1 は 100% の時間メトリクスを送信し、サンプリングレート 0 は 0% の時間メトリクスを送信します。

DogStatsD は Datadog にメトリクスを送信する前に、<SAMPLE_RATE> を使用し、メトリクスタイプに応じてメトリクス値を補正します(サンプリングなしで値を推定するため)。

メトリクスタイプサンプリングレート補正
COUNT受け取った値は (1/<SAMPLE_RATE>) で乗算されます。受信したデータポイントに対し、1/<SAMPLE_RATE> は同じ値で実際にサンプリングされたと考えることは理にかなっています。
GAUGE補正なし。受信した値はそのまま残ります。
SET補正なし。受信した値はそのまま残ります。
HISTOGRAMhistogram.count 統計は COUNT メトリクスであり、上記の補正を受け取ります。他の統計は GAUGE メトリクスなので、「補正」は行われません。
DISTRIBUTION受け取った値は (1/<SAMPLE_RATE>) 倍として計上されます。受信したデータポイント 1 つに対し、1/<SAMPLE_RATE> 個が同じ値で実際にサンプリングされたと考えるのは理にかなっています。

コード例

以下のコードは、半分の時間だけポイントを送信します。

statsd.increment('loop.count', sample_rate=0.5)

メトリクスのタグ付け

tags パラメーターを使用して、DogStatsD へ送るメトリクスにタグを追加します。

コード例

以下のコードは、environment:dev および account:local タグのみを example_metric.increment メトリクスに追加します。

tracer.dogstatsd.increment('example_metric.increment', 1, { environment: 'dev', account: 'local' });

ホストタグ

ホストタグは、メトリクスを集計する際に Datadog Agent によって自動的に割り当てられます。Agent ホスト名と一致しないホストタグ付きで送信されたメトリクスは、本来のホストを参照できなくなります。送信されたホストタグは、Agent によって収集されたホスト名や Agent で構成されたホスト名を上書きします。

参考資料

PREVIEWING: dgreen15/adding-custom-entities
Your Privacy Choices