.NET: Apache Kafka® のサンプルコード

このチュートリアルでは、Apache Kafka® クラスターにメッセージを生成し、このクラスターからメッセージを消費する .NET クライアントアプリケーションを実行します。

チュートリアルの実行後に、提供された ソースコード をリファレンスとして使用して、独自の Kafka クライアントアプリケーションを開発します。

前提条件

クライアント

  • .NET Core 2.1 以降(クライアントアプリケーションの実行用)
  • Windows の場合、デフォルトの信頼されるルート CA 証明書が Windows レジストリに格納されていること。これは、Confluent Cloud へのセキュアなアクセスのために必要です。現時点では、これらの証明書にアクセスする機能が .NET ライブラリにないため、別の場所から入手する必要があります。たとえば、curl(cacert.pm をダウンロード)で配布される cacert.pem ファイルを使用します。

SSL トラストストアの構成

オペレーティングシステムまたは Linux ディストリビューションによっては、追加の手順を実行して SSL CA ルート証明書をセットアップする必要がある場合があります。システムで SSL CA ルート証明書が正しくセットアップされていない場合は、次のような SSL handshake failed エラーメッセージが表示される場合があります。

%3|1605776788.619|FAIL|rdkafka#producer-1| [thrd:sasl_ssl://...confluent.cloud:9092/bootstr]: sasl_ssl://...confluent.cloud:9092/bootstrap: SSL handshake failed: error:14090086:SSL routines:ssl3_get_server_certificate:certificate verify failed: broker certificate could not be verified, verify that ssl.ca.location is correctly configured or root CA certificates are installed (brew install openssl) (after 258ms in state CONNECT)

この場合は、検証済み CA ルート証明書のセットを手作業でインストールする必要があります。また、クライアントコードを変更して ssl.ca.location 構成プロパティを設定する必要がある場合もあります(詳細については、このクライアントの基盤である librdkafka のドキュメントを参照してください)。

macOS

より新しい macOS バージョン(10.15 など)では、依存関係の追加が必要な場合があります。

Python クライアントの場合:

pip install certifi

その他のクライアントの場合:

brew install openssl

CA ルート証明書をインストールしたら、クライアントコードで ssl.ca.location プロパティを設定します。プロデューサーとコンシューマーのコードファイルを両方とも編集し、プロデューサーおよびコンシューマーのプロパティ内に ssl.ca.location 構成パラメーターを追加します。その値は、ホスト上の適切な CA ルート証明書ファイルの場所に対応している必要があります。

Python クライアントの場合は、certifi.where() を使用して、証明書ファイルの場所を決定します。

ssl.ca.location: certifi.where()

その他のクライアントの場合は、インストールパスを調べ、それをコードで指定します。

ssl.ca.location: '/usr/local/etc/openssl@1.1/cert.pem'
CentOS

次の方法で CA ルート証明書をインストールする必要がある場合があります。

sudo yum reinstall ca-certificates

これで、Kafka クライアントは証明書を見つけることができます。ただし、同じエラーが依然として表示される場合は、クライアントコードで ssl.ca.location プロパティを設定できます。プロデューサーとコンシューマーのコードファイルを両方とも編集し、プロデューサーおよびコンシューマーのプロパティ内に ssl.ca.location 構成パラメーターを追加します。その値は、次の例のように、ホスト上の適切な CA ルート証明書ファイルの場所に対応している必要があります。

ssl.ca.location: '/etc/ssl/certs/ca-bundle.crt'

Kafka クラスター

このチュートリアルは、Confluent Cloud を使用して取り組むのが最も簡単です。そうすればローカル Kafka クラスターを実行する必要はありません。Confluent Cloud にサインアップするときは、プロモーションコード C50INTEG を適用すると、$50 相当を無料で使用できます(詳細)。Console から LEARN をクリックしてクラスターをプロビジョニングし、Clients をクリックして、クライアントアプリケーションに対して設定するクラスター固有の構成と認証情報を取得します。サポートされている CLIREST API、またはコミュニティでサポートされている Confluent Cloud 向け ccloud-stack ユーティリティ を使用してもかまいません。

Confluent Cloud の使用を希望しない場合は、ローカルホスト や他のリモートサーバーで実行されている Kafka クラスターでこのチュートリアルに取り組むこともできます。

