DBZ-3613 Specify when snapshot metrics are available.
This commit is contained in:
parent
82b151d0b9
commit
691bf80cf4
@ -4,6 +4,7 @@
|
|||||||
= {prodname} connector for Db2
|
= {prodname} connector for Db2
|
||||||
|
|
||||||
:context: db2
|
:context: db2
|
||||||
|
:mbean-name: {context}
|
||||||
ifdef::community[]
|
ifdef::community[]
|
||||||
|
|
||||||
:toc:
|
:toc:
|
||||||
@ -2138,8 +2139,6 @@ The {prodname} Db2 connector provides three types of metrics that are in additio
|
|||||||
[[db2-snapshot-metrics]]
|
[[db2-snapshot-metrics]]
|
||||||
=== Snapshot metrics
|
=== Snapshot metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.db2:type=connector-metrics,context=snapshot,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-incremental-snapshot-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-incremental-snapshot-metrics.adoc[leveloffset=+1]
|
||||||
@ -2150,8 +2149,6 @@ include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-increment
|
|||||||
[[db2-streaming-metrics]]
|
[[db2-streaming-metrics]]
|
||||||
=== Streaming metrics
|
=== Streaming metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.db2:type=connector-metrics,context=streaming,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
// Type: reference
|
// Type: reference
|
||||||
@ -2160,8 +2157,6 @@ include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming
|
|||||||
[[db2-schema-history-metrics]]
|
[[db2-schema-history-metrics]]
|
||||||
=== Schema history metrics
|
=== Schema history metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.db2:type=connector-metrics,context=schema-history,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
// Type: reference
|
// Type: reference
|
||||||
|
@ -4,6 +4,7 @@
|
|||||||
= {prodname} connector for MongoDB
|
= {prodname} connector for MongoDB
|
||||||
|
|
||||||
:context: mongodb
|
:context: mongodb
|
||||||
|
:mbean-name: {context}
|
||||||
ifdef::community[]
|
ifdef::community[]
|
||||||
|
|
||||||
:toc:
|
:toc:
|
||||||
@ -1422,8 +1423,6 @@ The {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[{prodname} moni
|
|||||||
[[mongodb-snapshot-metrics]]
|
[[mongodb-snapshot-metrics]]
|
||||||
=== Snapshot Metrics
|
=== Snapshot Metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.mongodb:type=connector-metrics,context=snapshot,server=_<mongodb.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
The {prodname} MongoDB connector also provides the following custom snapshot metrics:
|
The {prodname} MongoDB connector also provides the following custom snapshot metrics:
|
||||||
@ -1444,8 +1443,6 @@ The {prodname} MongoDB connector also provides the following custom snapshot met
|
|||||||
[[mongodb-streaming-metrics]]
|
[[mongodb-streaming-metrics]]
|
||||||
=== Streaming Metrics
|
=== Streaming Metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.sql_server:type=connector-metrics,context=streaming,server=_<mongodb.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
The {prodname} MongoDB connector also provides the following custom streaming metrics:
|
The {prodname} MongoDB connector also provides the following custom streaming metrics:
|
||||||
|
@ -4,6 +4,7 @@
|
|||||||
= {prodname} connector for MySQL
|
= {prodname} connector for MySQL
|
||||||
|
|
||||||
:context: mysql
|
:context: mysql
|
||||||
|
:mbean-name: {context}
|
||||||
ifdef::community[]
|
ifdef::community[]
|
||||||
|
|
||||||
:toc:
|
:toc:
|
||||||
@ -2624,8 +2625,6 @@ The {prodname} MySQL connector provides three types of metrics that are in addit
|
|||||||
[[mysql-snapshot-metrics]]
|
[[mysql-snapshot-metrics]]
|
||||||
=== Snapshot metrics
|
=== Snapshot metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.mysql:type=connector-metrics,context=snapshot,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-incremental-snapshot-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-incremental-snapshot-metrics.adoc[leveloffset=+1]
|
||||||
@ -2638,8 +2637,6 @@ The {prodname} MySQL connector also provides the `HoldingGlobalLock` custom snap
|
|||||||
[[mysql-streaming-metrics]]
|
[[mysql-streaming-metrics]]
|
||||||
=== Streaming metrics
|
=== Streaming metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.mysql:type=connector-metrics,context=streaming,server=<database.server.name>`.
|
|
||||||
|
|
||||||
Transaction-related attributes are available only if binlog event buffering is enabled. See {link-prefix}:{link-mysql-connector}#mysql-property-binlog-buffer-size[`binlog.buffer.size`] in the advanced connector configuration properties for more details.
|
Transaction-related attributes are available only if binlog event buffering is enabled. See {link-prefix}:{link-mysql-connector}#mysql-property-binlog-buffer-size[`binlog.buffer.size`] in the advanced connector configuration properties for more details.
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
||||||
@ -2695,8 +2692,6 @@ The {prodname} MySQL connector also provides the following additional streaming
|
|||||||
[[mysql-schema-history-metrics]]
|
[[mysql-schema-history-metrics]]
|
||||||
=== Schema history metrics
|
=== Schema history metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.mysql:type=connector-metrics,context=schema-history,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
// Type: concept
|
// Type: concept
|
||||||
|
@ -4,6 +4,7 @@
|
|||||||
= {prodname} Connector for Oracle
|
= {prodname} Connector for Oracle
|
||||||
|
|
||||||
:context: oracle
|
:context: oracle
|
||||||
|
:mbean-name: {context}
|
||||||
ifdef::community[]
|
ifdef::community[]
|
||||||
:toc:
|
:toc:
|
||||||
:toc-placement: macro
|
:toc-placement: macro
|
||||||
@ -2307,7 +2308,6 @@ Please refer to the {link-prefix}:{link-debezium-monitoring}#monitoring-debezium
|
|||||||
=== Snapshot Metrics
|
=== Snapshot Metrics
|
||||||
|
|
||||||
[[oracle-monitoring-snapshots]]
|
[[oracle-monitoring-snapshots]]
|
||||||
The *MBean* is `debezium.oracle:type=connector-metrics,context=snapshot,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
@ -2320,7 +2320,6 @@ include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-increment
|
|||||||
=== Streaming Metrics
|
=== Streaming Metrics
|
||||||
|
|
||||||
[[oracle-monitoring-streaming]]
|
[[oracle-monitoring-streaming]]
|
||||||
The *MBean* is `debezium.oracle:type=connector-metrics,context=streaming,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
@ -2553,7 +2552,6 @@ This should always be `0`; however when allowing unparsable DDL to be skipped, t
|
|||||||
=== Schema History Metrics
|
=== Schema History Metrics
|
||||||
|
|
||||||
[[oracle-monitoring-schema-history]]
|
[[oracle-monitoring-schema-history]]
|
||||||
The *MBean* is `debezium.oracle:type=connector-metrics,context=schema-history,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
|
@ -4,6 +4,7 @@
|
|||||||
= {prodname} connector for PostgreSQL
|
= {prodname} connector for PostgreSQL
|
||||||
|
|
||||||
:context: postgresql
|
:context: postgresql
|
||||||
|
:mbean-name: postgres
|
||||||
ifdef::community[]
|
ifdef::community[]
|
||||||
|
|
||||||
:toc:
|
:toc:
|
||||||
@ -2949,8 +2950,6 @@ The {prodname} PostgreSQL connector provides two types of metrics that are in ad
|
|||||||
[[postgresql-snapshot-metrics]]
|
[[postgresql-snapshot-metrics]]
|
||||||
=== Snapshot metrics
|
=== Snapshot metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.postgres:type=connector-metrics,context=snapshot,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-incremental-snapshot-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-incremental-snapshot-metrics.adoc[leveloffset=+1]
|
||||||
@ -2961,8 +2960,6 @@ include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-increment
|
|||||||
[[postgresql-streaming-metrics]]
|
[[postgresql-streaming-metrics]]
|
||||||
=== Streaming metrics
|
=== Streaming metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.postgres:type=connector-metrics,context=streaming,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
|
|
||||||
|
@ -5,6 +5,7 @@
|
|||||||
= {prodname} connector for SQL Server
|
= {prodname} connector for SQL Server
|
||||||
|
|
||||||
:context: sqlserver
|
:context: sqlserver
|
||||||
|
:mbean-name: sql_server
|
||||||
ifdef::community[]
|
ifdef::community[]
|
||||||
|
|
||||||
:toc:
|
:toc:
|
||||||
@ -2485,8 +2486,6 @@ For information about how to expose the preceding metrics through JMX, see the {
|
|||||||
[[sqlserver-snapshot-metrics]]
|
[[sqlserver-snapshot-metrics]]
|
||||||
=== Snapshot metrics
|
=== Snapshot metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.sql_server:type=connector-metrics,context=snapshot,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-snapshot-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-incremental-snapshot-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-incremental-snapshot-metrics.adoc[leveloffset=+1]
|
||||||
@ -2497,8 +2496,6 @@ include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-increment
|
|||||||
[[sqlserver-streaming-metrics]]
|
[[sqlserver-streaming-metrics]]
|
||||||
=== Streaming metrics
|
=== Streaming metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.sql_server:type=connector-metrics,context=streaming,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming-metrics.adoc[leveloffset=+1]
|
||||||
|
|
||||||
// Type: reference
|
// Type: reference
|
||||||
@ -2507,6 +2504,4 @@ include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-streaming
|
|||||||
[[sqlserver-schema-history-metrics]]
|
[[sqlserver-schema-history-metrics]]
|
||||||
=== Schema history metrics
|
=== Schema history metrics
|
||||||
|
|
||||||
The *MBean* is `debezium.sql_server:type=connector-metrics,context=schema-history,server=_<database.server.name>_`.
|
|
||||||
|
|
||||||
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
|
include::{partialsdir}/modules/all-connectors/ref-connector-monitoring-schema-history-metrics.adoc[leveloffset=+1]
|
||||||
|
@ -1,3 +1,7 @@
|
|||||||
|
The *MBean* is `debezium.{mbean-name}:type=connector-metrics,context=schema-history,server=_<{context}.server.name>_`.
|
||||||
|
|
||||||
|
The following table lists the schema history metrics that are available.
|
||||||
|
|
||||||
[cols="45%a,25%a,30%a",options="header"]
|
[cols="45%a,25%a,30%a",options="header"]
|
||||||
|===
|
|===
|
||||||
|Attributes |Type |Description
|
|Attributes |Type |Description
|
||||||
|
@ -1,3 +1,9 @@
|
|||||||
|
The *MBean* is `debezium.{mbean-name}:type=connector-metrics,context=snapshot,server=_<{context}.server.name>_`.
|
||||||
|
|
||||||
|
Snapshot metrics are not exposed unless a snapshot operation is active, or if a snapshot has occurred since the last connector start.
|
||||||
|
|
||||||
|
The following table lists the shapshot metrics that are available.
|
||||||
|
|
||||||
[cols="45%a,25%a,30%a",options="header"]
|
[cols="45%a,25%a,30%a",options="header"]
|
||||||
|===
|
|===
|
||||||
|Attributes |Type |Description
|
|Attributes |Type |Description
|
||||||
|
@ -1,3 +1,7 @@
|
|||||||
|
The *MBean* is `debezium.{mbean-name}:type=connector-metrics,context=streaming,server=_<{context}.server.name>_`.
|
||||||
|
|
||||||
|
The following table lists the streaming metrics that are available.
|
||||||
|
|
||||||
[cols="45%a,25%a,30%a",options="header"]
|
[cols="45%a,25%a,30%a",options="header"]
|
||||||
|===
|
|===
|
||||||
|Attributes |Type |Description
|
|Attributes |Type |Description
|
||||||
|
Loading…
Reference in New Issue
Block a user