From aeb3d7c9d70e8da92ced06f4e91917bfb49782d0 Mon Sep 17 00:00:00 2001 From: roldanbob Date: Wed, 24 Apr 2024 17:20:33 -0400 Subject: [PATCH] DBZ-7800 Updates property description; adds Customized MBeans topic --- .../modules/ROOT/pages/connectors/db2.adoc | 19 +++++++++++++++++-- .../ROOT/pages/connectors/informix.adoc | 12 ++++++++++-- .../ROOT/pages/connectors/mongodb.adoc | 17 ++++++++++++++++- .../modules/ROOT/pages/connectors/mysql.adoc | 17 ++++++++++++++++- .../modules/ROOT/pages/connectors/oracle.adoc | 17 ++++++++++++++++- .../ROOT/pages/connectors/postgresql.adoc | 17 ++++++++++++++++- .../ROOT/pages/connectors/spanner.adoc | 17 ++++++++++++++++- .../ROOT/pages/connectors/sqlserver.adoc | 18 +++++++++++++++++- .../modules/ROOT/pages/connectors/vitess.adoc | 7 +++++++ 9 files changed, 131 insertions(+), 10 deletions(-) diff --git a/documentation/modules/ROOT/pages/connectors/db2.adoc b/documentation/modules/ROOT/pages/connectors/db2.adoc index f809ec86d..abf90c48d 100644 --- a/documentation/modules/ROOT/pages/connectors/db2.adoc +++ b/documentation/modules/ROOT/pages/connectors/db2.adoc @@ -145,7 +145,7 @@ You can find more information about snapshots in the following sections: endif::product[] -[[default-workflow-for-performing-an-initial-snapshot]] +[[debezium-db2-default-workflow-for-performing-an-initial-snapshot]] .Default workflow that the {prodname} Db2 connector uses to perform an initial snapshot The following workflow lists the steps that {prodname} takes to create a snapshot. @@ -3029,7 +3029,15 @@ endif::product[] |[[db2-property-custom-metric-tags]]<> |`No default` -|The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: `k1=v1,k2=v2`. +|Defines tags that customize MBean object names by adding metadata that provides contextual information. +Specify a comma-separated list of key-value pairs. +Each key represents a tag for the MBean object name, and the corresponding value represents a value for the key, for example, + +`k1=v1,k2=v2` + +The connector appends the specified tags to the base MBean object name. +Tags can help you to organize and categorize metrics data. +You can define tags to identify particular application instances, environments, regions, versions, and so forth. +For more information, see xref:customized-mbean-names[Customized MBean names]. |[[db2-property-errors-max-retires]]<> |`-1` @@ -3085,6 +3093,13 @@ The {prodname} Db2 connector provides three types of metrics that are in additio {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[{prodname} monitoring documentation] provides details for how to expose these metrics by using JMX. +// Type: concept +// ModuleID: monitoring-debezium-db2-connectors-customized-mbean-names +// Title: Customized names for Db2 connector snapshot and streaming MBean objects +=== Customized MBean names + +include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] + // Type: reference // ModuleID: monitoring-debezium-during-snapshots-of-db2-databases // Title: Monitoring {prodname} during snapshots of Db2 databases diff --git a/documentation/modules/ROOT/pages/connectors/informix.adoc b/documentation/modules/ROOT/pages/connectors/informix.adoc index 203f1d85d..45491b233 100644 --- a/documentation/modules/ROOT/pages/connectors/informix.adoc +++ b/documentation/modules/ROOT/pages/connectors/informix.adoc @@ -2635,14 +2635,15 @@ endif::community[] |[[informix-property-custom-metric-tags]]<> |`No default` -|Defines tags for customizing MBean object names by adding metadata that provides contextual information that enables you to organize and categorize metrics data. +|Defines tags that customize MBean object names by adding metadata that provides contextual information. Specify a comma-separated list of key-value pairs. Each key represents a tag for the MBean object name, and the corresponding value represents a value for the key, for example, + `k1=v1,k2=v2` The connector appends the specified tags to the base MBean object name. - +Tags can help you to organize and categorize metrics data. You can define tags to identify particular application instances, environments, regions, versions, and so forth. +For more information, see xref:customized-mbean-names[Customized MBean names]. |[[informix-property-errors-max-retires]]<> |`-1` @@ -2689,6 +2690,13 @@ The {prodname} Informix connector provides three types of metrics that are in ad {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[{prodname} monitoring documentation] provides details for how to expose these metrics by using JMX. +// Type: concept +// ModuleID: monitoring-debezium-informix-connectors-customized-mbean-names +// Title: Customized names for Db2 connector snapshot and streaming MBean objects +=== Customized MBean names + +include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] + // Type: reference // ModuleID: monitoring-debezium-during-snapshots-of-informix-databases // Title: Monitoring {prodname} during snapshots of Informix databases diff --git a/documentation/modules/ROOT/pages/connectors/mongodb.adoc b/documentation/modules/ROOT/pages/connectors/mongodb.adoc index 5cd5a259e..e3c760c2b 100644 --- a/documentation/modules/ROOT/pages/connectors/mongodb.adoc +++ b/documentation/modules/ROOT/pages/connectors/mongodb.adoc @@ -2213,7 +2213,15 @@ For example, if the topic prefix is `fulfillment`, the default topic name is `fu |[[mongodb-property-custom-metric-tags]]<> |`No default` -|The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: `k1=v1,k2=v2`. +|Defines tags that customize MBean object names by adding metadata that provides contextual information. +Specify a comma-separated list of key-value pairs. +Each key represents a tag for the MBean object name, and the corresponding value represents a value for the key, for example, + +`k1=v1,k2=v2` + +The connector appends the specified tags to the base MBean object name. +Tags can help you to organize and categorize metrics data. +You can define tags to identify particular application instances, environments, regions, versions, and so forth. +For more information, see xref:customized-mbean-names[Customized MBean names]. |[[mongodb-property-errors-max-retires]]<> |`-1` @@ -2253,6 +2261,13 @@ The {prodname} MongoDB connector has two metric types in addition to the built-i The {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[{prodname} monitoring documentation] provides details about how to expose these metrics by using JMX. +// Type: concept +// ModuleID: monitoring-debezium-mongodb-connectors-customized-mbean-names +// Title: Customized names for Db2 connector snapshot and streaming MBean objects +=== Customized MBean names + +include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] + // Type: reference // ModuleID: monitoring-debezium-during-mongodb-snapshots // Title: Monitoring {prodname} during MongoDB snapshots diff --git a/documentation/modules/ROOT/pages/connectors/mysql.adoc b/documentation/modules/ROOT/pages/connectors/mysql.adoc index 258a1c551..b7a54f240 100644 --- a/documentation/modules/ROOT/pages/connectors/mysql.adoc +++ b/documentation/modules/ROOT/pages/connectors/mysql.adoc @@ -3897,7 +3897,15 @@ Specify one of the following options: |[[mysql-property-custom-metric-tags]]<> |`No default` -|The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: `k1=v1,k2=v2`. +|Defines tags that customize MBean object names by adding metadata that provides contextual information. +Specify a comma-separated list of key-value pairs. +Each key represents a tag for the MBean object name, and the corresponding value represents a value for the key, for example, + +`k1=v1,k2=v2` + +The connector appends the specified tags to the base MBean object name. +Tags can help you to organize and categorize metrics data. +You can define tags to identify particular application instances, environments, regions, versions, and so forth. +For more information, see xref:customized-mbean-names[Customized MBean names]. |[[mysql-property-errors-max-retires]]<> |`-1` @@ -3961,6 +3969,13 @@ The {prodname} MySQL connector provides three types of metrics that are in addit {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[{prodname} monitoring documentation] provides details for how to expose these metrics by using JMX. +// Type: concept +// ModuleID: monitoring-debezium-mysql-connectors-customized-mbean-names +// Title: Customized names for Db2 connector snapshot and streaming MBean objects +=== Customized MBean names + +include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] + // Type: reference // ModuleID: monitoring-debezium-during-snapshots-of-mysql-databases // Title: Monitoring {prodname} during snapshots of MySQL databases diff --git a/documentation/modules/ROOT/pages/connectors/oracle.adoc b/documentation/modules/ROOT/pages/connectors/oracle.adoc index 91f426f56..e744d0d49 100644 --- a/documentation/modules/ROOT/pages/connectors/oracle.adoc +++ b/documentation/modules/ROOT/pages/connectors/oracle.adoc @@ -4154,7 +4154,15 @@ By default, no additional retries will be performed. |[[oracle-property-custom-metric-tags]]<> |`No default` -|The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: `k1=v1,k2=v2`. +|Defines tags that customize MBean object names by adding metadata that provides contextual information. +Specify a comma-separated list of key-value pairs. +Each key represents a tag for the MBean object name, and the corresponding value represents a value for the key, for example, + +`k1=v1,k2=v2` + +The connector appends the specified tags to the base MBean object name. +Tags can help you to organize and categorize metrics data. +You can define tags to identify particular application instances, environments, regions, versions, and so forth. +For more information, see xref:customized-mbean-names[Customized MBean names]. |[[oracle-property-errors-max-retires]]<> |`-1` @@ -4207,6 +4215,13 @@ The {prodname} Oracle connector provides three metric types in addition to the b Please refer to the {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[monitoring documentation] for details of how to expose these metrics via JMX. +// Type: concept +// ModuleID: monitoring-debezium-oracle-connectors-customized-mbean-names +// Title: Customized names for Db2 connector snapshot and streaming MBean objects +=== Customized MBean names + +include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] + // Type: reference // ModuleID: debezium-oracle-connector-snapshot-metrics // Title: {prodname} Oracle connector snapshot metrics diff --git a/documentation/modules/ROOT/pages/connectors/postgresql.adoc b/documentation/modules/ROOT/pages/connectors/postgresql.adoc index dfa8a865f..e9e35576c 100644 --- a/documentation/modules/ROOT/pages/connectors/postgresql.adoc +++ b/documentation/modules/ROOT/pages/connectors/postgresql.adoc @@ -3681,7 +3681,15 @@ endif::product[] |[[postgresql-property-custom-metric-tags]]<> |`No default` -|The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: `k1=v1,k2=v2`. +|Defines tags that customize MBean object names by adding metadata that provides contextual information. +Specify a comma-separated list of key-value pairs. +Each key represents a tag for the MBean object name, and the corresponding value represents a value for the key, for example, + +`k1=v1,k2=v2` + +The connector appends the specified tags to the base MBean object name. +Tags can help you to organize and categorize metrics data. +You can define tags to identify particular application instances, environments, regions, versions, and so forth. +For more information, see xref:customized-mbean-names[Customized MBean names]. |[[postgresql-property-errors-max-retires]]<> |`-1` @@ -3731,6 +3739,13 @@ The {prodname} PostgreSQL connector provides two types of metrics that are in ad {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[{prodname} monitoring documentation] provides details for how to expose these metrics by using JMX. +/ Type: concept +// ModuleID: monitoring-debezium-postgresql-connectors-customized-mbean-names +// Title: Customized names for Db2 connector snapshot and streaming MBean objects +=== Customized MBean names + +include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] + // Type: reference // ModuleID: monitoring-debezium-during-snapshots-of-postgresql-databases // Title: Monitoring {prodname} during snapshots of PostgreSQL databases diff --git a/documentation/modules/ROOT/pages/connectors/spanner.adoc b/documentation/modules/ROOT/pages/connectors/spanner.adoc index 748992cc3..f9d3dc0f9 100644 --- a/documentation/modules/ROOT/pages/connectors/spanner.adoc +++ b/documentation/modules/ROOT/pages/connectors/spanner.adoc @@ -950,6 +950,13 @@ The {prodname} Spanner connector provides only one type of metric in addition to xref:{link-debezium-monitoring}#monitoring-debezium[{prodname} monitoring documentation] provides details for how to expose these metrics by using JMX. +// Type: concept +// ModuleID: monitoring-debezium-spanner-connectors-customized-mbean-names +// Title: Customized names for Db2 connector snapshot and streaming MBean objects +=== Customized MBean names + +include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] + // Type: reference // ModuleID: monitoring-debezium-spanner-connector-record-streaming // Title: Monitoring {prodname} Spanner connector record streaming @@ -1243,7 +1250,15 @@ The following _advanced_ configuration properties have defaults that work in mos |[[spanner-property-custom-metric-tags]]<> |`No default` -|The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: `k1=v1,k2=v2`. +|Defines tags that customize MBean object names by adding metadata that provides contextual information. +Specify a comma-separated list of key-value pairs. +Each key represents a tag for the MBean object name, and the corresponding value represents a value for the key, for example, + +`k1=v1,k2=v2` + +The connector appends the specified tags to the base MBean object name. +Tags can help you to organize and categorize metrics data. +You can define tags to identify particular application instances, environments, regions, versions, and so forth. +For more information, see xref:customized-mbean-names[Customized MBean names]. |[[spanner-property-errors-max-retires]]<> |`-1` diff --git a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc index 7d443b1ac..ee3a30628 100644 --- a/documentation/modules/ROOT/pages/connectors/sqlserver.adoc +++ b/documentation/modules/ROOT/pages/connectors/sqlserver.adoc @@ -3247,7 +3247,15 @@ endif::product[] |[[sqlserver-property-custom-metric-tags]]<> |`No default` -|The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: `k1=v1,k2=v2`. +|Defines tags that customize MBean object names by adding metadata that provides contextual information. +Specify a comma-separated list of key-value pairs. +Each key represents a tag for the MBean object name, and the corresponding value represents a value for the key, for example, + +`k1=v1,k2=v2` + +The connector appends the specified tags to the base MBean object name. +Tags can help you to organize and categorize metrics data. +You can define tags to identify particular application instances, environments, regions, versions, and so forth. +For more information, see xref:customized-mbean-names[Customized MBean names]. |[[sqlserver-property-errors-max-retires]]<> |`-1` @@ -3488,6 +3496,14 @@ The connector provides the following metrics: For information about how to expose the preceding metrics through JMX, see the {link-prefix}:{link-debezium-monitoring}#monitoring-debezium[{prodname} monitoring documentation]. +// Type: concept +// ModuleID: monitoring-debezium-sqlserver-connectors-customized-mbean-names +// Title: Customized names for Db2 connector snapshot and streaming MBean objects +[id="customized-mbean-names"] +=== Customized MBean names + +include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] + // Type: reference // ModuleID: debezium-sqlserver-connector-snapshot-metrics // Title: {prodname} SQL Server connector snapshot metrics diff --git a/documentation/modules/ROOT/pages/connectors/vitess.adoc b/documentation/modules/ROOT/pages/connectors/vitess.adoc index 06c3902ae..eda6986f1 100644 --- a/documentation/modules/ROOT/pages/connectors/vitess.adoc +++ b/documentation/modules/ROOT/pages/connectors/vitess.adoc @@ -1321,6 +1321,13 @@ The {prodname} Vitess connector provides only one type of metrics that are in ad xref:{link-debezium-monitoring}#monitoring-debezium[{prodname} monitoring documentation] provides details for how to expose these metrics by using JMX. +// Type: concept +// ModuleID: monitoring-debezium-vitess-connectors-customized-mbean-names +// Title: Customized names for Db2 connector snapshot and streaming MBean objects +=== Customized MBean names + +include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared] + // Type: reference // ModuleID: monitoring-debezium-vitess-connector-record-streaming // Title: Monitoring {prodname} Vitess connector record streaming