Skip to content

feat: fallback actions #2835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions en_US/data-integration/azure-blob-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,8 @@ This section demonstrates how to create a rule in EMQX to process messages from

::::

10. **Fallback Actions (Optional)**: If you want to improve reliability in case of message delivery failure, you can define one or more fallback actions. These actions will be triggered if the primary Sink fails to process a message. See [Fallback Actions](./data-bridges.md#fallback-actions) for more details.

11. Expand **Advanced Settings** and configure the advanced setting options as needed (optional). For more details, refer to [Advanced Settings](#advanced-settings).

12. Use the default values for the remaining settings. Click the **Create** button to complete the Sink creation. After successful creation, the page will return to the rule creation, and the new Sink will be added to the rule actions.
Expand Down
8 changes: 5 additions & 3 deletions en_US/data-integration/confluent-sink.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,11 +227,13 @@ This section demonstrates how to create a rule in EMQX to process messages from
- **Partition Strategy**: Select how the producer distributes messages to Kafka partitions.
- **Compression**: Specify whether to use compression algorithms to compress/decompress records in Kafka messages.

9. Advanced Settings (Optional): Refer to [Advanced Configuration](#advanced-configuration).
9. **Fallback Actions (Optional)**: If you want to improve reliability in case of message delivery failure, you can define one or more fallback actions. These actions will be triggered if the primary Sink fails to process a message. See [Fallback Actions](./data-bridges.md#fallback-actions) for more details.

10. Click the **Create** button to complete the creation of the Sink. Once created, the page will return to **Create Rule**, and the new Sink will be added to the rule actions.
10. **Advanced Settings (Optional)**: Refer to [Advanced Configuration](#advanced-configuration).

11. Click the **Create** button to complete the entire rule creation.
11. Click the **Create** button to complete the creation of the Sink. Once created, the page will return to **Create Rule**, and the new Sink will be added to the rule actions.

12. Click the **Create** button to complete the entire rule creation.

Now you have successfully created the rule, and you can see the newly created rule on the **Integration** -> **Rules** page, as well as the newly created Confluent Producer Sink on the **Actions(Sink)** tab.

Expand Down
10 changes: 6 additions & 4 deletions en_US/data-integration/data-bridge-azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,14 @@ This section demonstrates how to create a rule with an Azure Event Hubs Sink add
- `random`: Randomly pick a partition for each message.
- `key_dispatch`: Hash Azure Event Hubs message key to a partition number.
- **Partitions Limit**: Limits the maximum number of partitions to which a producer can send messages. It is disabled by default, which means the producer can send messages to all partitions.

9. Advanced settings (optional): Choose whether to use **sync** or **async** query mode as needed. For details, see [Features of Sink](./data-bridges.md#features-of-sink).

10. Click the **Create** button to complete the Sink configuration. Back on the **Create Rule** page, you will see the new Sink appear under the **Action Outputs** tab.
9. **Fallback Actions (Optional)**: If you want to improve reliability in case of message delivery failure, you can define one or more fallback actions. These actions will be triggered if the primary Sink fails to process a message. See [Fallback Actions](./data-bridges.md#fallback-actions) for more details.

11. On the **Create Rule** page, verify the configured information and click the **Create** button to generate the rule. The rule you created is shown in the rule list.
10. **Advanced settings (optional)**: Choose whether to use **sync** or **async** query mode as needed. For details, see [Features of Sink](./data-bridges.md#features-of-sink).

11. Click the **Create** button to complete the Sink configuration. Back on the **Create Rule** page, you will see the new Sink appear under the **Action Outputs** tab.

12. On the **Create Rule** page, verify the configured information and click the **Create** button to generate the rule. The rule you created is shown in the rule list.

Now you have successfully created the rule and you can see the new rule appear on the **Rule** page. Click the **Actions(Sink)** tab, you see the new Azure Event Hubs Sink.

Expand Down
8 changes: 5 additions & 3 deletions en_US/data-integration/data-bridge-cassa.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,11 +132,13 @@ This section demonstrates how to create a rule in the Dashboard for processing m
insert into mqtt_msg(msgid, topic, qos, payload, arrived) values (${id}, ${topic}, ${qos}, ${payload}, ${timestamp})
```

9. Advanced settings (optional): Choose whether to use **sync** or **async** query mode as needed. For details, see [Features of Sink](./data-bridges.md#features-of-sink).
9. **Fallback Actions (Optional)**: If you want to improve reliability in case of message delivery failure, you can define one or more fallback actions. These actions will be triggered if the primary Sink fails to process a message. See [Fallback Actions](./data-bridges.md#fallback-actions) for more details.

10. Click the **Create** button to complete the Sink configuration. Back on the **Create Rule** page, you will see the new Sink appear under the **Action Outputs** tab.
10. **Advanced settings (optional)**: Choose whether to use **sync** or **async** query mode as needed. For details, see [Features of Sink](./data-bridges.md#features-of-sink).

11. On the **Create Rule** page, verify the configured information and click the **Create** button to generate the rule. The rule you created is shown in the rule list and the **status** should be connected.
11. Click the **Create** button to complete the Sink configuration. Back on the **Create Rule** page, you will see the new Sink appear under the **Action Outputs** tab.

12. On the **Create Rule** page, verify the configured information and click the **Create** button to generate the rule. The rule you created is shown in the rule list and the **status** should be connected.


Now you have successfully created the rule and you can see the new rule appear on the **Rule** page. Click the **Actions(Sink)** tab, you see the new Cassandra Sink.
Expand Down
10 changes: 6 additions & 4 deletions en_US/data-integration/data-bridge-clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,13 +151,15 @@ This section demonstrates how to create a rule in Dashboard for processing messa

:::

11. Advanced settings (optional): See [Advanced Configurations](#advanced-configurations).
11. **Fallback Actions (Optional)**: If you want to improve reliability in case of message delivery failure, you can define one or more fallback actions. These actions will be triggered if the primary Sink fails to process a message. See [Fallback Actions](./data-bridges.md#fallback-actions) for more details.

12. Before clicking **Create**, you can click the **Test Connectivity** button to ensure that you can connect to the ClickHouse server.
12. **Advanced settings (optional)**: See [Advanced Configurations](#advanced-configurations).

13. Click the **Create** button to complete the Sink configuration. Back on the **Create Rule** page, you will see the new Sink appear under the **Action Outputs** tab.
13. Before clicking **Create**, you can click the **Test Connectivity** button to ensure that you can connect to the ClickHouse server.

14. On the **Create Rule** page, verify the configured information and click the **Create** button to generate the rule. The rule you created is shown in the rule list and the **status** should be connected.
14. Click the **Create** button to complete the Sink configuration. Back on the **Create Rule** page, you will see the new Sink appear under the **Action Outputs** tab.

15. On the **Create Rule** page, verify the configured information and click the **Create** button to generate the rule. The rule you created is shown in the rule list and the **status** should be connected.


Now you have successfully created the rule and you can see the new rule appear on the **Rule** page. Click the **Actions(Sink)** tab, you see the new ClickHouse Sink.
Expand Down
6 changes: 4 additions & 2 deletions en_US/data-integration/data-bridge-couchbase.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,11 @@ This section demonstrates how to create a rule in Dashboard for processing messa

Here, `${.id}` and `${.payload}` represent the MQTT message id and payload, respectively. EMQX will replace them with the corresponding content before forwarding the message.

10. Advanced settings (optional): See [Advanced Configurations](#advanced-configurations).
10. **Fallback Actions (Optional)**: If you want to improve reliability in case of message delivery failure, you can define one or more fallback actions. These actions will be triggered if the primary Sink fails to process a message. See [Fallback Actions](./data-bridges.md#fallback-actions) for more details.

11. Before clicking **Create**, you can click the **Test Connectivity** button to ensure that you can connect to the Couchbase server.
11. **Advanced settings (optional)**: See [Advanced Configurations](#advanced-configurations).

12. Before clicking **Create**, you can click the **Test Connectivity** button to ensure that you can connect to the Couchbase server.

13. Click the **Create** button to complete the Sink configuration. Back on the **Create Rule** page, you will see the new Sink appear under the **Action Outputs** tab.

Expand Down
12 changes: 7 additions & 5 deletions en_US/data-integration/data-bridge-datalayers.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ This section demonstrates how to create a rule in EMQX to process messages from
FROM
"t/#"
```

::: tip

If you are new to SQL, you can click **SQL Examples** and **Enable Debug** to learn and test the results of the rule SQL.
Expand Down Expand Up @@ -157,13 +157,15 @@ This section demonstrates how to create a rule in EMQX to process messages from
devices,clientid=${clientid} temp=${payload.temp},hum=${payload.hum},precip=${payload.precip}i ${timestamp}
```

11. Expand **Advanced Settings** and configure advanced options as needed (optional). For more details, refer to [Advanced Settings](#advanced-settings).
11. **Fallback Actions (Optional)**: If you want to improve reliability in case of message delivery failure, you can define one or more fallback actions. These actions will be triggered if the primary Sink fails to process a message. See [Fallback Actions](./data-bridges.md#fallback-actions) for more details.

12. Expand **Advanced Settings** and configure advanced options as needed (optional). For more details, refer to [Advanced Settings](#advanced-settings).

12. Before clicking **Create**, you can click **Test Connectivity** to test if the Sink can connect to the Datalayers server.
13. Before clicking **Create**, you can click **Test Connectivity** to test if the Sink can connect to the Datalayers server.

13. Click **Create** to complete the Sink creation. Back on the **Create Rule** page, you will see the new Sink under the **Action Outputs** tab.
14. Click **Create** to complete the Sink creation. Back on the **Create Rule** page, you will see the new Sink under the **Action Outputs** tab.

14. On the **Create Rule** page, verify the configured information. Click the **Create** button to generate the rule.
15. On the **Create Rule** page, verify the configured information. Click the **Create** button to generate the rule.

Now you have successfully created the rule. You can see the new rule on the **Rules** page. Click the **Actions (Sink)** tab to see the new Datalayers Sink.

Expand Down
10 changes: 6 additions & 4 deletions en_US/data-integration/data-bridge-dynamo.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,13 +209,15 @@ This section demonstrates how to create a rule in the Dashboard for processing m

:::

9. Advanced settings (optional): Choose whether to use **sync** or **async** query mode as needed. For details, see [Features of Sink](./data-bridges.md#features-of-sink).
9. **Fallback Actions (Optional)**: If you want to improve reliability in case of message delivery failure, you can define one or more fallback actions. These actions will be triggered if the primary Sink fails to process a message. See [Fallback Actions](./data-bridges.md#fallback-actions) for more details.

10. Before clicking **Create**, you can click **Test Connectivity** to test that the Sink can be connected to the server.
10. **Advanced settings (optional)**: Choose whether to use **sync** or **async** query mode as needed. For details, see [Features of Sink](./data-bridges.md#features-of-sink).

11. Click the **Create** button to complete the Sink configuration. A new Sink will be added to the **Action Outputs.**
11. Before clicking **Create**, you can click **Test Connectivity** to test that the Sink can be connected to the server.

12. Back on the **Create Rule** page, verify the configured information. Click the **Create** button to generate the rule.
12. Click the **Create** button to complete the Sink configuration. A new Sink will be added to the **Action Outputs.**

13. Back on the **Create Rule** page, verify the configured information. Click the **Create** button to generate the rule.

You have now successfully created the rule for forwarding data through the DynamoDB Sink. You can see the newly created rule on the **Integration** -> **Rules** page. Click the **Actions(Sink)** tab and you can see the new DynamoDB Sink.

Expand Down
10 changes: 6 additions & 4 deletions en_US/data-integration/data-bridge-gcp-pubsub.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,13 +148,15 @@ This section demonstrates how to create a rule to specify the data to be saved i
- For **Attributes**, both keys and values may use placeholders of the form `${variable_name}`. Such values will be extracted from the MQTT context. If a key template resolves to an empty string, that key is omitted from the outgoing message to GCP Pub/Sub.
- For **Ordering Key**, placeholders of the form `${variable_name}` may be used. If the resolved value is an empty string, the `orderingKey` field will not be set for the GCP Pub/Sub outgoing message.

12. Advanced settings (optional): For details, see [Features of Sink](./data-bridges.md#features-of-sink).
12. **Fallback Actions (Optional)**: If you want to improve reliability in case of message delivery failure, you can define one or more fallback actions. These actions will be triggered if the primary Sink fails to process a message. See [Fallback Actions](./data-bridges.md#fallback-actions) for more details.

13. Before clicking **Create**, you can click **Test Connectivity** to test that the Connector can connect to the GCP Pub/Sub server.
13. **Advanced settings (optional)**: For details, see [Features of Sink](./data-bridges.md#features-of-sink).

14. Click the **Create** button to complete the Sink configuration and you will see the new Sink appear under the **Action Outputs** tab.
14. Before clicking **Create**, you can click **Test Connectivity** to test that the Connector can connect to the GCP Pub/Sub server.

15. Back on the **Create Rule** page, click **Create** to create the rule.
15. Click the **Create** button to complete the Sink configuration and you will see the new Sink appear under the **Action Outputs** tab.

16. Back on the **Create Rule** page, click **Create** to create the rule.

You have now successfully created the rule. You can see the newly created rule on the **Integration** -> **Rules** page. Click the **Actions(Sink)** tab and you can see the new Google PubSub Producer Sink.

Expand Down
10 changes: 6 additions & 4 deletions en_US/data-integration/data-bridge-greptimedb.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,13 +131,15 @@ This section demonstrates how to create a rule in EMQX to process messages from

9. Specify the **Time Precision**: Select `millisecond` by default.

10. Advanced settings (optional): Choose whether to use **sync** or **async** query mode, and whether to enable queue or batch. For details, see [Features of Sink](./data-bridges.md#features-of-sink).
10. **Fallback Actions (Optional)**: If you want to improve reliability in case of message delivery failure, you can define one or more fallback actions. These actions will be triggered if the primary Sink fails to process a message. See [Fallback Actions](./data-bridges.md#fallback-actions) for more details.

11. Before clicking **Create**, you can click **Test Connectivity** to test that the Sink can be connected to the GreptimeDB server.
11. **Advanced settings (optional)**: Choose whether to use **sync** or **async** query mode, and whether to enable queue or batch. For details, see [Features of Sink](./data-bridges.md#features-of-sink).

12. Click the **Create** button to complete the Sink configuration. A new Sink will be added to the **Action Outputs.**
12. Before clicking **Create**, you can click **Test Connectivity** to test that the Sink can be connected to the GreptimeDB server.

13. Back on the **Create Rule** page, verify the configured information. Click the **Create** button to generate the rule.
13. Click the **Create** button to complete the Sink configuration. A new Sink will be added to the **Action Outputs.**

14. Back on the **Create Rule** page, verify the configured information. Click the **Create** button to generate the rule.

You have now successfully created the rule for forwarding data through the GreptimeDB Sink. You can see the newly created rule on the **Integration** -> **Rules** page. Click the **Actions(Sink)** tab and you can see the new GreptimeDB Sink.

Expand Down
10 changes: 6 additions & 4 deletions en_US/data-integration/data-bridge-hstreamdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -570,13 +570,15 @@ This section demonstrates how to create a rule in the Dashboard for processing m
{"id": ${id}, "topic": "${topic}", "qos": ${qos}, "payload": "${payload}"}
```

9. Advanced settings (optional): Choose whether to use **sync** or **async** query mode as needed. For details, see [Features of Sink](./data-bridges.md#features-of-sink).
9. **Fallback Actions (Optional)**: If you want to improve reliability in case of message delivery failure, you can define one or more fallback actions. These actions will be triggered if the primary Sink fails to process a message. See [Fallback Actions](./data-bridges.md#fallback-actions) for more details.

10. Before clicking **Create**, you can click **Test Connectivity** to test that the Sink can be connected to the HStreamDB server.
10. **Advanced settings (optional)**: Choose whether to use **sync** or **async** query mode as needed. For details, see [Features of Sink](./data-bridges.md#features-of-sink).

11. Click the **Create** button to complete the Sink configuration. A new Sink will be added to the **Action Outputs.**
11. Before clicking **Create**, you can click **Test Connectivity** to test that the Sink can be connected to the HStreamDB server.

12. Back on the **Create Rule** page, verify the configured information. Click the **Create** button to generate the rule.
12. Click the **Create** button to complete the Sink configuration. A new Sink will be added to the **Action Outputs.**

13. Back on the **Create Rule** page, verify the configured information. Click the **Create** button to generate the rule.

You have now successfully created the rule for forwarding data and recording online/offline status through the HStreamDB Sink. You can see the newly created rule on the **Integration** -> **Rules** page. Click the **Actions(Sink)** tab and you can see the new HStreamDB Sink.

Expand Down
Loading