Custom Metrics の Agent 側フィルタリング

Join the Preview!

Custom Metrics の Agent 側フィルタリングはプレビュー版です。この機能に関心がある場合は、こちらのフォームに記入してください。

Request Access

概要

Agent 側フィルタリングを使用すると、Datadog に送信する前に Datadog Agent で未使用または不要なカスタムメトリクスを (DogStatsD および Agent インテグレーションの両方から) 直接フィルタリングできます。これにより、インデックス化およびインジェストされるカスタムメトリクスボリュームを大幅に減らせます。

フィルタリングは Agent レベルで実行されますが、Datadog UI を通じて一元管理されるため、チームは完全な可視性と制御を維持できます。Datadog でフィルタリングポリシーを作成、更新、管理できるため、透明性を維持しながらメトリクスガバナンスを効率化できます。

フィルタリングポリシーの作成と更新には、metric_tags_write RBAC 権限が必要です。すべてのユーザーがフィルタリングポリシーを表示できます。

前提条件

  • Datadog Agent v7.67.0 以降にアップグレードします。
    • DogStatsD メトリクスをフィルタリングするには、v7.70.0 以降の使用が推奨されます。
    • Agent Integration メトリクスには、v7.74.0 以降の使用が必要です。
  • org_management 権限を使用して、組織の Remote Configuration を有効にします。
  • api_keys_write 権限を使用して、Agents が使用する API キーの Remote Configuration 機能 を有効にします。API キーで Remote Configuration を有効にした後、変更を反映させるために Agents を再起動します。
API キープロパティと Remote Configuration 機能の Enable ボタン。

メトリクスフィルタリングポリシーを作成する

メトリクスフィルタリングポリシーは、Metrics Settings ページ または Metrics Summary ページ から作成できます。

メトリクスフィルタリングポリシーは、Remote Configuration が有効になっているすべての Agents v7.67.0 以降 (Agent Integration メトリクスの場合は v7.74.0 以降) に適用されます。古い Agent バージョン、または Remote Configuration が無効になっている Agents には、フィルタリングポリシーは適用されません。

ポリシーの更新は 1 ～ 2 分で Agents にデプロイされます。

Metrics Settings ページから

  1. + Create Policy をクリックします。
  2. Filter metrics をクリックします。
  3. 新しいポリシーの説明を入力します。
  4. Metrics to Filter ドロップダウンからフィルタリングするメトリクスを選択するか、Upload CSV をクリックします。
    • CSV をアップロードする場合は、ファイルを選択して Open をクリックします。複数の CSV を使用してポリシーを作成できます。
  5. フィルタリングするメトリクスのリストに問題がなければ、Save and Filter をクリックします。

Metrics Summary ページから

