[PaaS uniquement]{class="badge informative" title="S’applique uniquement aux projets Adobe Commerce on Cloud (infrastructure PaaS gérée par Adobe) et aux projets On-premise."}

Courtier en messages (Artéfacts ActiveMQ)

Adobe Commerce prend également en charge le courtier de messages open source ActiveMQ Artemis via le protocole STOMP (Simple Text Oriented Messaging Protocol). Il fournit un système de messagerie fiable et évolutif, offrant une flexibilité pour les intégrations STOMP.

Les files d'attente de messages fournissent un mécanisme de communication asynchrone dans lequel l'expéditeur et le destinataire d'un message ne se contactent pas. Ils n’ont pas non plus besoin de communiquer avec la file d’attente de messages en même temps. Lorsqu'un expéditeur place un message dans une file d'attente, il est stocké jusqu'à ce que le destinataire le reçoive.

Le système de file d’attente des messages doit être établi avant d’installer Adobe Commerce. La séquence de base est la suivante :

Installation des artéfacts Apache ActiveMQ

Vous pouvez installer ActiveMQ Artemis à l’aide de Docker (recommandé pour le développement) ou d’une installation manuelle (recommandée pour la production).

Option 1 : installation de Docker (recommandée pour le développement)

Conditions préalables

Vérifiez que Docker est installé et en cours d’exécution sur votre système.

Etapes d'installation

Commandes de gestion 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

Accès aux services

Une fois le conteneur Docker en cours d’exécution, vous pouvez accéder aux éléments suivants :

Option 2 : installation manuelle sur Ubuntu/CentOS

Conditions préalables

Assurez-vous que Java 17 ou version ultérieure est installé (requis pour ActiveMQ Artemis 2.42.0+).

Etapes d'installation

Configuration des artéfacts ActiveMQ

Consultez la documentation officielle d’ActiveMQ Artemis pour configurer et gérer le courtier. Faites attention aux éléments suivants :

Fichiers de configuration de clé

Activer le protocole STOMP

Vérifiez /var/lib/artemis-instance/etc/broker.xml l'accepteur STOMP est configuré :

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

Pour activer SSL sur STOMP, vous devez ajouter explicitement l'accepteur de stomp-ssl.

Installation avec les artéfacts ActiveMQ et connexion

Si vous installez Adobe Commerce après vous installez ActiveMQ Artemis, ajoutez les paramètres de ligne de commande suivants lors de l’installation :

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

Où :

Connecter les artéfacts ActiveMQ

Si vous disposez déjà d’une instance Adobe Commerce avec la configuration RabbitMQ (AMQP) dans le fichier <install_directory>/app/etc/env.php et que vous souhaitez la connecter à ActiveMQ, remplacez la section queue par le STOMP afin qu’elle soit similaire à ce qui suit :

'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
     ),
  ),

Vous pouvez également définir des valeurs de configuration ActiveMQ à l’aide de la commande bin/magento setup:config:set (supprimez la configuration AMQP si elle existe dans le fichier app/etc/env.php) :

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

Après avoir exécuté la commande ou mis à jour le fichier <install_directory>/app/etc/env.php avec les valeurs de configuration STOMP, exécutez bin/magento setup:upgrade pour appliquer les modifications et créer les files d’attente requises dans ActiveMQ.

Configurer SSL

Pour configurer la prise en charge de SSL, modifiez les paramètres ssl et ssl_options dans le fichier <install_directory>/app/etc/env.php afin qu’ils soient similaires aux paramètres suivants :

'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
     ),
  ),

Options de configuration SSL

Configuration SSL de développement

Pour les environnements de développement, vous pouvez utiliser des paramètres SSL assouplis :

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

Réglage des performances

ActiveMQ Artemis offre plusieurs options de réglage des performances :

'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
     ),
  ),

Surveillance et gestion

Console web

ActiveMQ Artemis fournit une console de gestion web accessible à l’adresse suivante :

Dépannage

Problèmes courants

Vérifier la connexion STOMP

Testez la connexion STOMP à l'aide de telnet :

telnet localhost 61613

Une connexion devrait être établie. Pour effectuer un test avec une commande STOMP :

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

La sortie attendue doit afficher la connexion établie et la réponse du protocole STOMP.

Démarrer les consommateurs et consommatrices de file d’attente de messages

Après avoir connecté Adobe Commerce et ActiveMQ Artemis, vous devez démarrer les consommateurs de file d’attente de messages. Voir Configurer les files d’attente de messages pour plus d’informations.