Skip to content
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

CNDB 12702: Allow custom internode inbound metrics #1543

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+75 −54
Open

CNDB 12702: Allow custom internode inbound metrics #1543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
347a24f
CNDB 12702: Allow custom internode inbound metrics
driftx Feb 3, 2025
54c16f0
make InternodeInboundMetrics metrics public, track Gauges instead of
driftx Feb 3, 2025
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
6 changes: 6 additions & 0 deletions src/java/org/apache/cassandra/config/CassandraRelevantProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,12 @@ public enum CassandraRelevantProperties
/** Which class to use for coordinator client request metrics */
CUSTOM_CLIENT_REQUEST_METRICS_PROVIDER_PROPERTY("cassandra.custom_client_request_metrics_provider_class"),

/**
* Which class to use for internode metrics for {@link org.apache.cassandra.net.OutboundConnections}.
* The provided class name must point to an implementation of {@link org.apache.cassandra.metrics.InternodeOutboundMetrics}.
*/
CUSTOM_INTERNODE_INBOUND_METRICS_PROVIDER_PROPERTY("cassandra.custom_internode_inbound_metrics_provider_class"),

/**
* Which class to use for messaging metrics for {@link org.apache.cassandra.net.MessagingService}.
* The provided class name must point to an implementation of {@link org.apache.cassandra.metrics.MessagingMetrics}.
Expand Down
99 changes: 46 additions & 53 deletions src/java/org/apache/cassandra/metrics/InternodeInboundMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,29 @@
import com.codahale.metrics.Gauge;
import org.apache.cassandra.locator.InetAddressAndPort;
import org.apache.cassandra.net.InboundMessageHandlers;
import org.apache.cassandra.metrics.CassandraMetricsRegistry.MetricName;
import static org.apache.cassandra.metrics.CassandraMetricsRegistry.Metrics;

/**
* Metrics for internode connections.
*/
public class InternodeInboundMetrics
{
private final MetricName corruptFramesRecovered;
private final MetricName corruptFramesUnrecovered;
private final MetricName errorBytes;
private final MetricName errorCount;
private final MetricName expiredBytes;
private final MetricName expiredCount;
private final MetricName pendingBytes;
private final MetricName pendingCount;
private final MetricName processedBytes;
private final MetricName processedCount;
private final MetricName receivedBytes;
private final MetricName receivedCount;
private final MetricName throttledCount;
private final MetricName throttledNanos;
public final Gauge<Long> corruptFramesRecovered;
public final Gauge<Long> corruptFramesUnrecovered;
public final Gauge<Long> errorBytes;
public final Gauge<Long> errorCount;
public final Gauge<Long> expiredBytes;
public final Gauge<Long> expiredCount;
public final Gauge<Long> pendingBytes;
public final Gauge<Long> pendingCount;
public final Gauge<Long> processedBytes;
public final Gauge<Long> processedCount;
public final Gauge<Long> receivedBytes;
public final Gauge<Long> receivedCount;
public final Gauge<Long> throttledCount;
public final Gauge<Long> throttledNanos;

private final MetricNameFactory factory;

/**
* Create metrics for given inbound message handlers.
Expand All @@ -50,49 +52,40 @@ public class InternodeInboundMetrics
public InternodeInboundMetrics(InetAddressAndPort peer, InboundMessageHandlers handlers)
{
// ipv6 addresses will contain colons, which are invalid in a JMX ObjectName
MetricNameFactory factory = new DefaultNameFactory("InboundConnection", peer.getHostAddressAndPortForJMX());
factory = new DefaultNameFactory("InboundConnection", peer.getHostAddressAndPortForJMX());

register(corruptFramesRecovered = factory.createMetricName("CorruptFramesRecovered"), handlers::corruptFramesRecovered);
register(corruptFramesUnrecovered = factory.createMetricName("CorruptFramesUnrecovered"), handlers::corruptFramesUnrecovered);
register(errorBytes = factory.createMetricName("ErrorBytes"), handlers::errorBytes);
register(errorCount = factory.createMetricName("ErrorCount"), handlers::errorCount);
register(expiredBytes = factory.createMetricName("ExpiredBytes"), handlers::expiredBytes);
register(expiredCount = factory.createMetricName("ExpiredCount"), handlers::expiredCount);
register(pendingBytes = factory.createMetricName("ScheduledBytes"), handlers::scheduledBytes);
register(pendingCount = factory.createMetricName("ScheduledCount"), handlers::scheduledCount);
register(processedBytes = factory.createMetricName("ProcessedBytes"), handlers::processedBytes);
register(processedCount = factory.createMetricName("ProcessedCount"), handlers::processedCount);
register(receivedBytes = factory.createMetricName("ReceivedBytes"), handlers::receivedBytes);
register(receivedCount = factory.createMetricName("ReceivedCount"), handlers::receivedCount);
register(throttledCount = factory.createMetricName("ThrottledCount"), handlers::throttledCount);
register(throttledNanos = factory.createMetricName("ThrottledNanos"), handlers::throttledNanos);
corruptFramesRecovered = Metrics.register(factory.createMetricName("CorruptFramesRecovered"), handlers::corruptFramesRecovered);
corruptFramesUnrecovered = Metrics.register(factory.createMetricName("CorruptFramesUnrecovered"), handlers::corruptFramesUnrecovered);
errorBytes = Metrics.register(factory.createMetricName("ErrorBytes"), handlers::errorBytes);
errorCount = Metrics.register(factory.createMetricName("ErrorCount"), handlers::errorCount);
expiredBytes = Metrics.register(factory.createMetricName("ExpiredBytes"), handlers::expiredBytes);
expiredCount = Metrics.register(factory.createMetricName("ExpiredCount"), handlers::expiredCount);
pendingBytes = Metrics.register(factory.createMetricName("ScheduledBytes"), handlers::scheduledBytes);
pendingCount = Metrics.register(factory.createMetricName("ScheduledCount"), handlers::scheduledCount);
processedBytes = Metrics.register(factory.createMetricName("ProcessedBytes"), handlers::processedBytes);
processedCount = Metrics.register(factory.createMetricName("ProcessedCount"), handlers::processedCount);
receivedBytes = Metrics.register(factory.createMetricName("ReceivedBytes"), handlers::receivedBytes);
receivedCount = Metrics.register(factory.createMetricName("ReceivedCount"), handlers::receivedCount);
throttledCount = Metrics.register(factory.createMetricName("ThrottledCount"), handlers::throttledCount);
throttledNanos = Metrics.register(factory.createMetricName("ThrottledNanos"), handlers::throttledNanos);
}

public void release()
{
remove(corruptFramesRecovered);
remove(corruptFramesUnrecovered);
remove(errorBytes);
remove(errorCount);
remove(expiredBytes);
remove(expiredCount);
remove(pendingBytes);
remove(pendingCount);
remove(processedBytes);
remove(processedCount);
remove(receivedBytes);
remove(receivedCount);
remove(throttledCount);
remove(throttledNanos);
}

private static void register(MetricName name, Gauge gauge)
{
CassandraMetricsRegistry.Metrics.register(name, gauge);
Metrics.remove(factory.createMetricName("CorruptFramesRecovered"));
Metrics.remove(factory.createMetricName("CorruptFramesUnrecovered"));
Metrics.remove(factory.createMetricName("ErrorBytes"));
Metrics.remove(factory.createMetricName("ErrorCount"));
Metrics.remove(factory.createMetricName("ExpiredBytes"));
Metrics.remove(factory.createMetricName("ExpiredCount"));
Metrics.remove(factory.createMetricName("PendingBytes"));
Metrics.remove(factory.createMetricName("PendingCount"));
Metrics.remove(factory.createMetricName("ProcessedBytes"));
Metrics.remove(factory.createMetricName("ProcessedCount"));
Metrics.remove(factory.createMetricName("ReceivedBytes"));
Metrics.remove(factory.createMetricName("ReceivedCount"));
Metrics.remove(factory.createMetricName("ThrottledCount"));
Metrics.remove(factory.createMetricName("ThrottledNanos"));
}

private static void remove(MetricName name)
{
CassandraMetricsRegistry.Metrics.remove(name);
}
}
24 changes: 23 additions & 1 deletion src/java/org/apache/cassandra/net/InboundMessageHandlers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
*/
package org.apache.cassandra.net;

import java.lang.reflect.InvocationTargetException;
import java.util.Collection;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.TimeUnit;
Expand All @@ -30,6 +31,9 @@
import org.apache.cassandra.locator.InetAddressAndPort;
import org.apache.cassandra.metrics.InternodeInboundMetrics;
import org.apache.cassandra.net.Message.Header;
import org.apache.cassandra.utils.FBUtilities;

import static org.apache.cassandra.config.CassandraRelevantProperties.CUSTOM_INTERNODE_INBOUND_METRICS_PROVIDER_PROPERTY;

/**
* An aggregation of {@link InboundMessageHandler}s for all connections from a peer.
Expand Down Expand Up @@ -128,7 +132,25 @@ public InboundMessageHandlers(InetAddressAndPort self,
largeCallbacks = makeMessageCallbacks(peer, largeCounters, globalMetricCallbacks, messageConsumer);
legacyCallbacks = makeMessageCallbacks(peer, legacyCounters, globalMetricCallbacks, messageConsumer);

metrics = new InternodeInboundMetrics(peer, this);
if (CUSTOM_INTERNODE_INBOUND_METRICS_PROVIDER_PROPERTY.isPresent())
{
Class<InternodeInboundMetrics> klass = FBUtilities.classForName(CUSTOM_INTERNODE_INBOUND_METRICS_PROVIDER_PROPERTY.getString(), "Internode Inbound Metrics Provider");
InternodeInboundMetrics ibInstance;
try
{
ibInstance = klass.getDeclaredConstructor(InetAddressAndPort.class, InboundMessageHandlers.class).newInstance(peer, this);
}
catch (NoSuchMethodException | InstantiationException | IllegalAccessException |
InvocationTargetException e)
{
throw new RuntimeException(e);
}
metrics = ibInstance;
}
else
{
metrics = new InternodeInboundMetrics(peer, this);
}
}

InboundMessageHandler createHandler(FrameDecoder frameDecoder, ConnectionType type, Channel channel, int version)
Expand Down