[Somente PaaS]{class="badge informative" title="Aplica-se somente a projetos do Adobe Commerce na nuvem (infraestrutura do PaaS gerenciada pela Adobe) e a projetos locais."}

Agente de mensagem (AtiveMQ Artemis)

O Adobe Commerce também oferece suporte ao agente de mensagens de código aberto AtiveMQ Artemis por meio do Simple Text Oriented Messaging Protocol (STOMP). Ele oferece um sistema de mensagens confiável e escalável, oferecendo flexibilidade para integrações baseadas em STOMP.

As filas de mensagens fornecem um mecanismo de comunicação assíncrono no qual o remetente e o destinatário de uma mensagem não entram em contato entre si. Eles também não precisam se comunicar com a fila de mensagens ao mesmo tempo. Quando um remetente coloca uma mensagem em uma fila, ela é armazenada até que o destinatário a receba.

O sistema de fila de mensagens deve ser estabelecido antes da instalação do Adobe Commerce. A sequência básica é:

Instalar o Apache AtiveMQ Artemis

Você pode instalar o AtiveMQ Artemis usando Docker (recomendado para desenvolvimento) ou instalação manual (recomendado para produção).

Opção 1: Instalação do Docker (recomendada para desenvolvimento)

Pré-requisitos

Verifique se o Docker está instalado e em execução no sistema.

Etapas de instalação

Comandos de gerenciamento do Docker

# Check container status
docker ps | grep artemis

# View logs
docker logs artemis

# Stop the container
docker stop artemis

# Start the container
docker start artemis

# Remove the container
docker rm artemis

Acesso aos serviços

Depois que o container do Docker estiver em execução, você poderá acessar:

Opção 2: instalação manual no Ubuntu/CentOS

Pré-requisitos

Verifique se o Java 17 ou superior está instalado (necessário para o AtiveMQ Artemis 2.42.0+).

Etapas de instalação

Configurar AtiveMQ Artemis

Consulte a documentação oficial do AtiveMQ Artemis para configurar e gerenciar o broker. Preste atenção aos seguintes itens:

Arquivos de configuração de chave

Habilitar o protocolo STOMP

Verifique /var/lib/artemis-instance/etc/broker.xml para garantir que o aceitador de STOMP esteja configurado:

<acceptors>
   <acceptor name="artemis">tcp://0.0.0.0:61616?tcpSendBufferSize=1048576;tcpReceiveBufferSize=1048576;amqpMinLargeMessageSize=102400;protocols=CORE,AMQP,STOMP,HORNETQ,MQTT,OPENWIRE;useEpoll=true;amqpCredits=1000;amqpLowCredits=300;amqpDuplicateDetection=true</acceptor>
   <acceptor name="stomp">tcp://0.0.0.0:61613?protocols=STOMP</acceptor>
   <acceptor name="stomp-ssl">tcp://0.0.0.0:61617?protocols=STOMP;sslEnabled=true;keyStorePath=/path/to/keystore.jks;keyStorePassword=password</acceptor>
</acceptors>

Para habilitar SSL no STOMP, você deve adicionar explicitamente o aceitador stomp-ssl.

Instale com o AtiveMQ Artemis e conecte

Se você instalar o Adobe Commerce depois de instalar o AtiveMQ Artemis, adicione os seguintes parâmetros de linha de comando durante a instalação:

--stomp-host="<hostname>" --stomp-port="61613" --stomp-user="<user_name>" --stomp-password="<password>"

Onde:

Conectar AtiveMQ Artemis

Se você já tiver uma instância do Adobe Commerce com configuração RabbitMQ (AMQP) no arquivo <install_directory>/app/etc/env.php e quiser conectá-la ao AtiveMQ, substitua a seção queue pelo STOMP para que seja semelhante ao seguinte:

'queue' =>
  array (
    'stomp' =>
    array (
      'host' => 'activemq.example.com',
      'port' => '61613',  // SSL STOMP port (default 61617, non-SSL is 61613)
      'user' => 'magento',
      'password' => 'magento',
      // Performance tuning options
      'heartbeat_send' => 10000,     // 10 seconds // Optional
      'heartbeat_receive' => 10000,  // 10 seconds // Optional
      'read_timeout' => 250000       // 250ms // Optional
     ),
  ),

Você também pode definir valores de configuração do AtiveMQ usando o comando bin/magento setup:config:set (remova a configuração AMQP se ela existir no arquivo app/etc/env.php):

bin/magento setup:config:set --stomp-host="activemq.example.com" --stomp-port="61613" --stomp-user="magento" --stomp-password="magento"

Após executar o comando ou atualizar o arquivo <install_directory>/app/etc/env.php com valores de configuração STOMP, execute bin/magento setup:upgrade para aplicar as alterações e criar as filas necessárias no AtiveMQ.

Configurar SSL

Para configurar o suporte para SSL, edite os parâmetros ssl e ssl_options no arquivo <install_directory>/app/etc/env.php para que sejam semelhantes ao seguinte:

'queue' =>
  array (
    'stomp' =>
    array (
      'host' => 'activemq.example.com',
      'port' => '61617',  // SSL STOMP port (default 61617, non-SSL is 61613)
      'user' => 'magento',
      'password' => 'magento',
      'ssl' => 'true',
      'ssl_options' => [
            'cafile' => '/etc/pki/tls/certs/DigiCertCA.crt',
            'local_cert' => '/path/to/magento/app/etc/ssl/test-activemq.crt', // Optional: Client certificate for mutual SSL
            'local_pk' => '/path/to/magento/app/etc/ssl/test-activemq.key', // Optional: Client private key for mutual SSL
            'passphrase' => 'client_key_password', // Optional: Passphrase for client private key
            'verify_peer' => true,
            'verify_peer_name' => true,
            'allow_self_signed' => false
       ],
      // Performance tuning options
      'heartbeat_send' => 10000,     // 10 seconds // Optional
      'heartbeat_receive' => 10000,  // 10 seconds // Optional
      'read_timeout' => 250000       // 250ms // Optional
     ),
  ),

Opções de configuração do SSL

Configuração do SSL de desenvolvimento

Para ambientes de desenvolvimento, é possível usar configurações SSL relaxadas:

'ssl_options' => [
    'verify_peer' => false,
    'verify_peer_name' => false,
    'allow_self_signed' => true
]

Ajuste de desempenho

O AtiveMQ Artemis oferece várias opções de ajuste de desempenho:

'queue' =>
  array (
    'stomp' =>
    array (
      'host' => 'activemq.example.com',
      'port' => '61613',
      'user' => 'artemis',
      'password' => 'artemis',
      // Performance options
      'heartbeat_send' => 10000,      // Send heartbeat every 10 seconds
      'heartbeat_receive' => 10000,   // Expect heartbeat every 10 seconds
      'read_timeout' => 250000,       // 250ms read timeout
     ),
  ),

Monitoramento e gerenciamento

Console da Web

O AtiveMQ Artemis fornece um console de gerenciamento baseado na Web acessível em:

Solução de problemas

Problemas comuns

Verificar conexão STOMP

Testar conexão STOMP usando telnet:

telnet localhost 61613

Você deve ver uma conexão estabelecida. Para testar com um comando STOMP:

# Test basic STOMP connection
echo -e "CONNECT\nhost:localhost\n\n\x00" | telnet localhost 61613

A saída esperada deve mostrar a conexão estabelecida e a resposta do protocolo STOMP.

Iniciar os consumidores da fila de mensagens

Depois de conectar o Adobe Commerce e o AtiveMQ Artemis, você deve iniciar os consumidores da fila de mensagens. Consulte Configurar filas de mensagens para obter detalhes.