以下のいずれかの方法を使用して、Metrics Summary ページからメトリクスフィルタリングポリシーを作成します。

    1. 検索バーにメトリクスクエリを入力します。
    2. 画面の右側にある 3 つの垂直ドットボタンをクリックします。
    3. Filter metrics をクリックします。
    4. Choose policy ドロップダウンで New Policy をクリックします。ポリシーの説明を入力します。
    5. Metrics to Filter を確認します。リストからメトリクスを削除するには行の右側にある X をクリックし、リストにメトリクスを追加するには + Include More Metrics をクリックします。
    6. Save and Filter をクリックします。
    1. 画面の右側にある 3 つの垂直ドットボタンをクリックします。
    2. Filter metrics をクリックします。
    3. Choose policy ドロップダウンで New Policy をクリックします。ポリシーの説明を入力します。
    4. Metrics to Filter フィールドにメトリクスクエリを入力するか、ドロップダウンからメトリクスを個別に選択します。リストからメトリクスを削除するには、行の右側にある X をクリックします。
    5. Save and Filter をクリックします。
    1. 画面の右側にある 3 つの垂直ドットボタンをクリックします。
    2. Filter metrics をクリックします。
    3. Choose policy ドロップダウンで New Policy をクリックします。ポリシーの説明を入力します。
    4. Metrics to Filter フィールドの右側で Upload CSV をクリックします。
    5. CSV ファイルを選択し、Open をクリックします。
    6. リストされたメトリクスを確認します。リストからメトリクスを削除するには、行の右側にある X をクリックします。必要に応じて、追加の CSV ファイルをアップロードするか、Metrics to Filter フィールドからメトリクスを追加します。
    7. Save and Filter をクリックします。

    メトリクスフィルタリングポリシーを編集する

    メトリクスフィルタリングポリシーは、Metrics Settings ページ または Metrics Summary ページ から編集できます。

    Metrics Settings ページから

    1. 編集するポリシーをクリックします。
    2. Edit をクリックします。
    3. Metrics to Filter ドロップダウンからフィルタリングするメトリクスを選択するか、Upload CSV をクリックします。
      • CSV をアップロードする場合は、ファイルを選択して Open をクリックします。
    4. Save and Filter をクリックします。

    Metrics Summary ページから

    以下のいずれかの方法を使用して、Metrics Summary ページからメトリクスフィルタリングポリシーを編集します。

      1. 検索バーにメトリクスクエリを入力します。
      2. 画面の右側にある 3 つの垂直ドットボタンをクリックします。
      3. Filter metrics をクリックします。
      4. Choose policy ドロップダウンで、編集するポリシーを選択します。
      5. Metrics to Filter および Existing metrics in policy のリストを確認します。リストからメトリクスを削除するには行の右側にある X をクリックし、リストにメトリクスを追加するには + Include More Metrics をクリックします。
      6. Save and Filter をクリックします。
      1. 画面の右側にある 3 つの垂直ドットボタンをクリックします。
      2. Filter metrics をクリックします。
      3. Choose policy ドロップダウンで、編集するポリシーを選択します。
      4. Metrics to Filter ドロップダウンからメトリクスを個別に選択します。リストからメトリクスを削除するには、行の右側にある X をクリックします。
      5. Save and Filter をクリックします。
      1. 画面の右側にある 3 つの垂直ドットボタンをクリックします。
      2. Filter metrics をクリックします。
      3. Choose policy ドロップダウンで、編集するポリシーを選択します。
      4. Upload CSV フィールドの右側で Metrics to Filter をクリックします。
      5. CSV ファイルを選択し、Open をクリックします。
      6. Metrics to Filter および Existing metrics in policy のリストを確認します。リストからメトリクスを削除するには行の右側にある X をクリックし、リストにメトリクスを追加するには + Include More Metrics をクリックします。
      7. Save and Filter をクリックします。

      すべてのポリシーとフィルタリングされたメトリクスを表示する

      Metrics Settings ページ から、すべてのポリシーとフィルタリングされたメトリクスを表示することができます。

      設定ボタン をクリックします。

      メトリクスサマリーページの設定ボタン

      ナビゲーションバーの Metrics をクリックして、設定に直接移動します。

      Datadog の展開されたメトリクスパネルの設定オプション

      すべてのポリシーを表示する

      サイドバーから Policies タブを選択して、すべてのポリシーのリストを表示します。サイドバーが表示されない場合は、Show Sidebar ボタンをクリックしてください 。

      任意のメトリクスフィルタリングポリシーをクリックして詳細ビューを開き、編集または削除を行います。

      フィルタリングされたすべてのメトリクスを表示する

      サイドバーから Filtered Metrics タブを選択して、フィルタリング済みのすべてのリストを表示します。サイドバーが表示されない場合は、Show Sidebar ボタンをクリックしてください 。

      ATTACHED POLICIES 列にあるフィルタリングされたメトリクスに紐付いたポリシーをクリックして、編集または削除を行います。

      ポリシーを削除する

      Metrics Settings ページ からメトリクスフィルタリングポリシーを削除できます。

      1. 削除するメトリクスフィルタリングポリシーをクリックします。
      2. ページ右上隅の Delete を選択します。
      メトリクスフィルタリングポリシー詳細ビューのポリシー削除ボタン

      API を使用してメトリクスフィルタリングポリシーを管理する

      これらのエンドポイントは、カスタムメトリクスの Agent 側フィルタリングがプレビュー版である間に変更される可能性があります。

      これらのエンドポイントには、有効な Datadog API キーとアプリケーションキーが必要です。詳細については、API リファレンスの はじめに を参照してください。

      フィルタリングされたメトリクスポリシーを作成する

      選択した Datadog サイト のベース URL は次のとおりです。

      以下の例の <BASE_URL> をベース URL に置き換えます。

      POST <BASE_URL>/api/unstable/remote_config/products/metric_control/filtered_metrics/policies

      本文の例

      {
  "data": {
    "type": "filtered_metrics",
    "attributes": {
      "policy_name": "my policy",
      "metric_names": [
        "metric.name.one",
        "metric.name.two"
      ]
    }
  }
}

      フィルタリングされたメトリクスポリシーを更新する (部分更新)

      選択した Datadog サイト のベース URL は次のとおりです。

      以下の例の <BASE_URL> をベース URL に置き換えます。

      PATCH <BASE_URL>/api/unstable/remote_config/products/metric_control/filtered_metrics/policies/{policy-id}

      本文の例

      {
  "data": {
    "type": "filtered_metrics",
    "attributes": {
      "policy_name": "my policy",
      "metrics_to_add": [
        "metric.name.three",
        "metric.name.four"
      ],
      "metrics_to_remove": [
        "metric.name.five",
        "metric.name.six"
      ]
    }
  }
}

      フィルタリングされたメトリクスポリシーを更新する (完全置換)

      選択した Datadog サイト のベース URL は次のとおりです。

      以下の例の <BASE_URL> をベース URL に置き換えます。

      PUT <BASE_URL>/api/unstable/remote_config/products/metric_control/filtered_metrics/policies/{policy-id}

      本文の例

      {
  "data": {
    "type": "filtered_metrics",
    "attributes": {
      "policy_name": "my policy",
      "metric_names": [
        "metric.name.seven",
        "metric.name.eight"
      ]
    }
  }
}

      ポリシーを削除する

      選択した Datadog サイト のベース URL は次のとおりです。

      以下の例の <BASE_URL> をベース URL に置き換えます。

      DELETE <BASE_URL>/api/unstable/remote_config/products/metric_control/filtered_metrics/policies/{policy-id}

      フィルタリングされたメトリクスポリシーを取得する

      選択した Datadog サイト のベース URL は次のとおりです。

      以下の例の <BASE_URL> をベース URL に置き換えます。

      GET <BASE_URL>/api/unstable/remote_config/products/metric_control/filtered_metrics/policies/{policy-id}

      応答例の本文

      {
  "data": [
    {
      "type": "filtered_metrics",
      "id": "metric.name.one",
      "attributes": {
        "updated_timestamp": 1745954352
      }
    },
    {
      "type": "filtered_metrics",
      "id": "metric.name.two"
      "attributes": {
        "updated_timestamp": 1745954389
      }
    }
    // ... up to ~10,000 entries
  ],
  "links": {
    "self": "/api/unstable/remote_config/products/metric_control/filtered_metrics/policies/{policy-id}?page[offset]=200&page[limit]=100",
    "next": "/api/unstable/remote_config/products/metric_control/filtered_metrics/policies/{policy-id}?page[offset]=300&page[limit]=100",
    "prev": "/api/unstable/remote_config/products/metric_control/filtered_metrics/policies/{policy-id}?page[offset]=100&page[limit]=100",
    "first": "/api/unstable/remote_config/products/metric_control/filtered_metrics/policies/{policy-id}?page[offset]=0&page[limit]=100",
    "last": "/api/unstable/remote_config/products/metric_control/filtered_metrics/policies/{policy-id}?page[offset]=9900&page[limit]=100"
  },
  "meta": {
    "agent_coverage_percent": 100,
    "agents_with_latest_policy_count": 4,
    "deployment_failure": {
        "failed_agent_count": 0,
        "failure_message": ""
    },
    "deployment_status": "Deployed to all Agents",
    "deployment_strategy": "all",
    "policy_name": "test_policy_1",
    "total": 7,
    "total_agent_count": 4,
    "updated_by": "user@datadoghq.com",
    "updated_timestamp": 1758912365
  }
}

      フィルタリングされたメトリクスポリシーを表示する

      選択した Datadog サイト のベース URL は次のとおりです。

      以下の例の <BASE_URL> をベース URL に置き換えます。

      GET <BASE_URL>/api/unstable/remote_config/products/metric_control/filtered_metrics/policies

      応答例の本文

      {
    "data": [
        {
            "id": "06b-fab-47e",
            "type": "filtered_metrics",
            "attributes": {
                "count": 85,
                "deployment_status": "Deployed to all Agents",
                "deployment_strategy": "all",
                "policy_name": "policy one",
                "updated_by": "user@datadoghq.com",
                "updated_timestamp": 1758547485,
                "version": 4            
            }
        },
        {
            "id": "07b-201-47e",
            "type": "filtered_metrics",
            "attributes": {
                "count": 8,
                "deployment_status": "Deployed to all Agents",
                "deployment_strategy": "all",
                "policy_name": "policy two",
                "updated_by": "user@datadoghq.com",
                "updated_timestamp": 1758547212,
                "version": 1
            }
        }
    ]
}

      プレビューの制限事項

      この初期プレビューリリースには、次の制限事項があります。

      • 除外できるメトリクス名は最大 10,000 個です。
      • Agent でのリソース使用量の影響は、最大 10 MB のメモリ (RSS) に制限されており、CPU 使用量の増加はありません。
      • DogStatsD または Agent インテグレーションから受信したカスタムメトリクスのみがサポートされています。

      参考資料

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

      Custom Metrics についてドキュメント more more Custom Metrics の課金ドキュメント more more Metrics without Limits™ドキュメント more more メトリクスボリューム管理ドキュメント more more エンドツーエンドのカスタムメトリクスガバナンスに関するベストプラクティスブログ more more