com.hazelcast.internal.diagnostics.MetricsPlugin Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
*
* Licensed 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.hazelcast.internal.diagnostics;
import com.hazelcast.internal.metrics.MetricDescriptor;
import com.hazelcast.internal.metrics.MetricsRegistry;
import com.hazelcast.internal.metrics.collectors.MetricsCollector;
import com.hazelcast.logging.ILogger;
import com.hazelcast.spi.impl.NodeEngineImpl;
import com.hazelcast.spi.properties.ClusterProperty;
import com.hazelcast.spi.properties.HazelcastProperties;
import com.hazelcast.spi.properties.HazelcastProperty;
import static com.hazelcast.internal.metrics.MetricTarget.DIAGNOSTICS;
import static java.util.concurrent.TimeUnit.SECONDS;
/**
* A {@link DiagnosticsPlugin} that displays the content of the
* {@link MetricsRegistry}.
*/
public class MetricsPlugin extends DiagnosticsPlugin {
/**
* The period in seconds the {@link MetricsPlugin} runs.
*
* The MetricsPlugin periodically writes the contents of the MetricsRegistry
* to the logfile. For debugging purposes make sure
* {@link ClusterProperty#METRICS_DEBUG} is set to {@code true}.
*
* This plugin is very cheap to use.
*
* If set to 0, the plugin is disabled.
*/
public static final HazelcastProperty PERIOD_SECONDS
= new HazelcastProperty("hazelcast.diagnostics.metrics.period.seconds", 60, SECONDS);
private final MetricsRegistry metricsRegistry;
private final long periodMillis;
private final MetricsCollectorImpl metricCollector = new MetricsCollectorImpl();
public MetricsPlugin(NodeEngineImpl nodeEngine) {
this(nodeEngine.getLogger(MetricsPlugin.class), nodeEngine.getMetricsRegistry(), nodeEngine.getProperties());
}
public MetricsPlugin(ILogger logger, MetricsRegistry metricsRegistry, HazelcastProperties properties) {
super(logger);
this.metricsRegistry = metricsRegistry;
this.periodMillis = properties.getMillis(PERIOD_SECONDS);
}
@Override
public void onStart() {
logger.info("Plugin:active, period-millis:" + periodMillis);
}
@Override
public long getPeriodMillis() {
return periodMillis;
}
@Override
public void run(DiagnosticsLogWriter writer) {
metricCollector.writer = writer;
// we set the time explicitly so that for this particular rendering of the probes, all metrics have exactly
// the same timestamp
metricCollector.timeMillis = System.currentTimeMillis();
metricsRegistry.collect(metricCollector);
metricCollector.writer = null;
}
private static class MetricsCollectorImpl implements MetricsCollector {
private static final String SECTION_NAME = "Metric";
private DiagnosticsLogWriter writer;
private long timeMillis;
@Override
public void collectLong(MetricDescriptor descriptor, long value) {
if (descriptor.isTargetIncluded(DIAGNOSTICS)) {
writer.writeSectionKeyValue(SECTION_NAME, timeMillis, descriptor.metricString(), value);
}
}
@Override
public void collectDouble(MetricDescriptor descriptor, double value) {
if (descriptor.isTargetIncluded(DIAGNOSTICS)) {
writer.writeSectionKeyValue(SECTION_NAME, timeMillis, descriptor.metricString(), value);
}
}
@Override
public void collectException(MetricDescriptor descriptor, Exception e) {
if (descriptor.isTargetIncluded(DIAGNOSTICS)) {
writer.writeSectionKeyValue(SECTION_NAME, timeMillis, descriptor.metricString(),
e.getClass().getName() + ':' + e.getMessage());
}
}
@Override
public void collectNoValue(MetricDescriptor descriptor) {
if (descriptor.isTargetIncluded(DIAGNOSTICS)) {
writer.writeSectionKeyValue(SECTION_NAME, timeMillis, descriptor.metricString(), "NA");
}
}
}
}