Troubleshooting RabbitMQ in Studio Server

Info: Performing the steps described in this article requires direct server access. Depending upon how your system is hosted and the level of access you have to that system, coordination may be required with your Partner or WoodWing Support team. For a full overview of the steps that need to be done by WoodWing and how to request them, see WoodWing Cloud - Change management.

This article describes some of the steps that can be followed when troubleshooting the RabbitMQ integration in Studio Server.

Enabling logging

To troubleshoot RabbitMQ traffic, enable the LOG_RABBITMQ_SERVICES option in the configserver.php file (recommended: config_overrule.php file) of Studio Server.

// LOG_RABBITMQ_SERVICES:
//    Used for logging RabbitMQ Web services in the service log folder. When enabled, RabbitMQ requests 
//    that are fired by Studio Server to RabbitMQ Server as well as the corresponding responses are logged.
//    Studio Server integrates with RabbitMQ via two protocols:
//    1. REST for administration tasks (such as creating queues, users and permissions).
//    2. AMQP to push messages (events) into the queues.
//    The services (requests and responses) are logged in the server log folder (OUTPUTDIRECTORY) and have a
//    RabbitMQ_ prefix and a .txt file extension.
//   
//    This log feature is disabled by default and can be temporarily enabled for troubleshooting RabbitMQ traffic.
//    Note that clients read messages from RabbitMQ directly, but that traffic is not logged here.
//   
define ('LOG_RABBITMQ_SERVICES', false);

Low level communication errors

To identify low level communication errors, click the Inspect entry in the context menu of the page to open the Developer Tools of the Web browser. When an error exists, it is shown in red text in the Console tab of the Developer Tools.

Below are some of the errors that may appear and how to resolve them.

Scenario 1

Error: 'ws://rabbitmq:15674/ws' failed: Error in connection establishment: net::ERR_CONNECTION_REFUSED

Possible cause: The port 15674 may not be served.

Possible solution: Enable the Stomp plugin:

rabbitmq-plugins enable rabbitmq_web_stomp

For more information, see the RabbitMQ documentation: RabbitMQ Web-Stomp Plugin.

Scenario 2

Possible cause: The Web browser does not allow the Events Monitor to run over SSL (HTTPS) while connecting to RabbitMQ over non-SSL.

Possible solution: Make sure you have an SSL option specified for the MESSAGE_QUEUE_CONNECTIONS option in the configserver.php file (recommended: config_overrule.php file) that has a wss prefix:

new MessageQueueConnection( 'RabbitMQ', 'STOMPWS', 'wss://rabbitmq:15673/ws', true, 'woodwing', 'ww' ),

Alternatively, the Events Monitor could be run over a non-SSL connection. In that case make sure the URL has a http prefix. In this example the URL should start with http://myStudioServer.local.

Scenario 3

Possible cause: The Web browser does not allow to download the Events Monitor from one location while connecting to another location.

Possible solution: Check the MESSAGE_QUEUE_CONNECTIONS setting in the configserver.php file (recommended: config_overrule.php file).

Make sure that the URLs are matching the URL used in the address bar of the Web browser. In this example the URL should start with https://myStudioServer.local.

Scenario 4

Possible cause: You may be running RabbitMQ and Studio Server on the same machine whereby Apache and RabbitMQ are both serving the same port.

Possible solution: Specify the 15673 port for MESSAGE_QUEUE_CONNECTIONS option in configserver.php:

Copy the code

new MessageQueueConnection( 'RabbitMQ', 'STOMPWS','wss://rabbitmq:15673/ws', true, 'woodwing', 'ww' ),

Alternatively, change port 443 into 444 for Apache settings in httpd-ssl.conf:

Listen 444

<VirtualHost _default_:444>

Scenario 5

Error: WebSocket connection to 'wss://myStudioServer.local/ws' failed: Error in connection establishment: net::ERR_CONNECTION_CLOSED

Possible solution: Restart RabbitMQ.