Configuring Dynamic Message Routing Export Filters

A Dynamic Message Routing (DMR) export filter is a per-Message VPN configuration that restricts which local subscriptions are advertised to other clusters over a gateway node's external links. Export filters give you policy-based control over subscription export at the cluster boundary, which is useful for the following scenarios:

  • protecting wide area network (WAN) bandwidth from heavy traffic attracted by broad local subscriptions

  • preventing subscriptions from one environment (such as a development cluster) from leaking back into another (such as production)

  • meeting data-residency and compliance requirements by blocking specific subscriptions from being exported from clusters in a given region.

Export filters apply only to external links (between gateway nodes in different clusters). They have no effect on subscription propagation over internal links within a cluster, which you control using subscription ACLs and #noexport.

A single export filter set applies to all of a Message VPN's external links. You cannot configure a separate export filter for an individual DMR bridge.

For more information, see:

For more information about DMR, see Understanding Event Meshes and Mesh Manager and Dynamic Message Routing. For information about subscription syntax, see SMF Topics. You can also configure DMR export filters using the CLI.

Export Filter Entries

Each DMR export filter is a subscription pattern that uses standard SMF topic syntax, which can include the single-level wildcard (*) and the multi-level wildcard (>). Each export filter is one of the following types:

  • Allow filter: A subscription pattern that is allowed to be exported.

  • Exclude filter: A subscription pattern that is not allowed to be exported, identified by a leading ! (for example, !orders/uk/>).

When you add the first allow filter to a Message VPN, the Message VPN switches from export-all mode to allow-list mode. In allow-list mode, internal traffic from other clusters, such as replies to requests and messages to temporary queues, are no longer exported unless you explicitly allow it.

The event broker uses the following covering subscriptions to attract traffic addressed to nodes in the local cluster. When you configure allow filters, you must add filters for the covering subscriptions that correspond to the traffic types you need from remote clusters:

Covering Subscription

Traffic from Remote Clusters

#P2P/v:*/>

Replies to request/reply reply-to inboxes

#P2P/QTMP/v:*/>

Messages to temporary queues

#P2P/TTMP/v:*/>

Messages to temporary topic endpoints

#SEMP/v:*/>

SEMP management requests over the message bus

#MCAST/>

Multicast delivery on #MCAST topics

In the covering subscriptions, v:* matches every node's router name, so one filter per pattern covers every node in the gateway's DMR cluster.

The export behavior for a Message VPN depends on which types of filters you have configured:

Behavior

Allow Filters?

Exclude Filters?

Description

Export-all

No

No

