This version is still in development and is not considered stable yet. For the latest stable version, please use RIOT-X 1.15!

Upgrading to 5.0

Version 5.0 introduces the riot distribution alongside riotx (see Installation). Identifiers that used the riotx name now use riot; only the riotx distribution and its executable keep the riotx name.

Breaking changes

Commands

sync2 is renamed sync, and replicate no longer accepts sync as an alias. Scripts that ran riotx sync (meaning replicate) or riotx sync2 must be updated.

riot distribution

riot now ships only the reactive, Spring-free commands: sync, pubsub, diff (alias compare), gen, stats and ping. Their options differ from the riotx commands of the same name (except sync and pubsub, which are identical). Use riotx for replicate, faker, imports and exports, and JavaScript expressions (--key-proc, --ttl-proc, --channel-proc).

Replication metrics

Metrics are renamed from riotx.replication. to riot.replication.. In Prometheus this means riotx_replication_bytes_total, riotx_replication_lag_seconds and riotx_replication_read_latency_seconds become riot_replication_bytes_total, riot_replication_lag_seconds and riot_replication_read_latency_seconds. Update dashboards and alerts accordingly; the Grafana dashboard shipped with RIOT already uses the new names. The default metrics name changes from RIOTX-<version> to RIOT-<version>.

Stream consumer group

The default consumer group for stream-import changes from riotx-<version> to riot-<version>. The default already changed with every version, so pass --consumer-group to keep reading with an existing group.

Change event source name

The default source name in change events changes from RIOT-X to RIOT.

Migrated automatically

CDC offsets

The default offset key prefix changes from riotx:offset: to riot:offset:, and the default offset hash from metadata:riotx:offsets to metadata:riot:offsets. When the default is used and no offset exists under the new name, the offset stored under the old name is read, so CDC imports resume where they left off. New offsets are written under the new name. --offset-clear removes both. Explicitly configured --offset-prefix or --offset-key values are used as-is.