Azure Event Hubs エミュレーターを使用してローカルでテストする

この記事では、Azure Event Hubs エミュレーターを使用して、ローカルで開発およびテストする手順をまとめます。

前提条件

• Docker デスクトップ
• 最小ハードウェア要件:
  • 2 GB の RAM
  • 5 GB のディスク領域
• Linux 用 Windows サブシステム (WSL) の構成 (Windows の場合のみ):
  • WSL をインストールする
  • WSL が使用されるように Docker を構成する

Note

この記事の手順に進む前に、Docker Desktop がバックグラウンドで動作することを確認してください。

エミュレーターを実行する

Event Hubs エミュレーターを実行するには、自動化されたスクリプトまたは Linux コンテナーを使用できます。

自動スクリプト

自動スクリプトを実行する前に、エミュレーターの GitHub インストーラー リポジトリをローカルに複製します。

Windows

Windows で Event Hubs エミュレーターをローカルで実行するには、次の手順に従います。

1. PowerShell ウィンドウで次のコマンドを実行して、署名されていないスクリプトの実行を許可します。

   $>Start-Process powershell -Verb RunAs -ArgumentList 'Set-ExecutionPolicy Bypass –Scope CurrentUser'

2. セットアップ スクリプト LaunchEmulator.ps1 を実行します。 このスクリプトを実行すると、Event Hubs エミュレーターと Azurite (エミュレーターの依存関係) の 2 つのコンテナーが表示されます。

Linux と macOS

Linux または macOS で Event Hubs エミュレーターをローカルで実行するには、次の手順に従います。

• セットアップ スクリプト LaunchEmulator.sh を実行します。このスクリプトを実行すると、Event Hubs エミュレーターと Azurite (エミュレーターの依存関係) の 2 つのコンテナーが表示されます。

Docker (Linux コンテナー)

1. エミュレーターを起動するには、使用するエンティティの構成を指定します。 次の JSON ファイルを config.json としてローカルに保存します。

   {
       "UserConfig": {
           "NamespaceConfig": [
           {
               "Type": "EventHub",
               "Name": "emulatorNs1",
               "Entities": [
               {
                   "Name": "eh1",
                   "PartitionCount": "2",
                   "ConsumerGroups": [
                   {
                       "Name": "cg1"
                   }
                   ]
               }
               ]
           }
           ], 
           "LoggingConfig": {
               "Type": "File"
           }
       }
   }
   
   

2. Event Hubs エミュレータのコンテナーを起動するために、次の .yaml ファイルを docker-compose.yaml として保存します。

   name: microsoft-azure-eventhubs
   services:
     emulator:
       container_name: "eventhubs-emulator"
       image: "mcr.microsoft.com/azure-messaging/eventhubs-emulator:latest"
       volumes:
         - "${CONFIG_PATH}:/Eventhubs_Emulator/ConfigFiles/Config.json"
       ports:
         - "5672:5672"
         - "9092:9092"
       environment:
         BLOB_SERVER: azurite
         METADATA_SERVER: azurite
         ACCEPT_EULA: ${ACCEPT_EULA}
       depends_on:
         - azurite
       networks:
         eh-emulator:
           aliases:
             - "eventhubs-emulator"
     azurite:
       container_name: "azurite"
       image: "mcr.microsoft.com/azure-storage/azurite:latest"
       ports:
         - "10000:10000"
         - "10001:10001"
         - "10002:10002"
       networks:
         eh-emulator:
           aliases:
             - "azurite"
   networks:
     eh-emulator:
   

3. .env ファイルを作成して、その中で Event Hubs エミュレーターの環境変数を宣言します。

   # Centralized environment variables store for docker-compose
   
   # 1. CONFIG_PATH: Path to config.json file
   CONFIG_PATH="<Replace with path to config.json file>" 
   
   # 2. ACCEPT_EULA: Pass 'Y' to accept license terms. 
   ACCEPT_EULA="N"
   
   

   ACCEPT_EULA 引数は、Microsoft ソフトウェア ライセンス条項を確認します。 .env ファイルは、docker-compose.yaml ファイルと同じディレクトリに配置してください。

   重要

   Windows でファイル パスを指定するときは、円記号 (\) でなく、ニ重の円記号 (\\) を使用して、エスケープ文字の問題が発生しないようにください。

4. エミュレータを実行するために次のコマンドを実行します。

    docker compose -f <PathToDockerComposeFile> up -d
   

この手順が成功すると、Docker で実行されているコンテナーが見つかります。

エミュレーターを操作する

既定では、エミュレータは config.json 構成ファイルを使用します。 構成ファイルに変更を加えることで、エンティティ (Event Hubs または Kafka のトピック) を構成できます。 詳細については、「構成を変更する」を参照してください

次の接続文字列を使用して、Event Hubs エミュレーターに接続できます。

• エミュレータ コンテナーと対話するアプリケーションがローカル コンピューター上でネイティブに実行されている場合は、次の接続文字列を使用します。

"Endpoint=sb://localhost;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

• 異なるコンピューターと同じローカル ネットワーク上のアプリケーション (コンテナー化/非コンテナー化) は、そのコンピューターの IPv4 アドレスを使用してエミュレータと対話できます。 次の接続文字列を使用します。

"Endpoint=sb://192.168.y.z;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

• 同じブリッジ ネットワーク上のアプリケーション コンテナーは、そのエイリアスまたは IP を使用してエミュレータと対話できます。 次の接続文字列は、エミュレータの名前が既定値の "eventhubs-emulator" であることを前提としています。

"Endpoint=sb://eventhubs-emulator;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

• 異なるブリッジ ネットワーク上のアプリケーション コンテナーは、ホストとして "host.docker.internal" を使用してエミュレータと対話できます。 次の接続文字列を使用します。

"Endpoint=sb://host.docker.internal;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

Kafka の使用

Kafka との対話中は、プロデューサーとコンシューマーの構成を次のように設定してください。

        {
            BootstrapServers =  //Value of bootstrap servers would depend on kind of connection string being used
            SecurityProtocol = SecurityProtocol.SaslPlaintext,
            SaslMechanism = SaslMechanism.Plain,
            SaslUsername = "$ConnectionString",
            SaslPassword = //Value of connection string would depend on topology
        };

BootstrapServers と SaslPassword の値は、セットアップ トポロジによって異なります。 詳細については、「エミュレータを操作する」セクションを参照してください。

重要

Kafka を使用する場合は、Producer および Consumer API のみが Event Hubs エミュレータと互換性があります。

AMQP の使用

最新のクライアント SDK リリースでは、さまざまなプログラミング言語でエミュレーターを操作することができます。 詳細については、「クライアント SDK」を参照してください。

開始するには、GitHub の Event Hubs エミュレーターのサンプルを参照してください。

関連するコンテンツ

Azure Event Hubs エミュレーターの概要