emqx/apps/emqx_modules
Ilya Averyanov 90fd2b26d3 feat(banned): allow ban by clientid/username regexps, peerhost cidrs 2024-02-10 17:59:22 +03:00
..
etc feat: generate a minimized emqx.conf 2022-05-31 19:20:27 +08:00
include refactor: move telemetry to its own app 2023-05-08 15:16:27 +02:00
src feat: upgrade erlfmt to support maybe syntax 2024-01-31 20:06:49 +08:00
test feat(banned): allow ban by clientid/username regexps, peerhost cidrs 2024-02-10 17:59:22 +03:00
README.md docs: add emqx_telemetry README 2023-05-08 15:16:27 +02:00
rebar.config refactor: move emqx_json to emqx_utils_json 2023-04-14 13:31:27 +02:00

README.md

EMQX Modules

The application provides some minor functional modules that are not included in the MQTT protocol standard, including "Delayed Publish", "Topic Rewrite", "Topic Metrics".

Delayed Publish

After enabling this module, messages sent by the clients with the topic prefixed with $delayed/{Interval}/{Topic} will be delayed by {Interval} seconds before being published to the {Topic}.

More introduction about Delayed Publish.

See Enabling/Disabling Delayed Publish via HTTP API.

Topic Rewrite

Topic Rewrite allows users to configure rules to change the topic strings that the client requests to subscribe or publish.

This feature is very useful when there's a need to transform between different topic structures. For example, an old device that has already been issued and cannot be upgraded may use old topic designs, but for some reason, we adjusted the format of topics. We can use this feature to rewrite the old topics as the new format to eliminate these differences.

More introduction about Topic Rewrite.

See List all rewrite rules and Create or Update rewrite rules.

Topic Metrics

Topic Metrics is used for users to specify monitoring of certain topics and to count the number of messages, QoS distribution, and rate for all messages on that topic.

More introduction about Topic Metrics.

See HTTP API docs to List all monitored topics, Create topic metrics and Get the monitored result.