Skip to main content
Version: 1.16

Subscribe to requests from rs-worker-manager

Introduction

This section describes how workers must subscribe to submission request events sent by the rs-worker-manager microservice as described in the publish guide.

Requests and responses are linked with a correlation identifier : requestId that is provided in submission requests and added in service responses.

RabbitMQ timeout

Keep in mind the default RabbitMQ timeout is configured to 30 mins. If your worker can take more than 30min to process a request (or a bulk), you should override the RabbitMQ consumer timeout.

Regards AMQP api

The Regards AMQP API concept describe how AMQP interfaces must be handled to submit events or to subscribe to events.

Exchange

Requests must be published to REGARDS Rabbitmq exchange:

Exchange (type topic)Virtual host
regards.worker.<worker type>.requestregards.multitenant.manager

The exchange name is built for each worker with the worker type parameter.

Queue

Every consumer of this exchange must create its own queue bound to this exchange.

Worker context

In the context of Workers, all workers of the same type should share the same queue, as the goal is to have a single queue that stores all the messages.
Workers can then pull from this queue to retrieve the requests that need to be processed.

AMQP message format

Headers

ParameterTypeDescription
regards.tenantStringTenant name depends on REGARDS instance project configuration.
regards.request.idStringRequest identifier.
regards.request.ownerStringName of the request provider
regards.request.sessionStringName of the session
regards.request.content_typeStringContent type of request (content type accepted by the worker)
Example of the headers of a worker request event message
"regards.tenant": "tenant"
"regards.request.id": "requestId"
"regards.request.owner": "owner"
"regards.request.session": "session"
"regards.request.content_type": "contentType"

Body

The rs-worker-manager has saved the message body in Byte format; it doesn't deserialize it because the body content is not used by the rs-worker-manager but by the worker during processing.

This message body is identical to the message body used when publishing a message to the rs-worker-manager (using AMQP API).