DBZ-6603 added the custom.metric.tags property, which permits you to specify a list of key-value pairs to customize the names of connector MBean objects.
This issue provides the following changes:

• Supplements the description of the custom.metric.tags property that was provided in the original commit (#4652).
• Adds a new topic, Customizing MBean names to the beginning of the Monitoring chapter in each of the connector docs that provides details about how and why you might add tags to customize MBean names. ⁺

This change affects the documentation for the following Debezium connectors:

• cassandra (Although the custom.metric.tags is present in the properties table, the Monitoring section of the doc does not mention the use of MBeans. Omitting this update for now.
• db2
• informix
• mongodb
• mysql
• oracle
• postgresql
• spanner
• sqlserver
• vitess

⁺ At present the information about how we construct the default MBean name exists in the shared partials file frag-common-mbean-name.adoc with the information for the snapshot and streaming MBeans for each connector placed in one of the following tagged regions :

• Common
• MongoDB
• SQL Server

Ideally, to maintain reuse and modularity, the proposed new topic should be written once, and then shared across all of the connectors. To accomplish this:

1. Add the content for the new topic to the existing shared file, outside of the existing tagged regions, in a new tagged region, called Shared (tag::mbeans-shared[]).
2. In each of the individual connector files, add a new third-level topic heading, Customizing MBean names just before the existing Snapshot metrics heading.
3. Within the new topic in the connector files, as the sole content, add the following include directive:

include::{partialsdir}/modules/all-connectors/frag-common-mbean-name.adoc[leveloffset=+1,tags=mbeans-shared]

The existing include directives within the Snapshot metrics and Streaming metrics topics remain as-is.
#