概要

Datadog は、Istio 環境のあらゆる側面を監視するため、以下を実現できます。

• ログを使用して、Envoy および Istio の Control Plane の健全性を評価 (以下を参照)。
• リクエスト、帯域幅、リソース消費のメトリクスでサービスメッシュのパフォーマンスを詳しく確認 (以下を参照)。
• ネットワークパフォーマンスモニタリングで、コンテナ、ポッド、サービス間のネットワークコミュニケーションをメッシュ状にマッピング。
• [APM[2 でメッシュを実行してアプリケーションの分散型トレースの詳細を確認。

Istio 環境での Datadog の使用について、詳細は Istio のブログをご参照ください。

セットアップ

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

インストール

Istio は Datadog Agent に含まれています。Istio サーバーまたはクラスターに Datadog Agent をインストールし、Istio で Agent を指定します。

Envoy

Envoy プロキシ を Istioで監視する場合は、Envoy インテグレーションを構成します。

コンフィギュレーション

Istio に接続するには、istio.d/conf.yaml ファイル (Agent のコンフィギュレーションディレクトリのルートにある conf.d/ フォルダー内) を編集します。使用可能なすべてのコンフィギュレーションオプションについては、サンプル istio.d/conf.yaml を参照してください。

メトリクスの収集

Istio v1.5+ の istiod デプロイメントと istio-proxy を監視するために、Prometheus 形式のメトリクスを収集するための 2 つの主要なコンポーネントがあります。Istio アーキテクチャに沿って、データプレーン (istio-proxy サイドカーコンテナ) とコントロールプレーン (プロキシを管理する istiod サービス) が存在します。これらは両方とも istio Agent チェックとして実行されますが、異なる責任を負っており、以下に説明するように別々に構成されます。

データプレーン構成

Istio データプレーンを監視するために、Agent は istio.d/auto_conf.yaml ファイルを含み、istio-proxy サイドカーコンテナごとに監視を自動的にセットアップするようになっています。Agent は、自動的に検出した各サイドカーコンテナに対してこのチェックを初期化します。この構成により、各サイドカーコンテナから公開されるデータの istio.mesh.* メトリクスをレポートすることができます。

インテグレーションのデータプレーン部分をカスタマイズするには、Istio 用に同等のコンフィギュレーションファイルを作成します。ad_identifiers と istio_mesh_endpoint を適切に設定し、istio-proxy サイドカーコンテナが検出された場合のインテグレーションをセットアップします。利用可能なすべての構成オプションは、提供されている istio.d/auto_conf.yaml とコンフィギュレーションファイル例を参照してください。カスタマイズの際には、use_openmetrics: true と exclude_labels を以下の構成に設定します。

    exclude_labels:
      - source_version
      - destination_version
      - source_canonical_revision
      - destination_canonical_revision
      - source_principal
      - destination_principal
      - source_cluster
      - destination_cluster
      - source_canonical_service
      - destination_canonical_service
      - source_workload_namespace
      - destination_workload_namespace
      - request_protocol
      - connection_security_policy

コントロールプレーン構成

Istio のコントロールプレーンを監視し、mixer、galley、pilot、citadel のメトリクスをレポートするには、istiod デプロイメントを監視するように Agent を構成する必要があります。Istio v1.5+ では、istio-system ネームスペースにある istiod デプロイメントのポッドアノテーションとして、以下のオートディスカバリーアノテーションを適用してください。

ad.datadoghq.com/discovery.check_names: '["istio"]'
ad.datadoghq.com/discovery.init_configs: '[{}]'
ad.datadoghq.com/discovery.instances: |
     [
       {
         "istiod_endpoint": "http://%%host%%:15014/metrics",
         "use_openmetrics": "true"
       }
     ]     

これらのアノテーションの適用方法は、使用する Istio のデプロイメント戦略 (Istioctl、Helm、Operator) によって異なります。これらのポッドアノテーションを適用するための適切な方法については、Istio のドキュメントを参照してください。

これらのアノテーションは、discovery を <CONTAINER_IDENTIFIER> として参照し、istiod デプロイメントのポッドのデフォルトコンテナ名と一致するようにします。もし、コンテナ名が異なる場合は、適宜調整してください。

OpenMetrics V2 と OpenMetrics V1 の比較

use_openmetrics 構成オプションを有効にすると、Istio インテグレーションはチェックの OpenMetrics V2 実装を使用します。

OpenMetrics V2 では、デフォルトでより正確にメトリクスが送信され、Prometheus のメトリクスタイプに近い挙動をします。例えば、Prometheus の _count や _sum で終わるメトリクスは、デフォルトでは monotonic_count として送信されます。

OpenMetrics V2 は、OpenMetrics V1 のパフォーマンスと品質に関する問題を解決しています。ネイティブのメトリクスタイプのサポート、構成の改善、カスタムメトリクスタイプなどのアップデートが含まれています。

OpenMetrics V1 の実装を使用する場合は、use_openmetrics 構成オプションを false に設定します。OpenMetrics V1 の構成パラメーターを見るには、conf.yaml.example ファイルを参照してください。

Datadog Agent ポッドのサイドカーインジェクションを無効化

コンテナに Datadog Agent をインストールする場合は、その前に Istio のサイドカーインジェクションを無効にすることをお勧めします。

Istio バージョン >= 1.10:

sidecar.istio.io/inject: "false" ラベルを datadog-agent DaemonSet に追加します。

# (...)
spec:
  template:
    metadata:
      labels:
        sidecar.istio.io/inject: "false"
    # (...)

これは、kubectl patch コマンドでも実行できます。

kubectl patch daemonset datadog-agent -p '{"spec":{"template":{"metadata":{"labels":{"sidecar.istio.io/inject":"false"}}}}}'

Istio バージョン <= 1.9:

sidecar.istio.io/inject: "false" アノテーションを datadog-agent DaemonSet に追加します。

# (...)
spec:
  template:
    metadata:
      annotations:
        sidecar.istio.io/inject: "false"
    # (...)

kubectl patch コマンドを使用します。

kubectl patch daemonset datadog-agent -p '{"spec":{"template":{"metadata":{"annotations":{"sidecar.istio.io/inject":"false"}}}}}'

ログの収集

Istio には 2 種類のログがあります。Envoy インテグレーション、あるいは Istio logs で収集される Envoy アクセスログです。

Agent バージョン 6.0 以降で利用可能

オートディスカバリーのインテグレーションテンプレートのガイドを参照して、次のパラメーターを適用してください。 Datadog Agent で、ログの収集はデフォルトで無効になっています。有効にする方法については、Kubernetes ログ収集を参照してください。

検証

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

収集データ

メトリクス

イベント

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

サービスのチェック

istio.prometheus.health
Returns CRITICAL if the check cannot access the metrics endpoint. Returns OK otherwise.
Statuses: ok, critical

istio.openmetrics.health
Returns CRITICAL if the Agent is unable to connect to the OpenMetrics endpoint, otherwise returns OK.
Statuses: ok, critical

istio.pilot.prometheus.health
Returns CRITICAL if the check cannot access the metrics endpoint. Returns OK otherwise.
Statuses: ok, critical

istio.galley.prometheus.health
Returns CRITICAL if the check cannot access the metrics endpoint. Returns OK otherwise.
Statuses: ok, critical

istio.citadel.prometheus.health
Returns CRITICAL if the check cannot access the metrics endpoint. Returns OK otherwise.
Statuses: ok, critical

トラブルシューティング

無効なチャンク長のエラー

Istio の OpenMetricsBaseCheck (V1) 実装 (Istio インテグレーションバージョン 3.13.0 以降) で、以下のエラーが発生する場合:

  Error: ("Connection broken: InvalidChunkLength(got length b'', 0 bytes read)",
  InvalidChunkLength(got length b'', 0 bytes read))

このエラーを解決するには、Istio インテグレーションの Openmetrics V2 実装を使用することができます。

注: 最低でも Agent 7.31.0 と Python 3 にアップグレードする必要があります。Openmetrics V2 を有効にするには、構成のセクションを参照してください。

Istio のデプロイメントで一般的な Openmetrics インテグレーションを使用する

Istio のプロキシサイドカーインジェクションが有効な場合、istio_mesh_endpoint と同じメトリクスエンドポイントで Openmetrics インテグレーションを使用して他の Prometheus メトリクスを監視すると、カスタムメトリクス使用量が多く、メトリクス収集が二重になることがあります。

Openmetrics の構成により、メトリクスの収集が重複しないようにするためには、以下のどちらかを行います。

1. 構成オプション metrics で特定のメトリクスのマッチングを使用するか、または
2. metrics にワイルドカード * 値を使用する場合、以下の Openmetrics インテグレーションオプションを使用して、Istio および Envoy インテグレーションで既にサポートされているメトリクスを除外することを検討します。

Openmetrics V2 による汎用的なメトリクス収集の構成

カスタムメトリクスの高額請求を避けるため、必ず Istio と Envoy のメトリクスを構成から除外してください。Openmetrics V2 の構成 (openmetrics_endpoint が有効) を使用する場合は exclude_metrics を使用します。

## 各インスタンスは、他のインスタンスとは独立してスケジュールされます。
#
instances:
  - openmetrics_endpoint: <OPENMETRICS_ENDPOINT>
    metrics: [*]
    exclude_metrics:
      - istio_*
      - envoy_*

Openmetrics V1 による汎用的なメトリクス収集の構成 (レガシー)

カスタムメトリクスの高額請求を避けるため、必ず Istio と Envoy のメトリクスを構成から除外してください。Openmetrics V1 の構成 (prometheus_url が有効) を使用する場合は ignore_metrics を使用します。

instances:
  - prometheus_url: <PROMETHEUS_URL>
    metrics:
      - *
    ignore_metrics:
      - istio_*
      - envoy_*

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

その他の参考資料

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

• Datadog を使用した Istio サービスメッシュの監視
• Datadog でキーメトリクスを収集して Istio を監視する
• Datadog を使用した Istio の監視方法