OpenMetrics

Supported OS Linux Windows

Integrationv2.3.0

概要

任意の OpenMetrics エンドポイントからカスタムメトリクスを抽出します。

All the metrics retrieved by this integration are considered custom metrics.

セットアップ

ホストで実行されている Agent 用にこのチェックをインストールおよび構成する場合は、以下の手順に従ってください。コンテナ環境の場合は、オートディスカバリーのインテグレーションテンプレートのガイドを参照してこの手順を行ってください。

インストール

OpenMetrics チェックは、Datadog Agent のバージョン 6.6.0 以降にパッケージ化されています。

コンフィギュレーション

Agent の構成ディレクトリのルートにある openmetrics.d/conf.yaml ファイルを編集します。使用可能なすべての構成オプションの詳細については、サンプル openmetrics.d/conf.yaml を参照してください。

それぞれのインスタンスには、以下のパラメーターが必要です。

パラメーター説明
openmetrics_endpointOpenMetrics がアプリケーションメトリクスを公開する URL(一意でなければなりません)。
namespaceすべてのメトリクスの先頭に追加するネームスペース。
metricsカスタムメトリクスとして取得するメトリクスのリスト。各メトリクスを metric_name または metric_name: renamed としてリストに追加して、名前を変更します。メトリクスは正規表現として解釈されます。一致するすべてのメトリクスを取得するには、ワイルドカードとして .*metric.*)を使用します。: 正規表現は、多くのカスタムメトリクスを送信する可能性があります。

: これは Datadog Agent バージョン 7.32.0 時点の新しいデフォルトの OpenMetrics チェックの例です。以前にこのインテグレーションを実装したことがある場合は、レガシーの例を参照してください。

: Datadog Agent v7.32.0 から、OpenMetrics 仕様標準に準拠し、_total で終わるカウンター名は、サフィックス _total を除いて指定する必要があります。例えば、promhttp_metric_handler_requests_total を収集するには、メトリクス名 promhttp_metric_handler_requests を指定します。これにより、メトリクス名に .count を付加した promhttp_metric_handler_requests.count が Datadog に送信されます。

: このチェックは、1 インスタンスあたり 2000 メトリクスの制限があります。返されたメトリクスの数は、Datadog Agent の status コマンドを実行した際に表示されます。構成を編集することで、関心のあるメトリクスを指定することができます。収集するメトリクスのカスタマイズ方法については、Prometheus および OpenMetrics メトリクスの収集で詳しく説明しています。より多くのメトリクスを監視する必要がある場合は、Datadog サポートにお問い合わせください。

その他のコンフィギュレーションについては、Prometheus および OpenMetrics メトリクスの収集を参照してください。

検証

Agent の status サブコマンドを実行し、Checks セクションで openmetrics を探します。

収集データ

メトリクス

OpenMetrics チェックによって収集されたメトリクスはすべて、カスタムメトリクスとして Datadog に転送されます。

イベント

OpenMetrics チェックには、イベントは含まれません。

サービスのチェック

OpenMetrics チェックには、サービスのチェック機能は含まれません。

トラブルシューティング

高いカスタムメトリクスの課金

OpenMetrics の構成において、metrics オプションに一般的なワイルドカード値を使用すると、カスタムメトリクスの課金に大きな影響を及ぼします。

Datadog では、より正確な収集のために、特定のメトリクス名またはメトリクス名の部分一致を使用することを推奨しています。

ご不明な点は、Datadog のサポートチームまでお問い合わせください。

その他の参考資料