Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 3.56 KB

messaging-rabbitmq.md

File metadata and controls

64 lines (48 loc) · 3.56 KB
title source_url category version tags description
RabbitMQ message provider
Development
v7.0.0
messaging
cloud
provider
sn7
Details on the RabbitMQ messaging provider for the sensenet platform.

RabbitMQ message provider

RabbitMQ implementation for sending server-to-server messages in sensenet.

In case you work with multiple web servers in a load balanced environment, a centralized search service, or any other distributed component in sensenet, you will need some kind of messaging. The messaging module lets your separate server components communicate with each other.

Please note that this messaging is not about sending notifications to the client - it is intended to send messages to other app domains connecting to the same content repository database (for example cache invalidating messages).

The RabbitMQ implementation targets the widely used RabbitMQ message broker. The advantage of using a service is that you only have to configure a single URL in your config files, the RabbitMQ client (represented by this provider) inside sensenet will automatically connect to the service and will send and receive messages to and from all other components that are connected to the same service on the same exchange (see below).

Please note that using a service to publish messages may introduce a network latency to the system. This is why this component is designed to be used in conjunction with a central search service (as opposed to a local index) that removes the necessity of sending huge index files through the wire when a content item (e.g. a document) gets indexed.

Installation

To get started, install the following NuGet package:

NuGet

This is a dll-ony package, not a full sensenet component, so you only have to install the package above in Visual Studio and configure your instance.

Configuration (LEGACY)

This section is about the legacy .Net Framework web.config configuration. Please note that this is not supported in .Net Core, please use the new configuration method described in the new docs.

Messaging provider

You have to tell sensenet that you intend to use this library as the message provider. You'll do this by defining the cluster channel provider in web.config (or any other .Net config file you have):

<sensenet>
   <providers>
      <add key="ClusterChannelProvider" value="SenseNet.Messaging.RabbitMQ.RabbitMQMessageProvider" />
   </providers>
</sensenet>

Service url

This is a simple service url that contains the RabbitMQ URI to connect to.

<sensenet>
   <rabbitmq>
      <add key="ServiceUrl" value="amqp://abcd.rmq.example.com/efgh" />
   </rabbitmq>
</sensenet>

Exchange name

In case you want tu use the same RabbitMQ service for multiple sensenet instances (e.g. in a test and staging environment), you need to provide a unique exchange name for each instance. Please make sure you use the same exchange name in every app domain that uses the same Content Repository and need to communicate with each other.

The default value is snmessaging. This can be configured using the following key:

<sensenet>
   <rabbitmq>
      <add key="MessageExchange" value="snexample-staging" />
   </rabbitmq>
</sensenet>