com.datastax.oss.driver.internal.core.metrics.DropwizardMetricsFactory Maven / Gradle / Ivy
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.datastax.oss.driver.internal.core.metrics;
import com.codahale.metrics.MetricRegistry;
import com.datastax.oss.driver.api.core.config.DefaultDriverOption;
import com.datastax.oss.driver.api.core.config.DriverExecutionProfile;
import com.datastax.oss.driver.api.core.context.DriverContext;
import com.datastax.oss.driver.api.core.metadata.Node;
import com.datastax.oss.driver.api.core.metadata.NodeState;
import com.datastax.oss.driver.api.core.metrics.Metrics;
import com.datastax.oss.driver.api.core.metrics.NodeMetric;
import com.datastax.oss.driver.api.core.metrics.SessionMetric;
import com.datastax.oss.driver.internal.core.context.InternalDriverContext;
import com.datastax.oss.driver.internal.core.metadata.NodeStateEvent;
import com.datastax.oss.driver.internal.core.util.concurrent.RunOrSchedule;
import edu.umd.cs.findbugs.annotations.Nullable;
import io.netty.util.concurrent.EventExecutor;
import java.util.Optional;
import java.util.Set;
import net.jcip.annotations.ThreadSafe;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@ThreadSafe
public class DropwizardMetricsFactory implements MetricsFactory {
private static final Logger LOG = LoggerFactory.getLogger(DropwizardMetricsFactory.class);
private final InternalDriverContext context;
private final Set enabledNodeMetrics;
private final MetricRegistry registry;
@Nullable private final Metrics metrics;
private final SessionMetricUpdater sessionUpdater;
public DropwizardMetricsFactory(DriverContext context) {
this.context = (InternalDriverContext) context;
String logPrefix = context.getSessionName();
DriverExecutionProfile config = context.getConfig().getDefaultProfile();
Set enabledSessionMetrics =
MetricPaths.parseSessionMetricPaths(
config.getStringList(DefaultDriverOption.METRICS_SESSION_ENABLED), logPrefix);
this.enabledNodeMetrics =
MetricPaths.parseNodeMetricPaths(
config.getStringList(DefaultDriverOption.METRICS_NODE_ENABLED), logPrefix);
if (enabledSessionMetrics.isEmpty() && enabledNodeMetrics.isEmpty()) {
LOG.debug("[{}] All metrics are disabled, Session.getMetrics will be empty", logPrefix);
this.registry = null;
this.sessionUpdater = NoopSessionMetricUpdater.INSTANCE;
this.metrics = null;
} else {
// try to get the metric registry from the context
Object possibleMetricRegistry = this.context.getMetricRegistry();
if (possibleMetricRegistry == null) {
// metrics are enabled, but a metric registry was not supplied to the context
// create a registry object
possibleMetricRegistry = new MetricRegistry();
}
if (possibleMetricRegistry instanceof MetricRegistry) {
this.registry = (MetricRegistry) possibleMetricRegistry;
DropwizardSessionMetricUpdater dropwizardSessionUpdater =
new DropwizardSessionMetricUpdater(this.context, enabledSessionMetrics, registry);
this.sessionUpdater = dropwizardSessionUpdater;
this.metrics = new DefaultMetrics(registry, dropwizardSessionUpdater);
} else {
// Metrics are enabled, but the registry object is not an expected type
throw new IllegalArgumentException(
"Unexpected Metrics registry object. Expected registry object to be of type '"
+ MetricRegistry.class.getName()
+ "', but was '"
+ possibleMetricRegistry.getClass().getName()
+ "'");
}
if (!enabledNodeMetrics.isEmpty()) {
EventExecutor adminEventExecutor =
this.context.getNettyOptions().adminEventExecutorGroup().next();
this.context
.getEventBus()
.register(
NodeStateEvent.class,
RunOrSchedule.on(adminEventExecutor, this::processNodeStateEvent));
}
}
}
@Override
public Optional getMetrics() {
return Optional.ofNullable(metrics);
}
@Override
public SessionMetricUpdater getSessionUpdater() {
return sessionUpdater;
}
@Override
public NodeMetricUpdater newNodeUpdater(Node node) {
if (registry == null) {
return NoopNodeMetricUpdater.INSTANCE;
} else {
return new DropwizardNodeMetricUpdater(node, context, enabledNodeMetrics, registry);
}
}
protected void processNodeStateEvent(NodeStateEvent event) {
if (event.newState == NodeState.DOWN
|| event.newState == NodeState.FORCED_DOWN
|| event.newState == null) {
// node is DOWN or REMOVED
((DropwizardNodeMetricUpdater) event.node.getMetricUpdater()).startMetricsExpirationTimeout();
} else if (event.newState == NodeState.UP || event.newState == NodeState.UNKNOWN) {
// node is UP or ADDED
((DropwizardNodeMetricUpdater) event.node.getMetricUpdater())
.cancelMetricsExpirationTimeout();
}
}
}