All subscriptions are exported to other clusters (unless blocked by a client using #noexport).

Export-all with exclusions

No

Yes

All subscriptions are exported, except those matching an exclude filter (or blocked by a client using #noexport).

Allow-list

Yes

Optional

Only subscriptions that match an allow filter are exported. If exclude filters are also configured, subscriptions matching an exclude filter are blocked regardless of allow filters.

Evaluation Rules for Export Filters

#noexport subscriptions always take precedence over export filters and work independently of them. For more information, see Preventing Subscription Export.

To decide whether to export a subscription over an external link, the event broker evaluates that subscription against the Message VPN's export filters:

  • An allow filter matches a subscription only if the filter's topic is as broad as, or broader than, the subscription. For example, an allow filter of orders/> matches a subscription of orders/uk/confirmed, but an allow filter of orders/uk/> does not match a broader subscription of orders/>. To allow a broad subscription such as > to be exported, you must configure an equally broad allow filter.

  • An exclude filter matches (and blocks) a subscription if there is any overlap at all between the filter's topic and the subscription's topic, even if neither is broader than the other.

  • If a subscription matches both an allow filter and an exclude filter, the exclude filter takes precedence and the subscription is not exported.

The following table illustrates some examples of the interactions between filters and subscriptions.

Filter

Subscription

Exported?

orders/>

orders/uk/confirmed

Yes. The allow filter is broader than the subscription.

orders/uk/>

orders/>

No. The subscription is broader than the allow filter.

!orders/uk/>

orders/>

No. The two topics overlap, so the exclude filter blocks export.

Export filters are written in SMF topic syntax, but also apply to MQTT clients' subscriptions. Each protocol's wildcards are matched using that protocol's own semantics.

Export filter changes take effect without a restart or reload.

Export Filter Limits and Restrictions

You can configure up to 1,000 export filters per event broker, shared across all Message VPNs on that event broker.

The event broker rejects an export filter when you try to create it in either of the following cases:

  • It begins with #noexport/, #share/, #RETAIN/, or #RETAIN_MSG/.

  • It is narrower than one of the event broker's internal covering subscriptions: #P2P/v:*/>, #P2P/QTMP/v:*/>, #P2P/TTMP/v:*/>, #SEMP/v:*/>, and #MCAST/>. For example, #P2P/v:R1/> and #MCAST/orders are rejected.

Filters like these cannot express a meaningful export policy. For more information, see Reserved Topics.

Shared subscriptions are evaluated by their topic filter alone, without the #share/<group>/ prefix. This is why filters beginning with #share/ are rejected.

An export filter cannot be modified after it is created. To change a filter, delete it and create a new one with the updated pattern.

Viewing DMR Export Filters

Export filters only apply when DMR is enabled for the Message VPN.

To access DMR export filters for a Message VPN, perform these steps:

  1. Open Broker Manager. For instructions, see Using Broker Manager with Event Broker Services.

  2. Select the DMR tab.

    The DMR tab opens on the Export Filters page, which displays a list of configured DMR export filters. If the list of DMR export filters is long, you can use the Search by pattern field to search for specific filters.

    The Dynamic Message Routing toggle at the top of the page shows whether DMR is enabled for the Message VPN. For more information, see Enabling DMR for a Message VPN from Broker Manager.

Enabling DMR for a Message VPN from Broker Manager

The Export Filters page features a DMR toggle that shows if DMR is enabled for the Message VPN you are viewing. You can use this toggle to enable or disable DMR. To enable DMR, perform these steps:

  1. Open Broker Manager. For instructions, see Using Broker Manager with Event Broker Services.

  2. Select the DMR tab.

  3. Click Edit.

  4. Switch the Dynamic Message Routing toggle to enable DMR for the Message VPN.

  5. Click Apply.

Creating DMR Export Filters

  • Subscription patterns use standard event broker subscription syntax, including wildcards. For example:

    • orders/> — Matches the orders/ subscription, and all sub-topics

    • orders/*/confirmed — Matches any single level between orders/ and /confirmed

  • Creating export filters using Broker Manager requires the following permissions:

    • Event broker service users in Solace Cloud requires the Mission Control Manager role.

    • Software event brokers and appliance event brokers users require VPN read/write permissions.

You can create DMR export filters to allow or exclude specific subscription patterns from being exported. You can create multiple DMR export filters, with each pattern becoming its own filter entry. The DMR export filters you create are applied immediately. To create DMR export filters, perform these steps:

  1. Open Broker Manager. For instructions, see Using Broker Manager with Event Broker Services.

  2. Select the DMR tab.

  3. On the Export Filters page, click + Filter.

  4. In the Create Filter dialog, enter a subscription pattern.

    • To create an allow filter, enter the subscription pattern (for example, orders/>).

    • To create an exclude filter, prefix the pattern with ! (for example, !orders/uk/>).

  5. (Optional) To add another filter, press Enter on the keyboard and enter another subscription pattern.

  6. Click Create.

DMR Export Filter Validation

When creating an export filter, Broker Manager validates the subscription pattern. The validation can return the following results:

Validation Description

Invalid syntax

The pattern does not follow valid subscription syntax.

Pattern too long

The pattern exceeds 250 characters.

Duplicate pattern

A filter with the same pattern already exists.

Leading/trailing whitespace

The pattern contains leading or trailing whitespace, which will be trimmed. This is a warning, not a blocking error.

Reserved pattern

The pattern is reserved and is rejected. For more information, see Export Filter Limits and Restrictions.

Deleting a DMR Export Filter

If you delete the only allow filter, the Message VPN returns to export-all behavior. All subscriptions will be exported (unless blocked by an exclude filter or by a client using #noexport).

Deleting export filters using Broker Manager requires the following permissions: .

  • Event broker service users in Solace Cloud requires the Mission Control Manager role.

  • Software event brokers and appliance event brokers users require VPN read/write permissions.

To delete a DMR export filter, perform these steps:

  1. Open Broker Manager. For instructions, see Using Broker Manager with Event Broker Services.

  2. Select the DMR tab.

  3. On the Export Filters page, right-click on the filter you want to delete, and click Delete.

  4. In the Confirm dialog, click OK.

Feature Interactions

Export filters are independent of, and compatible with, #noexport subscriptions and Message VPN bridges. You do not need to remove or change either when you start using export filters.

You can use export filters to run a Message VPN bridge in parallel with a DMR external link between the same clusters. Configure an exclude filter to stop a topic space from being exported over the external link, and then configure a parallel Message VPN bridge that subscribes to that same topic space. Messages in that space flow over the bridge only, giving high-value traffic a dedicated link while everything else uses DMR's interest-based routing.