Kafka メトリクスレシーバー 🔗

Kafkaメトリクスレシーバーは、KafkaサーバーからKafkaメトリクス(ブローカー、トピック、パーティション、コンシューマーグループなど)を収集し、OTLP形式に変換します。サポートされるパイプラインタイプは metrics です。詳細はパイプラインでデータを処理するを参照してください。

注釈

すぐに使えるダッシュボードとナビゲーターはまだKafkaメトリクスレシーバーではサポートされていませんが、将来のリリースではサポートされる予定です。

はじめに 🔗

以下の手順に従って、コンポーネントの設定とアクティベーションを行ってください：

Splunk Distribution of the OpenTelemetry Collector をホストまたはコンテナプラットフォームにデプロイします：
次のセクションで説明するようにレシーバーを設定します。
Collector を再起動します。

サンプル構成 🔗

Kafkaメトリクスレシーバーを有効にするには、次の例のように、設定ファイルの kafkametrics セクションに receivers を追加します：

receivers:
  kafkametrics:
    protocol_version: 2.0.0
    scrapers:
      - brokers
      - topics
      - consumers

コンフィギュレーションを完了するには、コンフィギュレーションファイルの service セクションの metrics パイプラインに、レシーバーを含めます。例：

service:
  pipelines:
    metrics:
      receivers: [kafkametrics]

設定オプション 🔗

以下の設定が必要です：

protocol_version。デフォルトはありません。Kafkaプロトコルバージョン、たとえば 2.0.0。
scrapers。デフォルトはありません。以下のスクレイパーの任意の組み合わせを有効にできます：
- topics
- consumers
- brokers

以下の設定はオプションです：

brokers デフォルトでは localhost:9092。読み込み元のブローカーのリスト。
resolve_canonical_bootstrap_servers_only。デフォルトでは false です。起動時にブローカーIPを解決してから逆引きするかどうかを決定します。
topic_match。デフォルトでは ^[^_].*$) です。メトリクスコレクションでフィルターリングするトピックの正規表現パターン。デフォルトのフィルターでは、_ で始まる内部トピックは除外されます。
group_match。デフォルトでは .*) です。メトリクス用にフィルターリングする消費者グループの正規表現パターン。
client_id。デフォルトでは otel-metrics-receiver です。消費者クライアントID。
collection_interval。デフォルトでは 1m です。メトリクス収集/スクレイピングの頻度。
initial_delay。デフォルトでは 1s です。このレシーバーが開始するまでの待ち時間を決定します。
auth。デフォルトはありません。以下のいずれかを使用します：
- plain_text。以下のフィールドがあります：
  - username。使用するユーザー名。
  - password。使用するパスワード。
- tls。以下のフィールドがあります：
  - ca_file。insecure が false に設定されている場合のみ使用します。CA証明書へのパス。クライアントでは、サーバー証明書を検証します。
  - cert_file。insecure が false に設定されている場合のみ使用します。TLSが必要な接続に使用するTLS認証へのパス。
  - key_file。insecure が false に設定されている場合のみ使用します。TLSが必要な接続に使用するTLSキーへのパス。
  - insecure。デフォルトでは false です。tls設定で、サーバーの証明書チェーンとホスト名、InsecureSkipVerify の検証を無効にします。
  - server_name_override。バーチャルホスティングをサポートするためにクライアントが要求したサーバー名を示します。
- kerberos。以下のフィールドがあります：
  - service_name。Kerberosサービス名。
  - realm。Kerberosレルム。
  - use_keytab。true の場合、パスワードの代わりにkeytabが使われます。
  - username。KDCでの認証に使用するKerberosユーザー名。
  - password。KDCでの認証に使用するKerberosパスワード。
  - config_file。Kerberos設定へのパス、例えば /etc/krb5.conf。
  - keytab_file。keytabファイルへのパス、例えば /etc/security/kafka.keytab。
  - disable_fast_negotiation。デフォルトでは false です。PA-FX-FASTネゴシエーション(Pre-Authentication Framework - Fast)を無効にします。一部の一般的なKerberos実装はPA-FX-FASTネゴシエーションをサポートしていません。

設定例：認証と収集間隔を5秒に設定します 🔗

この例では、すべてのスクレイパーの収集間隔を5秒に設定し、TLS認証を設定しています：

receivers:
  kafkametrics:
    brokers: 10.10.10.10:9092
    protocol_version: 2.0.0
    scrapers:
      - brokers
      - topics
      - consumers
    auth:
      tls:
        ca_file: ca.pem
        cert_file: cert.pem
        key_file: key.pem
    collection_interval: 5s

設定 🔗

以下の表に、Kafkaメトリクスレシーバーの設定オプションを示します：

メトリクス 🔗

以下のメトリクス、リソース属性、および属性が使用できます。

特定のメトリクスをアクティブまたは非アクティブにする 🔗

各メトリクスの metrics セクションの enabled フィールドを設定することで、特定のメトリクスをアクティブまたは非アクティブにできます。例：

receivers:
  samplereceiver:
    metrics:
      metric-one:
        enabled: true
      metric-two:
        enabled: false

以下は、アクティブ化されたメトリクスを持つホスト・メトリクス・レシーバーの構成例です：

receivers:
  hostmetrics:
    scrapers:
      process:
        metrics:
          process.cpu.utilization:
            enabled: true

注釈

無効化されたメトリクスは Splunk Observability Cloud に送信されません。

請求 🔗

MTSベースのサブスクリプションでは、すべてのメトリクスがメトリクスの使用量にカウントされます。
ホストベースのプランに加入している場合、このドキュメントでアクティブ（Active: Yes）と記載されているメトリクスはデフォルトとみなされ、無料で含まれます。

詳しくは Infrastructure Monitoringのサブスクリプション使用状況（ホストとメトリクスのプラン）を参照してください。

トラブルシューティング 🔗

Splunk Observability Cloudをご利用のお客様で、Splunk Observability Cloudでデータを確認できない場合は、以下の方法でサポートを受けることができます。

Splunk Observability Cloudをご利用のお客様

Splunk サポートポータルでケースを送信する
Splunkサポートに連絡する

見込み客および無料トライアルユーザー様

Splunk Answers のコミュニティサポートで質問し、回答を得る
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.

このページは 2025年02月11日に最終更新されました。

Related Topics