Teste localmente usando o emulador de Hubs de Eventos do Azure

Este artigo resume as etapas para desenvolver e testar localmente usando o emulador de Hubs de Eventos do Azure.

Pré-requisitos

• Área de trabalho do Docker
• Requisitos mínimos de hardware:
  • 2 GB de RAM
  • 5 GB de espaço em disco
• Configuração do Subsistema Windows para Linux (WSL) (apenas para Windows):
  • Instalar o WSL
  • Configurar o Docker para usar WSL

Nota

Antes de continuar com as etapas neste artigo, verifique se o Docker Desktop está operacional em segundo plano.

Execute o emulador

Para executar o emulador de Hubs de Eventos, você pode usar um script automatizado ou um contêiner Linux:

Script automatizado

Antes de executar um script automatizado, clone o repositório do instalador do GitHub do emulador localmente.

Windows

Use as seguintes etapas para executar o emulador de Hubs de Eventos localmente no Windows:

1. Permita a execução de scripts não assinados executando este comando na janela do PowerShell:

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

2. Execute o script de instalação LaunchEmulator.ps1. A execução do script traz dois contêineres: o emulador de Hubs de Eventos e o Azurite (uma dependência para o emulador).

Linux e macOS

Para executar o emulador de Hubs de Eventos localmente no Linux ou macOS:

• Execute o script de instalação LaunchEmulator.sh. A execução do script traz dois contêineres: o emulador de Hubs de Eventos e o Azurite (uma dependência para o emulador).

Docker (contêiner Linux)

1. Para iniciar o emulador, forneça uma configuração para as entidades que você deseja usar. Salve o seguinte arquivo JSON localmente como config.json:

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

2. Para girar contêineres para o emulador de Hubs de Eventos, salve o seguinte arquivo .yaml como 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. Crie um arquivo .env para declarar as variáveis de ambiente para o emulador de Hubs de Eventos:

   # 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"
   
   

   O argumento ACCEPT_EULA confirma os Termos de Licença para Software Microsoft. Certifique-se de colocar o arquivo .env no mesmo diretório que o arquivo docker-compose.yaml .

   Importante

   Ao especificar caminhos de arquivo no Windows, use barras invertidas duplas (\\) em vez de barras invertidas únicas (\) para evitar confusão com caracteres de escape.

4. Para executar o emulador, execute o seguinte comando:

    docker compose -f <PathToDockerComposeFile> up -d
   

Depois que as etapas forem bem-sucedidas, você poderá encontrar os contêineres em execução no Docker.

Interaja com o emulador

Por padrão, o emulador usa config.json arquivo de configuração. Você pode configurar entidades (tópicos de Hubs de Eventos/ Kafka) fazendo alterações no arquivo de configuração. Para saber mais, visite fazer alterações de configuração

Você pode usar a seguinte cadeia de conexão para se conectar ao emulador de Hubs de Eventos:

• Quando o contêiner do emulador e o aplicativo que interage estiverem sendo executados nativamente na máquina local, use a seguinte cadeia de conexão:

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

• Aplicativos (em contêineres/não conteinerizados) na máquina diferente e na mesma rede local podem interagir com o emulador usando o endereço IPv4 da máquina. Use a seguinte cadeia de conexão:

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

• Os contêineres de aplicativos na mesma rede de ponte podem interagir com o emulador usando seu alias ou IP. A sequência de conexão a seguir assume que o nome do emulador tem o valor padrão que é"eventhubs-emulator":

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

• Os contêineres de aplicativos na rede ponte diferente podem interagir com o emulador usando o "host.docker.internal" como host. Use a seguinte cadeia de conexão:

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

Usando Kafka

Ao interagir com Kafka, certifique-se de definir a configuração Produtor e consumidor da seguinte forma:

        {
            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
        };

O valor de BootstrapServers e SaslPassword dependeria da topologia de configuração. Consulte a seção Interagir com emulador para obter detalhes.

Importante

Ao usar o Kafka, apenas as APIs de produtor e consumidor são compatíveis com o emulador de Hubs de Eventos.

Usando AMQP

Com as versões mais recentes do SDK do cliente, você pode interagir com o emulador em várias linguagens de programação. Para obter detalhes, consulte SDKs de cliente.

Para começar, consulte os exemplos de emulador de Hubs de Eventos no GitHub.

Conteúdos relacionados

Visão geral do emulador de Hubs de Eventos do Azure