[HBASE-26891] Make MetricsConnection scope configurable

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.5.0, 3.0.0-alpha-3
• Labels: patch-available

Release Note

Adds a new "hbase.client.metrics.scope" config which allows users to define a custom scope for each Connection's metric instance. The default scope has also been changed to include the clusterId of the Connection, which should help differentiate metrics for processes connecting to multiple clusters. The scope is added to the ObjectName for JMX beans, so can be used to query for metrics for a particular connection. Using a custom scope might be useful in cases where you maintain separate Connections for writes vs reads. In that case you can set the scope appropriately and differentiate metrics for each.

• Assignee: Bryan Beaudreault
• Reporter: Bryan Beaudreault
• Created: 26/Mar/22 14:05
• Updated: 23/Apr/22 19:32
• Resolved: 22/Apr/22 16:03

Description

Currently MetricsConnection scope is just the connection.toString(), which is typically the default toString() implementation for an object. This is not very useful for identifying different connections in processes that might connect to multiple clusters or maintain different connections to the same cluster.

We can add a new config param "hbase.client.metrics.scope" which defaults to connection.toString().

Issue Links

• links to: GitHub Pull Request #4285
• links to: GitHub Pull Request #4365