com.wavefront.agent.handlers.AbstractReportableEntityHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proxy Show documentation
Show all versions of proxy Show documentation
Service for batching and relaying metric traffic to Wavefront
package com.wavefront.agent.handlers;
import com.google.common.util.concurrent.RateLimiter;
import com.wavefront.agent.formatter.DataFormat;
import com.wavefront.common.NamedThreadFactory;
import com.yammer.metrics.Metrics;
import com.yammer.metrics.core.*;
import java.util.*;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicLong;
import java.util.function.BiConsumer;
import java.util.function.Function;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* Base class for all {@link ReportableEntityHandler} implementations.
*
* @author [email protected]
* @param the type of input objects handled
* @param the type of the output object as handled by {@link SenderTask}
*/
abstract class AbstractReportableEntityHandler implements ReportableEntityHandler {
private static final Logger logger =
Logger.getLogger(AbstractReportableEntityHandler.class.getCanonicalName());
protected static final MetricsRegistry LOCAL_REGISTRY = new MetricsRegistry();
protected static final String MULTICASTING_TENANT_TAG_KEY = "multicastingTenantName";
private final Logger blockedItemsLogger;
final HandlerKey handlerKey;
protected final Counter receivedCounter;
protected final Counter attemptedCounter;
protected Counter blockedCounter;
protected Counter rejectedCounter;
@SuppressWarnings("UnstableApiUsage")
final RateLimiter blockedItemsLimiter;
final Function serializer;
final Map>> senderTaskMap;
protected final boolean isMulticastingActive;
final boolean reportReceivedStats;
final String rateUnit;
final BurstRateTrackingCounter receivedStats;
final BurstRateTrackingCounter deliveredStats;
private final ScheduledThreadPoolExecutor timer;
private final AtomicLong roundRobinCounter = new AtomicLong();
protected final MetricsRegistry registry;
protected final String metricPrefix;
@SuppressWarnings("UnstableApiUsage")
private final RateLimiter noDataStatsRateLimiter = RateLimiter.create(1.0d / 60);
/**
* @param handlerKey metrics pipeline key (entity type + port number)
* @param blockedItemsPerBatch controls sample rate of how many blocked points are written into
* the main log file.
* @param serializer helper function to convert objects to string. Used when writing blocked
* points to logs.
* @param senderTaskMap map of tenant name and tasks actually handling data transfer to the
* Wavefront endpoint corresponding to the tenant name
* @param reportReceivedStats Whether we should report a .received counter metric.
* @param receivedRateSink Where to report received rate (tenant specific).
* @param blockedItemsLogger a {@link Logger} instance for blocked items
*/
AbstractReportableEntityHandler(
HandlerKey handlerKey,
final int blockedItemsPerBatch,
final Function serializer,
@Nullable final Map>> senderTaskMap,
boolean reportReceivedStats,
@Nullable final BiConsumer receivedRateSink,
@Nullable final Logger blockedItemsLogger) {
this.handlerKey = handlerKey;
//noinspection UnstableApiUsage
this.blockedItemsLimiter =
blockedItemsPerBatch == 0 ? null : RateLimiter.create(blockedItemsPerBatch / 10d);
this.serializer = serializer;
this.senderTaskMap = senderTaskMap == null ? new HashMap<>() : new HashMap<>(senderTaskMap);
this.isMulticastingActive = this.senderTaskMap.size() > 1;
this.reportReceivedStats = reportReceivedStats;
this.rateUnit = handlerKey.getEntityType().getRateUnit();
this.blockedItemsLogger = blockedItemsLogger;
this.registry = reportReceivedStats ? Metrics.defaultRegistry() : LOCAL_REGISTRY;
this.metricPrefix = handlerKey.toString();
MetricName receivedMetricName = new MetricName(metricPrefix, "", "received");
MetricName deliveredMetricName = new MetricName(metricPrefix, "", "delivered");
this.receivedCounter = registry.newCounter(receivedMetricName);
this.attemptedCounter = Metrics.newCounter(new MetricName(metricPrefix, "", "sent"));
this.receivedStats = new BurstRateTrackingCounter(receivedMetricName, registry, 1000);
this.deliveredStats = new BurstRateTrackingCounter(deliveredMetricName, registry, 1000);
registry.newGauge(
new MetricName(metricPrefix + ".received", "", "max-burst-rate"),
new Gauge() {
@Override
public Double value() {
return receivedStats.getMaxBurstRateAndClear();
}
});
this.timer = new ScheduledThreadPoolExecutor(1, new NamedThreadFactory("stats-output"));
if (receivedRateSink != null) {
timer.scheduleAtFixedRate(
() -> {
try {
for (String tenantName : senderTaskMap.keySet()) {
receivedRateSink.accept(tenantName, receivedStats.getCurrentRate());
}
} catch (Throwable e) {
logger.log(Level.WARNING, "receivedRateSink", e);
}
},
1,
1,
TimeUnit.SECONDS);
}
timer.scheduleAtFixedRate(
() -> {
try {
printStats();
} catch (Throwable e) {
logger.log(Level.WARNING, "printStats", e);
}
},
10,
10,
TimeUnit.SECONDS);
if (reportReceivedStats) {
timer.scheduleAtFixedRate(
() -> {
try {
printTotal();
} catch (Throwable e) {
logger.log(Level.WARNING, "printTotal", e);
}
},
1,
1,
TimeUnit.MINUTES);
}
}
protected void initializeCounters() {
this.blockedCounter = registry.newCounter(new MetricName(metricPrefix, "", "blocked"));
this.rejectedCounter = registry.newCounter(new MetricName(metricPrefix, "", "rejected"));
}
@Override
public void reject(@Nullable T item, @Nullable String message) {
blockedCounter.inc();
rejectedCounter.inc();
if (item != null && blockedItemsLogger != null) {
blockedItemsLogger.warning(serializer.apply(item));
}
//noinspection UnstableApiUsage
if (message != null && blockedItemsLimiter != null && blockedItemsLimiter.tryAcquire()) {
logger.info("[" + handlerKey.getHandle() + "] blocked input: [" + message + "]");
}
}
@Override
public void reject(@Nonnull String line, @Nullable String message) {
blockedCounter.inc();
rejectedCounter.inc();
if (blockedItemsLogger != null) blockedItemsLogger.warning(line);
//noinspection UnstableApiUsage
if (message != null && blockedItemsLimiter != null && blockedItemsLimiter.tryAcquire()) {
logger.info("[" + handlerKey.getHandle() + "] blocked input: [" + message + "]");
}
}
@Override
public void block(T item) {
blockedCounter.inc();
if (blockedItemsLogger != null) {
blockedItemsLogger.info(serializer.apply(item));
}
}
@Override
public void block(@Nullable T item, @Nullable String message) {
blockedCounter.inc();
if (item != null && blockedItemsLogger != null) {
blockedItemsLogger.info(serializer.apply(item));
}
if (message != null && blockedItemsLogger != null) {
blockedItemsLogger.info(message);
}
}
@Override
public void report(T item) {
try {
attemptedCounter.inc();
reportInternal(item);
} catch (IllegalArgumentException e) {
this.reject(item, e.getMessage() + " (" + serializer.apply(item) + ")");
} catch (Exception ex) {
logger.log(
Level.SEVERE,
"WF-500 Uncaught exception when handling input (" + serializer.apply(item) + ")",
ex);
}
}
@Override
public void shutdown() {
if (this.timer != null) timer.shutdown();
}
@Override
public void setLogFormat(DataFormat format) {
throw new UnsupportedOperationException();
}
abstract void reportInternal(T item);
protected Counter getReceivedCounter() {
return receivedCounter;
}
protected SenderTask getTask(String tenantName) {
if (senderTaskMap == null) {
throw new IllegalStateException("getTask() cannot be called on null senderTasks");
}
if (!senderTaskMap.containsKey(tenantName)) {
return null;
}
List> senderTasks = new ArrayList<>(senderTaskMap.get(tenantName));
// roundrobin all tasks, skipping the worst one (usually with the highest number of points)
int nextTaskId = (int) (roundRobinCounter.getAndIncrement() % senderTasks.size());
long worstScore = 0L;
int worstTaskId = 0;
for (int i = 0; i < senderTasks.size(); i++) {
long score = senderTasks.get(i).getTaskRelativeScore();
if (score > worstScore) {
worstScore = score;
worstTaskId = i;
}
}
if (nextTaskId == worstTaskId) {
nextTaskId = (int) (roundRobinCounter.getAndIncrement() % senderTasks.size());
}
return senderTasks.get(nextTaskId);
}
protected void printStats() {
// if we received no data over the last 5 minutes, only print stats once a minute
//noinspection UnstableApiUsage
if (receivedStats.getFiveMinuteCount() == 0 && !noDataStatsRateLimiter.tryAcquire()) return;
if (reportReceivedStats) {
logger.info(
"["
+ handlerKey.getHandle()
+ "] "
+ handlerKey.getEntityType().toCapitalizedString()
+ " received rate: "
+ receivedStats.getOneMinutePrintableRate()
+ " "
+ rateUnit
+ " (1 min), "
+ receivedStats.getFiveMinutePrintableRate()
+ " "
+ rateUnit
+ " (5 min), "
+ receivedStats.getCurrentRate()
+ " "
+ rateUnit
+ " (current).");
}
if (deliveredStats.getFiveMinuteCount() == 0) return;
logger.info(
"["
+ handlerKey.getHandle()
+ "] "
+ handlerKey.getEntityType().toCapitalizedString()
+ " delivered rate: "
+ deliveredStats.getOneMinutePrintableRate()
+ " "
+ rateUnit
+ " (1 min), "
+ deliveredStats.getFiveMinutePrintableRate()
+ " "
+ rateUnit
+ " (5 min)");
// we are not going to display current delivered rate because it _will_ be misinterpreted.
}
protected void printTotal() {
logger.info(
"["
+ handlerKey.getHandle()
+ "] "
+ handlerKey.getEntityType().toCapitalizedString()
+ " processed since start: "
+ this.attemptedCounter.count()
+ "; blocked: "
+ this.blockedCounter.count());
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy