Skip to content

HDDS-8923. Expose XceiverClient cache stats as metrics #4979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adoroszlai merged 5 commits into from
Jun 27, 2023
Merged

HDDS-8923. Expose XceiverClient cache stats as metrics #4979

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bbd7280
HDDS-8923. Expose XceiverClient cache stats as metrics
adoroszlai Jun 25, 2023
c55bc19
close XceiverClientManager in TestECBlockOutputStreamEntry
adoroszlai Jun 26, 2023
081745d
use unique source name for CacheMetrics instances
adoroszlai Jun 26, 2023
9549140
remove duplicate constant in CacheMetrics
adoroszlai Jun 26, 2023
0605709
Invalid character : in value part of property
adoroszlai Jun 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions hadoop-hdds/client/src/main/java/org/apache/hadoop/hdds/scm/XceiverClientManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@
import static org.apache.hadoop.hdds.conf.ConfigTag.OZONE;
import static org.apache.hadoop.hdds.conf.ConfigTag.PERFORMANCE;
import static org.apache.hadoop.hdds.scm.exceptions.SCMException.ResultCodes.NO_REPLICA_FOUND;

import org.apache.hadoop.util.CacheMetrics;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand All @@ -68,6 +70,7 @@ public class XceiverClientManager implements Closeable, XceiverClientFactory {
private final ConfigurationSource conf;
private final ScmClientConfig clientConfig;
private final Cache<String, XceiverClientSpi> clientCache;
private final CacheMetrics cacheMetrics;
private List<X509Certificate> caCerts;

private static XceiverClientMetrics metrics;
Expand Down Expand Up @@ -99,6 +102,7 @@ public XceiverClientManager(ConfigurationSource conf,
}

this.clientCache = CacheBuilder.newBuilder()
.recordStats()
.expireAfterAccess(staleThresholdMs, MILLISECONDS)
.maximumSize(clientConf.getMaxSize())
.removalListener(
Expand All @@ -117,6 +121,8 @@ public void onRemoval(
topologyAwareRead = conf.getBoolean(
OzoneConfigKeys.OZONE_NETWORK_TOPOLOGY_AWARE_READ_KEY,
OzoneConfigKeys.OZONE_NETWORK_TOPOLOGY_AWARE_READ_DEFAULT);

cacheMetrics = CacheMetrics.create(clientCache, this);
}

@VisibleForTesting
Expand Down Expand Up @@ -278,6 +284,10 @@ public void close() {
//closing is done through RemovalListener
clientCache.invalidateAll();
clientCache.cleanUp();
if (LOG.isDebugEnabled()) {
LOG.debug("XceiverClient cache stats: {}", clientCache.stats());
}
cacheMetrics.unregister();

if (metrics != null) {
metrics.unRegister();
Expand Down
18 changes: 13 additions & 5 deletions hadoop-hdds/common/src/main/java/org/apache/hadoop/util/CacheMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,13 @@
import org.apache.hadoop.metrics2.MetricsSource;
import org.apache.hadoop.metrics2.MetricsSystem;
import org.apache.hadoop.metrics2.lib.DefaultMetricsSystem;
import org.apache.ratis.util.JavaUtils;

/**
* Reusable component that emits cache metrics for a particular cache.
*/
public final class CacheMetrics implements MetricsSource {

enum CacheMetricsInfo implements MetricsInfo {
CacheName("Cache Metrics."),
Size("Size of the cache."),
Expand Down Expand Up @@ -58,20 +60,26 @@ public String description() {
public static final String SOURCE_NAME =
CacheMetrics.class.getSimpleName();

public static final String NAME = CacheMetrics.class.getSimpleName();

private final Cache<?, ?> cache;
private final String name;
private final String sourceName;

private CacheMetrics(Cache<?, ?> cache, String name) {
this.cache = cache;
this.name = name;
sourceName = SOURCE_NAME + "-" + name;
}

public static CacheMetrics create(Cache<?, ?> cache, Object owner) {
final String name = JavaUtils.getClassSimpleName(owner.getClass())
+ "@" + Integer.toHexString(owner.hashCode());
return create(cache, name);
}

public static CacheMetrics create(Cache<?, ?> cache, String name) {
MetricsSystem ms = DefaultMetricsSystem.instance();
return ms.register(NAME, "Cache Metrics",
new CacheMetrics(cache, name));
CacheMetrics source = new CacheMetrics(cache, name);
return ms.register(source.sourceName, "Cache Metrics", source);
}

@Override
Expand All @@ -98,6 +106,6 @@ public void getMetrics(MetricsCollector collector, boolean all) {

public void unregister() {
MetricsSystem ms = DefaultMetricsSystem.instance();
ms.unregisterSource(NAME);
ms.unregisterSource(sourceName);
}
}
64 changes: 34 additions & 30 deletions .../client/src/test/java/org/apache/hadoop/ozone/client/io/TestECBlockOutputStreamEntry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,21 +60,22 @@ public class TestECBlockOutputStreamEntry {
.setState(Pipeline.PipelineState.OPEN)
.setNodes(nodes)
.build();
XceiverClientManager manager =
new XceiverClientManager(new OzoneConfiguration());
HashSet<XceiverClientSpi> clients = new HashSet<>();
ECBlockOutputStreamEntry entry = new ECBlockOutputStreamEntry.Builder()
.setXceiverClientManager(manager)
.setPipeline(anECPipeline)
.build();
for (int i = 0; i < nodes.size(); i++) {
clients.add(
manager.acquireClient(
entry.createSingleECBlockPipeline(
anECPipeline, nodes.get(i), i
)));
try (XceiverClientManager manager =
new XceiverClientManager(new OzoneConfiguration())) {
HashSet<XceiverClientSpi> clients = new HashSet<>();
ECBlockOutputStreamEntry entry = new ECBlockOutputStreamEntry.Builder()
.setXceiverClientManager(manager)
.setPipeline(anECPipeline)
.build();
for (int i = 0; i < nodes.size(); i++) {
clients.add(
manager.acquireClient(
entry.createSingleECBlockPipeline(
anECPipeline, nodes.get(i), i
)));
}
assertEquals(5, clients.size());
}
assertEquals(5, clients.size());
}

@Test
Expand All @@ -97,23 +98,26 @@ public class TestECBlockOutputStreamEntry {
.setState(Pipeline.PipelineState.OPEN)
.setNodes(nodes)
.build();
XceiverClientManager manager =
new XceiverClientManager(new OzoneConfiguration());
HashSet<XceiverClientSpi> clients = new HashSet<>();
ECBlockOutputStreamEntry entry = new ECBlockOutputStreamEntry.Builder()
.setXceiverClientManager(manager)
.setPipeline(anECPipeline)
.build();
for (int i = 0; i < nodes.size(); i++) {
clients.add(
manager.acquireClient(
entry.createSingleECBlockPipeline(
anECPipeline, nodes.get(i), i
)));
try (XceiverClientManager manager =
new XceiverClientManager(new OzoneConfiguration())) {
HashSet<XceiverClientSpi> clients = new HashSet<>();
ECBlockOutputStreamEntry entry = new ECBlockOutputStreamEntry.Builder()
.setXceiverClientManager(manager)
.setPipeline(anECPipeline)
.build();
for (int i = 0; i < nodes.size(); i++) {
clients.add(
manager.acquireClient(
entry.createSingleECBlockPipeline(
anECPipeline, nodes.get(i), i
)));
}
assertEquals(3, clients.size());
assertEquals(1,
clients.stream().filter(c -> c.getRefcount() == 3).count());
assertEquals(2,
clients.stream().filter(c -> c.getRefcount() == 1).count());
}
assertEquals(3, clients.size());
assertEquals(1, clients.stream().filter(c -> c.getRefcount() == 3).count());
assertEquals(2, clients.stream().filter(c -> c.getRefcount() == 1).count());
}

private DatanodeDetails aNode(String ip, String hostName, int port) {
Expand Down