Datadog Agent と Datadog-OpenMetrics または Datadog-Prometheus インテグレーションを併用して、ホストで実行されているアプリケーションから、公開されている Prometheus および OpenMetrics メトリクスを収集します。

概要

バージョン 6.5.0 より、Agent には OpenMetrics および Prometheus チェックが用意され、Prometheus エンドポイントをスクレイピングできます。Prometheus テキスト形式を効率よくフルにサポートできるため、Datadog では OpenMetrics チェックの 使用をお勧めします。カスタムチェックの記述を含む OpenMetricsCheck インターフェイスの高度な使用方法については、開発ツールのセクションを参照してください。Prometheus チェックは、メトリクスのエンドポイントがテキスト形式をサポートしていない場合にのみ使用してください。

このページでは、これらのチェックの基本的な使用方法について説明します。これにより、Datadog 内のすべての Prometheus 公開メトリクスをインポートできるようになります。

セットアップ

インストール

対応するオペレーティングシステムに Datadog Agent をインストールします。OpenMetrics および Prometheus チェックは Datadog Agent パッケージに含まれています。コンテナまたはホストに追加でインストールする必要はありません。

構成

公開されたメトリクスを収集するには

1. Agent の構成ディレクトリのルートにある conf.d/ フォルダーの openmetrics.d/conf.yaml ファイルを編集します。使用可能なすべての構成オプションの詳細については、サンプル openmetrics.d/conf.yaml を参照してください。これは、インテグレーションを有効にするために必要な最低限の構成です。

   init_config:
   
   instances:
       - openmetrics_endpoint: 'localhost:<PORT>/<ENDPOINT>'
         namespace: '<NAMESPACE>'
         metrics:
             - '<METRIC_TO_FETCH>': '<DATADOG_METRIC_NAME>'
   

   次の構成プレースホルダー値を使用します。

   プレースホルダー	説明
   <ポート>	Prometheus エンドポイントにアクセスするために接続するポート。
   <エンドポイント>	コンテナによって提供されるメトリクスの URL（Prometheus 形式）。
   <ネームスペース>	Datadog で表示するときに、すべてのメトリクスの前にネームスペースをプレフィックスとして設定します。
   <フェッチするメトリクス>	Prometheus エンドポイントからフェッチされる Prometheus メトリクスキー。
   <DATADOG_メトリクス名>	オプションパラメーター。設定すると、<フェッチするメトリクス> メトリクスキーは Datadog の <DATADOG_メトリクス名> に変換されます。 このオプションを使用しない場合は、key:value ペアではなく、文字列のリストを渡します。

2. Agent を再起動すると、メトリクスの収集が開始されます。

利用可能なパラメーター

インスタンスで使用可能なパラメーターを以下にリストします。

注: send_distribution_buckets および send_distribution_counts_as_monotonic 以外のすべてのパラメーターは、OpenMetrics チェックと Prometheus チェックの両方でサポートされています。

はじめに

シンプルなメトリクスの収集

Prometheus によって公開されたメトリクスの収集を開始するには、次の手順に従います。

1. Prometheus Getting Started のドキュメントに従って、自分自身を監視する Prometheus のローカルバージョンを起動します。

2. プラットフォームに Datadog Agent をインストールします。

3. Agent の構成ディレクトリのルートにある conf.d/ フォルダーの openmetrics.d/conf.yaml ファイルを次の内容で編集します。

   init_config:
   
   instances:
       - openmetrics_endpoint: http://localhost:9090/metrics
         namespace: 'documentation_example'
         metrics:
             - promhttp_metric_handler_requests_total: prometheus.handler.requests.total
   

4. Agent を再起動します。

5. メトリクスサマリーページに移動して、収集されたメトリクスを確認します: prometheus_target_interval_length_seconds*

カスタムインテグレーションを公式インテグレーションに

デフォルトでは、汎用の Prometheus チェックによって取得されるすべてのメトリクスが、カスタムメトリクスだと見なされます。既製ソフトウェアを監視されて、公式のインテグレーションにするべきだと思われた場合は、ぜひご提供をお願いします。

公式インテグレーションは、それぞれ専用のディレクトリを持ちます。汎用のチェックには、デフォルトの構成とメトリクスメタデータをハードコードするためのデフォルトのインスタンスメカニズムがあります。たとえば、kube-proxy インテグレーションを参照します。

その他の参考資料

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

ログの収集ドキュメント プロセスの収集ドキュメント トレースの収集ドキュメント カスタム Prometheus チェックの記述ドキュメント