セットアップ

  1. confluentinc/examples GitHub リポジトリのクローンを作成し、6.2.4-post ブランチをチェックアウトします。

    git clone https://github.com/confluentinc/examples
    cd examples
    git checkout 6.2.4-post
    
  2. .NET のサンプルのディレクトリに変更します。

    cd clients/cloud/csharp/
    
  3. Kafka クラスターに接続するための構成パラメーターを含むローカルファイル($HOME/.confluent/librdkafka.config など)を作成します。以下のテンプレートのいずれかをベースとして、クラスターへの接続情報でこのファイルをカスタマイズします。{{ BROKER_ENDPOINT }}{{CLUSTER_API_KEY }}、および {{ CLUSTER_API_SECRET }} に値を代入します(この値を手作業で見つける方法については、「Configure Confluent Cloud Clients」を参照してください。 または、Confluent Cloud 向け ccloud-stack ユーティリティ を使用して値を自動作成します)。

    • Confluent Cloud のテンプレート構成ファイル

      # Kafka
      bootstrap.servers={{ BROKER_ENDPOINT }}
      security.protocol=SASL_SSL
      sasl.mechanisms=PLAIN
      sasl.username={{ CLUSTER_API_KEY }}
      sasl.password={{ CLUSTER_API_SECRET }}
      
    • ローカルホストのテンプレート構成ファイル

      # Kafka
      bootstrap.servers=localhost:9092
      

基本プロデューサーおよびコンシューマー

このサンプルでは、プロデューサーアプリケーションが Kafka クラスターのトピックに Kafka データを書き込みます。Kafka クラスターにトピックがまだ存在しない場合、プロデューサーアプリケーションは Kafka Admin Client API を使用してトピックを作成します。Kafka に書き込まれる各レコードには、ユーザー名(alice など)を表すキーと、json フォーマットのカウント値({"count": 0} など)があります。コンシューマーアプリケーションは、同じ Kafka トピックを読み取り、各レコードの処理中にカウントのローリング合計を保持します。

レコードの生成

  1. サンプルクライアントアプリケーションをビルドします。

    dotnet build
    
  2. このサンプルアプリケーションを実行して、次の引数を渡します。

    • 生成と消費のどちらを行うか(produce)
    • トピック名
    • Kafka クラスターに接続するための構成パラメーターを含むローカルファイル
    • Windows のみ: デフォルトの信頼されるルート CA 証明書を含むローカルファイル
    # Run the producer (Windows)
    dotnet run produce test1 $HOME/.confluent/librdkafka.config /path/to/curl/cacert.pem
    
    # Run the producer (other)
    dotnet run produce test1 $HOME/.confluent/librdkafka.config
    
  3. プロデューサーがすべてのメッセージを送信したことを確認します。次のように表示されます。

    Producing record: alice {"count":0}
    Producing record: alice {"count":1}
    Producing record: alice {"count":2}
    Producing record: alice {"count":3}
    Producing record: alice {"count":4}
    Producing record: alice {"count":5}
    Producing record: alice {"count":6}
    Producing record: alice {"count":7}
    Producing record: alice {"count":8}
    Producing record: alice {"count":9}
    Produced record to topic test1 partition [0] @ offset 0
    Produced record to topic test1 partition [0] @ offset 1
    Produced record to topic test1 partition [0] @ offset 2
    Produced record to topic test1 partition [0] @ offset 3
    Produced record to topic test1 partition [0] @ offset 4
    Produced record to topic test1 partition [0] @ offset 5
    Produced record to topic test1 partition [0] @ offset 6
    Produced record to topic test1 partition [0] @ offset 7
    Produced record to topic test1 partition [0] @ offset 8
    Produced record to topic test1 partition [0] @ offset 9
    10 messages were produced to topic test1
    
  4. プロデューサーコード を表示します。

レコードの消費

  1. このサンプルアプリケーションを実行して、次の引数を渡します。

    • 生成と消費のどちらを行うか(consume)
    • トピック名: 上の手順で使用したものと同じトピック名
    • Kafka クラスターに接続するための構成パラメーターを含むローカルファイル
    • Windows のみ: デフォルトの信頼されるルート CA 証明書を含むローカルファイル
    # Run the consumer (Windows)
    dotnet run consume test1 $HOME/.confluent/librdkafka.config /path/to/curl/cacert.pem
    
    # Run the consumer (other)
    dotnet run consume test1 $HOME/.confluent/librdkafka.config
    
  2. コンシューマーがすべてのメッセージを送信したことを確認します。次のように表示されます。

    Consumed record with key alice and value {"count":0}, and updated total count to 0
    Consumed record with key alice and value {"count":1}, and updated total count to 1
    Consumed record with key alice and value {"count":2}, and updated total count to 3
    Consumed record with key alice and value {"count":3}, and updated total count to 6
    Consumed record with key alice and value {"count":4}, and updated total count to 10
    Consumed record with key alice and value {"count":5}, and updated total count to 15
    Consumed record with key alice and value {"count":6}, and updated total count to 21
    Consumed record with key alice and value {"count":7}, and updated total count to 28
    Consumed record with key alice and value {"count":8}, and updated total count to 36
    Consumed record with key alice and value {"count":9}, and updated total count to 45
    
  3. 入力し終わったら、Ctrl + C キーを押します("+" はキーを同時に押すことを意味します)。

  4. コンシューマーコード を表示します。