DBZ-3161 Add database.history.store.only.captured.tables.ddl option & CapturedTables metrics to documentation

debezium-connector-mysql/src/main/java/io/debezium/connector/mysql/legacy/BinlogReaderMetrics.java

@@ -151,6 +151,10 @@ public void setMilliSecondsBehindSource(long value) {
         milliSecondsBehindMaster.set(value);
     }
 
+    /**
+     * @deprecated Superseded by the 'Captured Tables' metric. Use {@link #getCapturedTables()}.
+     * Scheduled for removal in a future release.
+     */
     @Override
     @Deprecated
     public String[] getMonitoredTables() {

debezium-connector-mysql/src/main/java/io/debezium/connector/mysql/legacy/ReaderMetricsMXBean.java

@@ -13,6 +13,10 @@
  */
 public interface ReaderMetricsMXBean {
 
+    /**
+     * @deprecated Superseded by the 'Captured Tables' metric. Use {@link #getCapturedTables()}.
+     * Scheduled for removal in a future release.
+     */
     @Deprecated
     String[] getMonitoredTables();
 

debezium-core/src/main/java/io/debezium/pipeline/metrics/ChangeEventSourceMetricsMXBean.java

@@ -22,6 +22,10 @@ public interface ChangeEventSourceMetricsMXBean {
 
     long getNumberOfErroneousEvents();
 
+    /**
+     * @deprecated Superseded by the 'Captured Tables' metric. Use {@link #getCapturedTables()}.
+     * Scheduled for removal in a future release.
+     */
     @Deprecated
     String[] getMonitoredTables();
 

debezium-core/src/main/java/io/debezium/pipeline/metrics/SnapshotChangeEventSourceMetrics.java

@@ -84,6 +84,10 @@ public long getSnapshotDurationInSeconds() {
         return (stopMillis - startMillis) / 1000L;
     }
 
+    /**
+     * @deprecated Superseded by the 'Captured Tables' metric. Use {@link #getCapturedTables()}.
+     * Scheduled for removal in a future release.
+     */
     @Override
     @Deprecated
     public String[] getMonitoredTables() {

debezium-core/src/main/java/io/debezium/pipeline/metrics/StreamingChangeEventSourceMetrics.java

@@ -50,6 +50,10 @@ public boolean isConnected() {
         return this.connected.get();
     }
 
+    /**
+     * @deprecated Superseded by the 'Captured Tables' metric. Use {@link #getCapturedTables()}.
+     * Scheduled for removal in a future release.
+     */
     @Override
     @Deprecated
     public String[] getMonitoredTables() {

documentation/modules/ROOT/pages/connectors/mysql.adoc

@@ -2416,6 +2416,15 @@ The safe default is `false`.
 Skipping should be used only with care as it can lead to data loss or mangling when the binlog is being processed.
 
 |[[mysql-property-database-history-store-only-monitored-tables-ddl]]<<mysql-property-database-history-store-only-monitored-tables-ddl, `+database.history.store.only.monitored.tables.ddl+`>>
+_deprecated and scheduled for removal in a future release_
+|`false`
+|A Boolean value that specifies whether the connector should record all DDL statements  +
+ +
+`true` records only those DDL statements that are relevant to tables whose changes are being captured by {prodname}. Set to `true` with care because missing data might become necessary if you change which tables have their changes captured. +
+ +
+The safe default is `false`.
+
+|[[mysql-property-database-history-store-only-captured-tables-ddl]]<<mysql-property-database-history-store-only-captured-tables-ddl, `+database.history.store.only.captured.tables.ddl+`>>
 |`false`
 |A Boolean value that specifies whether the connector should record all DDL statements  +
  +

documentation/modules/ROOT/partials/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc

@@ -19,9 +19,14 @@
 |The number of events that have been filtered by include/exclude list filtering rules configured on the connector.
 
 |[[connectors-strm-metric-monitoredtables_{context}]]<<connectors-strm-metric-monitoredtables_{context}, `MonitoredTables`>>
+_deprecated and scheduled for removal in a future release_
 |`string[]`
 |The list of tables that are monitored by the connector.
 
+|[[connectors-strm-metric-capturedtables_{context}]]<<connectors-strm-metric-capturedtables{context}, `CapturedTables`>>
+|`string[]`
+|The list of tables that are captured by the connector.
+
 |[[connectors-strm-metric-queuetotalcapacity_{context}]]<<connectors-strm-metric-queuetotalcapacity_{context}, `QueueTotalCapacity`>>
 |`int`
 |The length the queue used to pass events between the streamer and the main Kafka Connect loop.