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

The Kafka metrics receiver collects Kafka metrics (such as brokers, topics, partitions, and consumer groups) from a Kafka server and converts them to OTLP format. The supported pipeline type is metrics. See パイプラインでデータを処理する for more information.

注釈

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

はじめに 🔗

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

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

サンプル構成 🔗

To activate the Kafka metrics receiver, add kafkametrics to the receivers section of your configuration file, as shown in the following example:

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

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

service:
  pipelines:
    metrics:
      receivers: [kafkametrics]

設定オプション 🔗

These settings are required:

protocol_version. No default. The Kafka protocol version, for example 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 by default. Frequency of metric collection/scraping.
initial_delay. 1s by default. Determines how long this receiver waits before starting.
auth。デフォルトはありません。以下のいずれかを使用します：
- plain_text. It has the following fields:
  - username. The username to use.
  - password. The password to use.
- tls. It has the following fields:
  - ca_file. Use only if insecure is set to false. Path to the CA cert. For a client it verifies the server certificate.
  - cert_file. Use only if insecure is set to false. Path to the TLS cert to use for TLS required connections.
  - key_file. Use only if insecure is set to false. Path to the TLS key to use for TLS required connections.
  - insecure。デフォルトでは false です。tls設定で、サーバーの証明書チェーンとホスト名、InsecureSkipVerify の検証を無効にします。
  - server_name_override。バーチャルホスティングをサポートするためにクライアントが要求したサーバー名を示します。
- kerberos. It has the following fields:
  - service_name. Kerberos service name.
  - realm。Kerberosレルム。
  - use_keytab。true の場合、パスワードの代わりにkeytabが使われます。
  - username. The Kerberos username used to authenticate with KDC.
  - password. The Kerberos password used to authenticate with KDC.
  - 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

設定 🔗

The following table shows the configuration options for the Kafka metrics receiver:

メトリクス 🔗

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

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

各メトリクスの 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 に送信されません。

Billing 🔗

If you’re in a MTS-based subscription, all metrics count towards metrics usage.
ホストベースのプランに加入している場合、このドキュメントでアクティブ（Active: Yes）と記載されているメトリクスはデフォルトとみなされ、無料で含まれます。

Learn more at Infrastructure Monitoringのサブスクリプション使用状況（ホストとメトリクスのプラン）.

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

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

Splunk Observability Cloudをご利用のお客様

Submit a case in the Splunk Support Portal .
Contact Splunk Support .

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

Splunk Answers のコミュニティサポートで質問し、回答を得る
Splunk #observability ユーザーグループの Slack チャンネルに参加して、世界中の顧客、パートナー、Splunk 社員とのコミュニケーションを図る。参加するには、Get Started with Splunk Community マニュアルのチャットグループを参照してください。

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

Related Topics