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.

注釈

Out-of-the-box dashboards and navigators aren’t supported for the Kafka metrics receiver yet, but are planned for a future release.

はじめに 🔗

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

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. No default. Any combination of the following scrapers can be enabled:
- topics
- consumers
- brokers

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

brokers. localhost:9092 by default. The list of brokers to read from.
resolve_canonical_bootstrap_servers_only. false by default. Determines whether to resolve then reverse-lookup broker IPs during startup.
topic_match. ^[^_].*$) by default. Regex pattern of topics to filter on metrics collection. The default filter excludes internal topics, which start with _.
group_match. .*) by default. Regex pattern of consumer groups to filter on for metrics.
client_id. otel-metrics-receiver by default. Consumer client 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. No default. Use one of the following:
- 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 by default. Disables the verification of the server’s certificate chain and host name, InsecureSkipVerify in the tls configuration.
  - server_name_override. Indicates the name of the server requested by the client in order to support virtual hosting.
- kerberos. It has the following fields:
  - service_name. Kerberos service name.
  - realm. Kerberos realm.
  - use_keytab. If true, the keytab is used instead of the password.
  - username. The Kerberos username used to authenticate with KDC.
  - password. The Kerberos password used to authenticate with KDC.
  - config_file. Path to Kerberos configuration, for example /etc/krb5.conf.
  - keytab_file. Path to the keytab file, for example /etc/security/kafka.keytab.
  - disable_fast_negotiation. false by default. Disables the PA-FX-FAST negotiation (Pre-Authentication Framework - Fast). Some common Kerberos implementations do not support PA-FX-FAST negotiation.

Configuration example: Set authentication and the collection interval to 5 seconds 🔗

This example sets the collection interval for all scrapers to 5 seconds and configures TLS authentication:

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.
If you’re in a host-based plan, metrics listed as active (Active: Yes) on this document are considered default and are included free of charge.

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 マニュアルのチャットグループを参照してください。

This page was last updated on 2024年11月13日.

Related Topics