Debezium MongoDB Connector
Since Camel 3.0
Only consumer is supported
The Debezium MongoDB component is wrapper around Debezium using Debezium Engine, which enables Change Data Capture from MongoDB database using Debezium without the need for Kafka or Kafka Connect.
Note: The Debezium MongoDB connector uses MongoDB’s oplog to capture the changes, so the connector works only with MongoDB replica sets or with sharded clusters where each shard is a separate replica set, therefore you will need to have your MongoDB instance running either in replica set mode or sharded clusters mode.
Note on handling failures: Per Debezium Embedded Engine documentation, the engines is actively recording source offsets and periodically flushes these offsets to a persistent storage, so when the application is restarted or crashed, the engine will resume from the last recorded offset. Thus, at normal operation, your downstream routes will receive each event exactly once, however in case of an application crash (not having a graceful shutdown), the application will resume from the last recorded offset, which may result in receiving duplicate events immediately after the restart. Therefore, your downstream routes should be tolerant enough of such case and deduplicate events if needed.
Maven users will need to add the following dependency to their pom.xml for this component.
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-debezium-mongodb</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>Configuring Options
Camel components are configured on two separate levels:
-
component level
-
endpoint level
Configuring Component Options
The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.
Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.
Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.
Configuring Endpoint Options
Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.
Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.
A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.
The following two sections lists all the options, firstly for the component followed by the endpoint.
Component Options
The Debezium MongoDB Connector component supports 62 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
Additional properties for debezium components in case they can’t be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro. | Map | ||
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean | |
Allow pre-configured Configurations to be set. | MongoDbConnectorEmbeddedDebeziumConfiguration | ||
The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter. | org.apache.kafka.connect.json.JsonConverter | String | |
The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter. | org.apache.kafka.connect.json.JsonConverter | String | |
The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals. | String | ||
Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. | 5000 | long | |
Interval at which to try committing offsets. The default is 1 minute. | 60000 | long | |
The name of the Java class that is responsible for persistence of connector offsets. | org.apache.kafka.connect.storage.FileOffsetBackingStore | String | |
Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. | String | ||
The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. | int | ||
Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore. | int | ||
The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. | String | ||
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean | |
The method used to capture changes from MongoDB server. Options include: 'oplog' to capture changes from the oplog; 'change_streams' to capture changes via MongoDB Change Streams, update events do not contain full documents; 'change_streams_update_full' (the default) to capture changes via MongoDB Change Streams, update events contain full documents. | change_streams_update_full | String | |
A comma-separated list of regular expressions that match the collection names for which changes are to be excluded. | String | ||
A comma-separated list of regular expressions that match the collection names for which changes are to be captured. | String | ||
The initial delay when trying to reconnect to a primary after a connection cannot be made or when no primary is available, given in milliseconds. Defaults to 1 second (1,000 ms). | 1s | long | |
The maximum delay when trying to reconnect to a primary after a connection cannot be made or when no primary is available, given in milliseconds. Defaults to 120 second (120,000 ms). | 2m | long | |
Maximum number of failed connection attempts to a replica set primary before an exception occurs and task is aborted. Defaults to 16, which with the defaults for 'connect.backoff.initial.delay.ms' and 'connect.backoff.max.delay.ms' results in just over 20 minutes of attempts before failing. | 16 | int | |
Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'. | String | ||
The maximum processing time in milliseconds to wait for the oplog cursor to process a single poll request. | int | ||
A comma-separated list of regular expressions that match the database names for which changes are to be excluded. | String | ||
The path to the file that will be used to record the database history. | String | ||
A comma-separated list of regular expressions that match the database names for which changes are to be captured. | String | ||
Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped;'ignore' the problematic event will be skipped. | fail | String | |
A comma-separated list of the fully-qualified names of fields that should be excluded from change event message values. | String | ||
A comma-separated list of the fully-qualified replacements of fields that should be used to rename fields in change event message values. Fully-qualified replacements for fields are of the form databaseName.collectionName.fieldName.nestedFieldName:newNestedFieldName, where databaseName and collectionName may contain the wildcard () which matches any characters, the colon character (:) is used to determine rename mapping of field. | String | ||
Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. | 0ms | int | |
The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. | __debezium-heartbeat | String | |
Maximum size of each batch of source records. Defaults to 2048. | 2048 | int | |
Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size. | 8192 | int | |
Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled. | 0 | long | |
Database containing user credentials. | admin | String | |
The connection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms). | 10s | int | |
The hostname and port pairs (in the form 'host' or 'host:port') of the MongoDB server(s) in the replica set. | String | ||
Specifies whether the addresses in 'hosts' are seeds that should be used to discover all members of the cluster or replica set ('true'), or whether the address(es) in 'hosts' should be used as is ('false'). The default is 'true'. | true | boolean | |
Required Unique name that identifies the MongoDB replica set or cluster and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct MongoDB installation should have a separate namespace and monitored by at most one Debezium connector. | String | ||
Required Password to be used when connecting to MongoDB, if necessary. | String | ||
Interval for looking for new, removed, or changed replica sets, given in milliseconds. Defaults to 30 seconds (30,000 ms). | 30s | long | |
The server selection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms). | 30s | int | |
The socket timeout, given in milliseconds. Defaults to 0 ms. | 0ms | int | |
Should connector use SSL to connect to MongoDB instances. | false | boolean | |
Whether invalid host names are allowed when using SSL. If true the connection will not prevent man-in-the-middle attacks. | false | boolean | |
Database user for connecting to MongoDB, if necessary. | String | ||
Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. | 500ms | long | |
Enables transaction metadata extraction together with event counting. | false | boolean | |
The maximum number of records that should be loaded into memory while streaming. A value of 0 uses the default JDBC fetch size. | 0 | int | |
Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. | 10s | long | |
Whether field names will be sanitized to Avro naming conventions. | false | boolean | |
Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including:'avro' replaces the characters that cannot be used in the Avro type name with underscore (default)'none' does not apply any adjustment. | avro | String | |
The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set. | String | ||
The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, no operations will be skipped. | String | ||
This property contains a comma-separated list of ., for which the initial snapshot may be a subset of data present in the data source. The subset would be defined by mongodb filter query specified as value for property snapshot.collection.filter.override.. | String | ||
A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. | 0ms | long | |
The maximum number of records that should be loaded into memory while performing a snapshot. | int | ||
this setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector. | String | ||
The maximum number of threads used to perform the snapshot. Defaults to 1. | 1 | int | |
The criteria for running a snapshot upon startup of the connector. Options include: 'initial' (the default) to specify the connector should always perform an initial sync when required; 'never' to specify the connector should never perform an initial sync. | initial | String | |
A version of the format of the publicly visible source part in the message. | v2 | String | |
Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. | false | boolean | |
The name of the transaction metadata topic. The placeholder $\{database.server.name} can be used for referring to the connector’s logical name; defaults to $\{database.server.name}.transaction. | ${database.server.name}.transaction | String |
Endpoint Options
The Debezium MongoDB Connector endpoint is configured using URI syntax:
debezium-mongodb:name
with the following path and query parameters:
Query Parameters (62 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
Additional properties for debezium components in case they can’t be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro. | Map | ||
The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter. | org.apache.kafka.connect.json.JsonConverter | String | |
The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter. | org.apache.kafka.connect.json.JsonConverter | String | |
The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals. | String | ||
Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. | 5000 | long | |
Interval at which to try committing offsets. The default is 1 minute. | 60000 | long | |
The name of the Java class that is responsible for persistence of connector offsets. | org.apache.kafka.connect.storage.FileOffsetBackingStore | String | |
Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. | String | ||
The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. | int | ||
Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore. | int | ||
The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. | String | ||
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean | |
To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | ExceptionHandler | ||
Sets the exchange pattern when the consumer creates an exchange. Enum values:
| ExchangePattern | ||
The method used to capture changes from MongoDB server. Options include: 'oplog' to capture changes from the oplog; 'change_streams' to capture changes via MongoDB Change Streams, update events do not contain full documents; 'change_streams_update_full' (the default) to capture changes via MongoDB Change Streams, update events contain full documents. | change_streams_update_full | String | |
A comma-separated list of regular expressions that match the collection names for which changes are to be excluded. | String | ||
A comma-separated list of regular expressions that match the collection names for which changes are to be captured. | String | ||
The initial delay when trying to reconnect to a primary after a connection cannot be made or when no primary is available, given in milliseconds. Defaults to 1 second (1,000 ms). | 1s | long | |
The maximum delay when trying to reconnect to a primary after a connection cannot be made or when no primary is available, given in milliseconds. Defaults to 120 second (120,000 ms). | 2m | long | |
Maximum number of failed connection attempts to a replica set primary before an exception occurs and task is aborted. Defaults to 16, which with the defaults for 'connect.backoff.initial.delay.ms' and 'connect.backoff.max.delay.ms' results in just over 20 minutes of attempts before failing. | 16 | int | |
Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'. | String | ||
The maximum processing time in milliseconds to wait for the oplog cursor to process a single poll request. | int | ||
A comma-separated list of regular expressions that match the database names for which changes are to be excluded. | String | ||
The path to the file that will be used to record the database history. | String | ||
A comma-separated list of regular expressions that match the database names for which changes are to be captured. | String | ||
Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped;'ignore' the problematic event will be skipped. | fail | String | |
A comma-separated list of the fully-qualified names of fields that should be excluded from change event message values. | String | ||
A comma-separated list of the fully-qualified replacements of fields that should be used to rename fields in change event message values. Fully-qualified replacements for fields are of the form databaseName.collectionName.fieldName.nestedFieldName:newNestedFieldName, where databaseName and collectionName may contain the wildcard () which matches any characters, the colon character (:) is used to determine rename mapping of field. | String | ||
Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. | 0ms | int | |
The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. | __debezium-heartbeat | String | |
Maximum size of each batch of source records. Defaults to 2048. | 2048 | int | |
Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size. | 8192 | int | |
Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled. | 0 | long | |
Database containing user credentials. | admin | String | |
The connection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms). | 10s | int | |
The hostname and port pairs (in the form 'host' or 'host:port') of the MongoDB server(s) in the replica set. | String | ||
Specifies whether the addresses in 'hosts' are seeds that should be used to discover all members of the cluster or replica set ('true'), or whether the address(es) in 'hosts' should be used as is ('false'). The default is 'true'. | true | boolean | |
Required Unique name that identifies the MongoDB replica set or cluster and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct MongoDB installation should have a separate namespace and monitored by at most one Debezium connector. | String | ||
Required Password to be used when connecting to MongoDB, if necessary. | String | ||
Interval for looking for new, removed, or changed replica sets, given in milliseconds. Defaults to 30 seconds (30,000 ms). | 30s | long | |
The server selection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms). | 30s | int | |
The socket timeout, given in milliseconds. Defaults to 0 ms. | 0ms | int | |
Should connector use SSL to connect to MongoDB instances. | false | boolean | |
Whether invalid host names are allowed when using SSL. If true the connection will not prevent man-in-the-middle attacks. | false | boolean | |
Database user for connecting to MongoDB, if necessary. | String | ||
Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. | 500ms | long | |
Enables transaction metadata extraction together with event counting. | false | boolean | |
The maximum number of records that should be loaded into memory while streaming. A value of 0 uses the default JDBC fetch size. | 0 | int | |
Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. | 10s | long | |
Whether field names will be sanitized to Avro naming conventions. | false | boolean | |
Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including:'avro' replaces the characters that cannot be used in the Avro type name with underscore (default)'none' does not apply any adjustment. | avro | String | |
The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set. | String | ||
The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, no operations will be skipped. | String | ||
This property contains a comma-separated list of ., for which the initial snapshot may be a subset of data present in the data source. The subset would be defined by mongodb filter query specified as value for property snapshot.collection.filter.override.. | String | ||
A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. | 0ms | long | |
The maximum number of records that should be loaded into memory while performing a snapshot. | int | ||
this setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector. | String | ||
The maximum number of threads used to perform the snapshot. Defaults to 1. | 1 | int | |
The criteria for running a snapshot upon startup of the connector. Options include: 'initial' (the default) to specify the connector should always perform an initial sync when required; 'never' to specify the connector should never perform an initial sync. | initial | String | |
A version of the format of the publicly visible source part in the message. | v2 | String | |
Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. | false | boolean | |
The name of the transaction metadata topic. The placeholder $\{database.server.name} can be used for referring to the connector’s logical name; defaults to $\{database.server.name}.transaction. | ${database.server.name}.transaction | String |
Message Headers
The Debezium MongoDB Connector component supports 7 message header(s), which is/are listed below:
| Name | Description | Default | Type |
|---|---|---|---|
CamelDebeziumSourceMetadata (consumer) Constant: | The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info. | Map | |
CamelDebeziumIdentifier (consumer) Constant: | The identifier of the connector, normally is this format {server-name}.{database-name}.{table-name}. | String | |
| Constant: | The key of the event, normally is the table Primary Key. | Struct | |
CamelDebeziumOperation (consumer) Constant: | If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r for read (in the case of a initial sync) or in case of a snapshot event. | String | |
CamelDebeziumTimestamp (consumer) Constant: | If presents, the time (using the system clock in the JVM) at which the connector processed the event. | Long | |
CamelDebeziumBefore (consumer) Constant: | If presents, contains the state of the row before the event occurred. | Struct | |
CamelDebeziumDdlSQL (consumer) Constant: | If presents, the ddl sql text of the event. | String |
Note: Debezium Mongodb uses MongoDB’s oplog to populate the CDC events, the update events in MongoDB’s oplog don’t have the before or after states of the changed document, so there’s no way for the Debezium connector to provide this information, therefore header key CamelDebeziumBefore is not available in this component.
Message body
The message body if is not null (in case of tombstones), it contains the state of the row after the event occurred as String JSON format and you can unmarchal using Camel JSON Data Format.
Samples
Consuming events
Here is a very simple route that you can use in order to listen to Debezium events from MongoDB connector.
from("debezium-mongodb:dbz-test-1?offsetStorageFileName=/usr/offset-file-1.dat&mongodbHosts=rs0/localhost:27017&mongodbUser=debezium&mongodbPassword=dbz&mongodbName=dbserver1&databaseHistoryFileFilename=/usr/history-file-1.dat")
.log("Event received from Debezium : ${body}")
.log(" with this identifier ${headers.CamelDebeziumIdentifier}")
.log(" with these source metadata ${headers.CamelDebeziumSourceMetadata}")
.log(" the event occured upon this operation '${headers.CamelDebeziumSourceOperation}'")
.log(" on this database '${headers.CamelDebeziumSourceMetadata[db]}' and this table '${headers.CamelDebeziumSourceMetadata[table]}'")
.log(" with the key ${headers.CamelDebeziumKey}")
.choice()
.when(header(DebeziumConstants.HEADER_OPERATION).in("c", "u", "r"))
.unmarshal().json()
.log("Event received from Debezium : ${body}")
.end()
.end();By default, the component will emit the events in the body String JSON format in case of u, c or r operations, this can be easily converted to JSON using Camel JSON Data Format e.g: .unmarshal().json() like the above example. In case of operation d, the body will be null.
Important Note: This component is a thin wrapper around Debezium Engine as mentioned, therefore before using this component in production, you need to understand how Debezium works and how configurations can reflect the expected behavior, especially in regards to handling failures.
Spring Boot Auto-Configuration
When using debezium-mongodb with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-debezium-mongodb-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 63 options, which are listed below.