From 65b1c46a0d8409af916dc1a082c93cb1b022c145 Mon Sep 17 00:00:00 2001 From: Faried Fauzi Date: Mon, 16 Nov 2026 15:49:11 +0100 Subject: [PATCH 1/3] Document CDC publisher tracing spans --- .../integration/change-data-capture/_index.md | 1 + .../refguide/runtime/tracing-in-runtime.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md b/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md index d20f949056b..4a4fdfad9fb 100644 --- a/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md +++ b/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md @@ -103,3 +103,4 @@ For details on setting up a BYOK cluster with the Mendix Event Broker, see [Mend * [Published CDC Services](/refguide/published-cdc-services/) * [Mendix Event Broker](/appstore/services/event-broker/) * [Event Broker Bridges](/appstore/services/event-broker-bridges/) +* [Change Data Capture Spans](/refguide/opentelemetry-in-runtime/#cdc-spans) diff --git a/content/en/docs/refguide/runtime/tracing-in-runtime.md b/content/en/docs/refguide/runtime/tracing-in-runtime.md index 83a6bde158d..836b5b61487 100644 --- a/content/en/docs/refguide/runtime/tracing-in-runtime.md +++ b/content/en/docs/refguide/runtime/tracing-in-runtime.md @@ -36,6 +36,24 @@ The runtime generates spans for the following: * Microflow execution within the runtime, including sub-microflow calls * Microflow loops and loop iterations * Execution of task queue tasks +* Change Data Capture (CDC) publishing + +### Change Data Capture Spans {#cdc-spans} + +Starting with Mendix 11.16.0, [Change Data Capture](/refguide/change-data-capture/) generates the following spans when tracing is enabled: + +| Span | Description | Count Attribute | +| --- | --- | --- | +| `CDC publish change events` | Processes fetched event IDs in batches. The count is the number of IDs fetched for the poll. | `mx.cdc.producer.change_events.count` | +| `CDC process change events` | Processes one batch of loaded change events. The count is the number of events in the batch. | `mx.cdc.producer.change_events.count` | +| `CDC create producer records` | Creates Kafka records for a batch. The record count is set after successful creation. | `mx.cdc.producer.records.count` | +| `CDC publish Kafka records` | Publishes a non-empty batch of records to Kafka. The count is the number of submitted records. | `mx.cdc.producer.records.count` | +| `CDC update snapshot state` | Plans snapshots and updates snapshot state. The count is the number of entities planned for a snapshot. | `mx.cdc.producer.snapshot.entities.count` | + +Record creation and Kafka publishing are nested within batch processing. These spans are not generated for individual change events. +Snapshot updating is a separate operation. Its entity count does not indicate how many snapshots completed. + +These spans are excluded when [Minimal Tracing Mode](#minimal-tracing-mode) is enabled. ## Configuration From 0b98151f59bd1ffe26fd572451df9fd20df7d77f Mon Sep 17 00:00:00 2001 From: Faried Fauzi Date: Mon, 16 Nov 2026 16:07:28 +0100 Subject: [PATCH 2/3] Move CDC tracing details to the CDC guide --- .../integration/change-data-capture/_index.md | 20 ++++++++++++++++++- .../refguide/runtime/tracing-in-runtime.md | 19 +----------------- 2 files changed, 20 insertions(+), 19 deletions(-) diff --git a/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md b/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md index 4a4fdfad9fb..5a9405e43f9 100644 --- a/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md +++ b/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md @@ -98,9 +98,27 @@ To parse messages, the schema for each tracked entity is available as an AsyncAP For details on setting up a BYOK cluster with the Mendix Event Broker, see [Mendix Event Broker](/appstore/services/event-broker/). +## Tracing {#tracing} + +Starting with Mendix 11.16.0, CDC supports OpenTelemetry tracing. +The runtime generates the following spans during CDC publishing and snapshot updates: + +| Span | Description | Count Attribute | +| --- | --- | --- | +| `CDC publish change events` | Processes fetched event IDs in batches. The count is the number of IDs fetched for the poll. | `mx.cdc.producer.change_events.count` | +| `CDC process change events` | Processes one batch of loaded change events. The count is the number of events in the batch. | `mx.cdc.producer.change_events.count` | +| `CDC create producer records` | Creates Kafka records for a batch. The record count is set after successful creation. | `mx.cdc.producer.records.count` | +| `CDC publish Kafka records` | Publishes a non-empty batch of records to Kafka. The count is the number of submitted records. | `mx.cdc.producer.records.count` | +| `CDC update snapshot state` | Plans snapshots and updates snapshot state. The count is the number of entities planned for a snapshot. | `mx.cdc.producer.snapshot.entities.count` | + +Record creation and Kafka publishing are nested within batch processing. These spans are not generated for individual change events. +Snapshot updating is a separate operation. Its entity count does not indicate how many snapshots completed. + +These spans are excluded when [Minimal Tracing Mode](/refguide/opentelemetry-in-runtime/#minimal-tracing-mode) is enabled. + ## Read More * [Published CDC Services](/refguide/published-cdc-services/) * [Mendix Event Broker](/appstore/services/event-broker/) * [Event Broker Bridges](/appstore/services/event-broker-bridges/) -* [Change Data Capture Spans](/refguide/opentelemetry-in-runtime/#cdc-spans) +* [OpenTelemetry](/refguide/opentelemetry-in-runtime/) diff --git a/content/en/docs/refguide/runtime/tracing-in-runtime.md b/content/en/docs/refguide/runtime/tracing-in-runtime.md index 836b5b61487..a41bb67d41e 100644 --- a/content/en/docs/refguide/runtime/tracing-in-runtime.md +++ b/content/en/docs/refguide/runtime/tracing-in-runtime.md @@ -36,24 +36,7 @@ The runtime generates spans for the following: * Microflow execution within the runtime, including sub-microflow calls * Microflow loops and loop iterations * Execution of task queue tasks -* Change Data Capture (CDC) publishing - -### Change Data Capture Spans {#cdc-spans} - -Starting with Mendix 11.16.0, [Change Data Capture](/refguide/change-data-capture/) generates the following spans when tracing is enabled: - -| Span | Description | Count Attribute | -| --- | --- | --- | -| `CDC publish change events` | Processes fetched event IDs in batches. The count is the number of IDs fetched for the poll. | `mx.cdc.producer.change_events.count` | -| `CDC process change events` | Processes one batch of loaded change events. The count is the number of events in the batch. | `mx.cdc.producer.change_events.count` | -| `CDC create producer records` | Creates Kafka records for a batch. The record count is set after successful creation. | `mx.cdc.producer.records.count` | -| `CDC publish Kafka records` | Publishes a non-empty batch of records to Kafka. The count is the number of submitted records. | `mx.cdc.producer.records.count` | -| `CDC update snapshot state` | Plans snapshots and updates snapshot state. The count is the number of entities planned for a snapshot. | `mx.cdc.producer.snapshot.entities.count` | - -Record creation and Kafka publishing are nested within batch processing. These spans are not generated for individual change events. -Snapshot updating is a separate operation. Its entity count does not indicate how many snapshots completed. - -These spans are excluded when [Minimal Tracing Mode](#minimal-tracing-mode) is enabled. +* [Change Data Capture (CDC) publishing](/refguide/change-data-capture/#tracing) ## Configuration From e91aec40b26f27145a6479414eeb034822f6deda Mon Sep 17 00:00:00 2001 From: Quinn Tracy <142489060+quinntracy@users.noreply.github.com> Date: Tue, 17 Nov 2026 14:01:52 +0100 Subject: [PATCH 3/3] Review --- .../modeling/integration/change-data-capture/_index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md b/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md index 5a9405e43f9..cedc8d16aba 100644 --- a/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md +++ b/content/en/docs/refguide/modeling/integration/change-data-capture/_index.md @@ -100,8 +100,7 @@ For details on setting up a BYOK cluster with the Mendix Event Broker, see [Mend ## Tracing {#tracing} -Starting with Mendix 11.16.0, CDC supports OpenTelemetry tracing. -The runtime generates the following spans during CDC publishing and snapshot updates: +As of Studio Pro 11.16.0, CDC supports OpenTelemetry tracing. The runtime generates the following spans during CDC publishing and snapshot updates: | Span | Description | Count Attribute | | --- | --- | --- |