DBZ-6424 Apply suggestions from code review
Co-authored-by: roldanbob <broldan@redhat.com>
This commit is contained in:
Fiore Mario Vitale
parent
86877d6b4e
commit
28366f3809
@ -197,20 +197,20 @@ To use the `sink` notification channel, you must also set the `notification.sink
|
||||
|
||||
To enable {prodname} to report events that are exposed through JMX beans, complete the following configuration steps:
|
||||
|
||||
* {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[Enable JMX MBean Server] to expose the notification bean.
|
||||
* Add `jmx` to the `notification.enabled.channels` configuration property.
|
||||
* Connect your preferred JMX client to the MBean Server.
|
||||
1. {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[Enable the JMX MBean Server] to expose the notification bean.
|
||||
2. Add `jmx` to the `notification.enabled.channels` property in the connector configuration.
|
||||
3. Connect your preferred JMX client to the MBean Server.
|
||||
|
||||
Notifications are exposed in the bean named `debezium.__<connector-type>__.management.notifications.__<server>__` through the `Notifications` attribute.
|
||||
Notifications are exposed through the `Notifications` attribute of a bean with the name `debezium.__<connector-type>__.management.notifications.__<server>__`.
|
||||
|
||||
The following image shows a notification that reports the start of an incremental snapshot:
|
||||
|
||||
image::jmx-notification-attribute.png[JMX notification attribute]
|
||||
image::jmx-notification-attribute.png[Fields in the JMX `Notifications` attribute]
|
||||
|
||||
To discard a notification, call the `reset` operation on the bean.
|
||||
|
||||
The notifications are also exposed as a JMX notification with type `debezium.notification`.
|
||||
To enable an application to receive JMX notifications, link:https://docs.oracle.com/javase/tutorial/jmx/notifs/index.html[subscribe the application to the notifications].
|
||||
To enable an application to listen for the JMX notifications that an MBean emits, link:https://docs.oracle.com/javase/tutorial/jmx/notifs/index.html[subscribe the application to the notifications].
|
||||
|
||||
// Type: concept
|
||||
[id="debezium-notification-custom-channel"]
|
||||
|
||||
@ -199,9 +199,9 @@ Value = `{"type":"execute-snapshot","data": {"data-collections": ["schema1.table
|
||||
[id="debezium-signaling-enabling-jmx-signaling-channel"]
|
||||
== Enabling a JMX signaling channel
|
||||
|
||||
You can enable the JMX signaling by adding `jmx` to the `signal.enabled.channels` configuration property, and then {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[enabling the JMX MBean Server] to expose the signaling bean.
|
||||
You can enable the JMX signaling by adding `jmx` to the `signal.enabled.channels` property in the connector configuration, and then {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[enabling the JMX MBean Server] to expose the signaling bean.
|
||||
|
||||
\\ Title: Using a JMX signaling channel to send signals to {prodname}
|
||||
// Title: Using a JMX signaling channel to send signals to {prodname}
|
||||
[id="debezium-signaling-using-a-jmx-signaling-channel-to-sends-signals"]
|
||||
=== Sending JMX signals
|
||||
|
||||
@ -213,8 +213,8 @@ The Mbean exposes `signal` operations that accept the following input parameters
|
||||
p0:: The id of the signal.
|
||||
p1:: The type of the signal, for example, `execute-snapshot`.
|
||||
p2:: A JSON data field that contains additional information about the specified signal type.
|
||||
+
|
||||
Send an `execute-snapshot` signal by providing value for the input parameters. + In the JSON data field, include the information that is listed in the following table:
|
||||
3. Send an `execute-snapshot` signal by providing value for the input parameters. +
|
||||
In the JSON data field, include the information that is listed in the following table:
|
||||
+
|
||||
.Execute snapshot data fields
|
||||
[cols="2,2,6",options="header"]
|
||||
@ -238,7 +238,7 @@ Specify the names by using the same format as is required for the xref:{context}
|
||||
+
|
||||
The following image shows an example of how to use JConsole to send a signal:
|
||||
+
|
||||
image::jmx-signal-operation.png[]
|
||||
image::jmx-signal-operation.png[Using JConsole to send an `execute-snapshot` signal]
|
||||
|
||||
// Type: concept
|
||||
[id="debezium-custom-signaling-channel"]
|
||||
|
||||
@ -2494,7 +2494,7 @@ include::{partialsdir}/modules/all-connectors/ref-connector-configuration-databa
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-signals-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
[id="debezium-{context}-connector-kafka-notifications-configuration-properties"]
|
||||
==== {prodname} connector Sink notifications configuration properties
|
||||
==== {prodname} connector sink notifications configuration properties
|
||||
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@ -1796,13 +1796,10 @@ For example, if the topic prefix is `fulfillment`, the default topic name is `fu
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-signals-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
[id="debezium-{context}-connector-kafka-notifications-configuration-properties"]
|
||||
==== {prodname} connector Sink notifications configuration properties
|
||||
==== {prodname} connector sink notifications configuration properties
|
||||
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
[id="debezium-{context}-connector-kafka-notifications-configuration-properties"]
|
||||
==== {prodname} connector Sink notifications configuration properties
|
||||
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
// Type: assembly
|
||||
|
||||
@ -3152,7 +3152,7 @@ include::{partialsdir}/modules/all-connectors/ref-connector-configuration-databa
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-signals-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
[id="debezium-{context}-connector-kafka-notifications-configuration-properties"]
|
||||
==== {prodname} connector Sink notifications configuration properties
|
||||
==== {prodname} connector sink notifications configuration properties
|
||||
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@ -3449,7 +3449,7 @@ include::../../partials/modules/all-connectors/ref-connector-configuration-datab
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-signals-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
[id="debezium-{context}-connector-kafka-notifications-configuration-properties"]
|
||||
==== {prodname} connector Sink notifications configuration properties
|
||||
==== {prodname} connector sink notifications configuration properties
|
||||
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@ -3522,7 +3522,7 @@ Be sure to consult the {link-kafka-docs}.html[Kafka documentation] for all of th
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-signals-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
[id="debezium-{context}-connector-kafka-notifications-configuration-properties"]
|
||||
==== {prodname} connector Sink notifications configuration properties
|
||||
==== {prodname} connector sink notifications configuration properties
|
||||
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@ -2730,7 +2730,7 @@ include::{partialsdir}/modules/all-connectors/ref-connector-configuration-databa
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-signals-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
[id="debezium-{context}-connector-kafka-notifications-configuration-properties"]
|
||||
==== {prodname} connector Sink notifications configuration properties
|
||||
==== {prodname} connector sink notifications configuration properties
|
||||
|
||||
include::{partialsdir}/modules/all-connectors/ref-connector-pass-through-kafka-notification-configuration-properties.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@ -6,5 +6,6 @@ The following table describes the `notification` properties.
|
||||
|Property |Default |Description
|
||||
|[[{context}-property-notification-sink-topic-name]]<<{context}-property-notification-sink-topic-name, `+notification.sink.topic.name+`>>
|
||||
|No default
|
||||
|The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels.
|
||||
|The name of the topic that receives notifications from {prodname}.
|
||||
This property is required when you configure the xref:{context}-property-notification-enabled-channels[`notification.enabled.channels`] property to include `sink` as one of the enabled notification channels.
|
||||
|===
|
||||
@ -1,6 +1,6 @@
|
||||
{prodname} provides a set of `signal.*` properties that control how the connector interacts with the Kafka signals topic.
|
||||
|
||||
The following table describes the `signal` properties.
|
||||
The following table describes the Kafka `signal` properties.
|
||||
|
||||
.Kafka signals configuration properties
|
||||
[cols="33%a,17%a,50%a",options="header",subs="+attributes"]
|
||||
@ -12,11 +12,12 @@ The following table describes the `signal` properties.
|
||||
|
||||
|[[{context}-property-signal-kafka-bootstrap-servers]]<<{context}-property-signal-kafka-bootstrap-servers, `+signal.kafka.bootstrap.servers+`>>
|
||||
|No default
|
||||
|A list of host/port pairs that the connector uses for establishing an initial connection to the Kafka cluster. Each pair should point to the same Kafka cluster used by the Kafka Connect process.
|
||||
|A list of host/port pairs that the connector uses for establishing an initial connection to the Kafka cluster.
|
||||
Each pair references the Kafka cluster that is used by the {prodname} Kafka Connect process.
|
||||
|
||||
|[[{context}-property-signal-kafka-poll-timeout-ms]]<<{context}-property-signal-kafka-poll-timeout-ms, `+signal.kafka.poll.timeout.ms+`>>
|
||||
|`100`
|
||||
|An integer value that specifies the maximum number of milliseconds the connector should wait when polling signals. The default is 100ms.
|
||||
|An integer value that specifies the maximum number of milliseconds that the connector waits when polling signals.
|
||||
|
||||
|===
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user