DBZ-7800 Updates property description; adds Customized MBeans topic
This commit is contained in:
parent
b8db4ab4be
commit
aeb3d7c9d7
@ -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]]<<db2-property-custom-metric-tags, `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]]<<db2-property-errors-max-retires, `errors.max.retries`>>
|
||||
|`-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
|
||||
|
@ -2635,14 +2635,15 @@ endif::community[]
|
||||
|
||||
|[[informix-property-custom-metric-tags]]<<informix-property-custom-metric-tags, `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]]<<informix-property-errors-max-retires, `errors.max.retries`>>
|
||||
|`-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
|
||||
|
@ -2213,7 +2213,15 @@ For example, if the topic prefix is `fulfillment`, the default topic name is `fu
|
||||
|
||||
|[[mongodb-property-custom-metric-tags]]<<mongodb-property-custom-metric-tags, `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]]<<mongodb-property-errors-max-retires, `errors.max.retries`>>
|
||||
|`-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
|
||||
|
@ -3897,7 +3897,15 @@ Specify one of the following options:
|
||||
|
||||
|[[mysql-property-custom-metric-tags]]<<mysql-property-custom-metric-tags, `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]]<<mysql-property-errors-max-retires, `errors.max.retries`>>
|
||||
|`-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
|
||||
|
@ -4154,7 +4154,15 @@ By default, no additional retries will be performed.
|
||||
|
||||
|[[oracle-property-custom-metric-tags]]<<oracle-property-custom-metric-tags, `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]]<<oracle-property-errors-max-retires, `errors.max.retries`>>
|
||||
|`-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
|
||||
|
@ -3681,7 +3681,15 @@ endif::product[]
|
||||
|
||||
|[[postgresql-property-custom-metric-tags]]<<postgresql-property-custom-metric-tags, `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]]<<postgresql-property-errors-max-retires, `errors.max.retries`>>
|
||||
|`-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
|
||||
|
@ -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]]<<spanner-property-custom-metric-tags, `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]]<<spanner-property-errors-max-retires, `errors.max.retries`>>
|
||||
|`-1`
|
||||
|
@ -3247,7 +3247,15 @@ endif::product[]
|
||||
|
||||
|[[sqlserver-property-custom-metric-tags]]<<sqlserver-property-custom-metric-tags, `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]]<<sqlserver-property-errors-max-retires, `errors.max.retries`>>
|
||||
|`-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
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user