io.dropwizard.metrics5.jvm.MemoryUsageGaugeSet Maven / Gradle / Ivy

package io.dropwizard.metrics5.jvm;

import io.dropwizard.metrics5.Gauge;
import io.dropwizard.metrics5.Metric;
import io.dropwizard.metrics5.MetricName;
import io.dropwizard.metrics5.MetricRegistry;
import io.dropwizard.metrics5.MetricSet;
import io.dropwizard.metrics5.RatioGauge;

import java.lang.management.ManagementFactory;
import java.lang.management.MemoryMXBean;
import java.lang.management.MemoryPoolMXBean;
import java.lang.management.MemoryUsage;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;

/**
 * A set of gauges for JVM memory usage, including stats on heap vs. non-heap memory, plus
 * GC-specific memory pools.
 */
public class MemoryUsageGaugeSet implements MetricSet {
    private static final Pattern WHITESPACE = Pattern.compile("[\\s]+");

    private final MemoryMXBean mxBean;
    private final List memoryPools;

    public MemoryUsageGaugeSet() {
        this(ManagementFactory.getMemoryMXBean(), ManagementFactory.getMemoryPoolMXBeans());
    }

    public MemoryUsageGaugeSet(MemoryMXBean mxBean,
                               Collection memoryPools) {
        this.mxBean = mxBean;
        this.memoryPools = new ArrayList<>(memoryPools);
    }

    @Override
    public Map getMetrics() {
        final Map gauges = new HashMap<>();

        gauges.put(MetricName.build("total.init"), (Gauge) () -> mxBean.getHeapMemoryUsage().getInit() +
                mxBean.getNonHeapMemoryUsage().getInit());
        gauges.put(MetricName.build("total.used"), (Gauge) () -> mxBean.getHeapMemoryUsage().getUsed() +
                mxBean.getNonHeapMemoryUsage().getUsed());
        gauges.put(MetricName.build("total.max"), (Gauge) () -> mxBean.getNonHeapMemoryUsage().getMax() == -1 ?
                -1 : mxBean.getHeapMemoryUsage().getMax() + mxBean.getNonHeapMemoryUsage().getMax());
        gauges.put(MetricName.build("total.committed"), (Gauge) () -> mxBean.getHeapMemoryUsage().getCommitted() +
                mxBean.getNonHeapMemoryUsage().getCommitted());

        gauges.put(MetricName.build("heap.init"), (Gauge) () -> mxBean.getHeapMemoryUsage().getInit());
        gauges.put(MetricName.build("heap.used"), (Gauge) () -> mxBean.getHeapMemoryUsage().getUsed());
        gauges.put(MetricName.build("heap.max"), (Gauge) () -> mxBean.getHeapMemoryUsage().getMax());
        gauges.put(MetricName.build("heap.committed"), (Gauge) () -> mxBean.getHeapMemoryUsage().getCommitted());
        gauges.put(MetricName.build("heap.usage"), new RatioGauge() {
            @Override
            protected Ratio getRatio() {
                final MemoryUsage usage = mxBean.getHeapMemoryUsage();
                return Ratio.of(usage.getUsed(), usage.getMax());
            }
        });

        gauges.put(MetricName.build("non-heap.init"), (Gauge) () -> mxBean.getNonHeapMemoryUsage().getInit());
        gauges.put(MetricName.build("non-heap.used"), (Gauge) () -> mxBean.getNonHeapMemoryUsage().getUsed());
        gauges.put(MetricName.build("non-heap.max"), (Gauge) () -> mxBean.getNonHeapMemoryUsage().getMax());
        gauges.put(MetricName.build("non-heap.committed"), (Gauge) () -> mxBean.getNonHeapMemoryUsage().getCommitted());
        gauges.put(MetricName.build("non-heap.usage"), new RatioGauge() {
            @Override
            protected Ratio getRatio() {
                final MemoryUsage usage = mxBean.getNonHeapMemoryUsage();
                return Ratio.of(usage.getUsed(), usage.getMax() == -1 ? usage.getCommitted() : usage.getMax());
            }
        });

        for (final MemoryPoolMXBean pool : memoryPools) {
            final String poolName = "pools." + WHITESPACE.matcher(pool.getName()).replaceAll("-");

            gauges.put(MetricRegistry.name(poolName, "usage"), new RatioGauge() {
                @Override
                protected Ratio getRatio() {
                    MemoryUsage usage = pool.getUsage();
                    return Ratio.of(usage.getUsed(),
                            usage.getMax() == -1 ? usage.getCommitted() : usage.getMax());
                }
            });

            gauges.put(MetricRegistry.name(poolName, "max"), (Gauge) () -> pool.getUsage().getMax());
            gauges.put(MetricRegistry.name(poolName, "used"), (Gauge) () -> pool.getUsage().getUsed());
            gauges.put(MetricRegistry.name(poolName, "committed"), (Gauge) () -> pool.getUsage().getCommitted());

            // Only register GC usage metrics if the memory pool supports usage statistics.
            if (pool.getCollectionUsage() != null) {
                gauges.put(MetricRegistry.name(poolName, "used-after-gc"), (Gauge) () ->
                        pool.getCollectionUsage().getUsed());
            }

            gauges.put(MetricRegistry.name(poolName, "init"), (Gauge) () -> pool.getUsage().getInit());
        }

        return Collections.unmodifiableMap(gauges);
    }
}