com.alibaba.metrics.os.linux.SystemMemoryGaugeSet Maven / Gradle / Ivy

Go to download
/*
 * 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.alibaba.metrics.os.linux;

import com.alibaba.metrics.CachedMetricSet;
import com.alibaba.metrics.Clock;
import com.alibaba.metrics.Gauge;
import com.alibaba.metrics.Metric;
import com.alibaba.metrics.MetricName;
import com.alibaba.metrics.PersistentGauge;
import com.alibaba.metrics.RatioGauge;
import com.alibaba.metrics.os.utils.FileUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;

/**
 * A gauge set that is collecting system memory metrics
 */
public class SystemMemoryGaugeSet extends CachedMetricSet {

    private static final Logger logger = LoggerFactory.getLogger(SystemMemoryGaugeSet.class);

    /**
     * Detail explanation for /proc/meminfo can be found here:
     *   https://access.redhat.com/solutions/406773
     */
    private static final String DEFAULT_FILE_PATH = "/proc/meminfo";

    private static final String SPACE_REGEX = "\\s+";

    /**
     * The equation: MemUsed = MemTotal - (MemFree + Buffers + Cached)
     */
    private static final String[] METRICS = {
            "mem.total",      // MemTotal
            "mem.used",       // MemTotal - (MemFree + Buffers + Cached)
            "mem.free",       // MemFree
            "mem.buffers",    // Buffers
            "mem.cached",     // Cached
            "mem.swap.total", // SwapTotal
            "mem.swap.used",  // SwapTotal - SwapFree
            "mem.swap.free",  // SwapFree
    };

    private String filePath;

    private long[] data;

    private Map gauges;

    public SystemMemoryGaugeSet() {
        this(DEFAULT_FILE_PATH, DEFAULT_DATA_TTL, TimeUnit.MILLISECONDS, Clock.defaultClock());
    }

    public SystemMemoryGaugeSet(String filePath) {
        this(filePath, DEFAULT_DATA_TTL, TimeUnit.MILLISECONDS, Clock.defaultClock());
    }

    public SystemMemoryGaugeSet(long dataTTL, TimeUnit unit) {
        this(DEFAULT_FILE_PATH, dataTTL, unit, Clock.defaultClock());
    }

    public SystemMemoryGaugeSet(String filePath, long dataTTL, TimeUnit unit, Clock clock) {
        super(dataTTL, unit, clock);
        this.filePath = filePath;
        this.data = new long[METRICS.length];
        this.gauges = new HashMap();
        populateGauges();
    }

    @Override
    protected void getValueInternal() {
        try {
            List lines = FileUtils.readFileAsStringArray(filePath);
            for (String line: lines) {
                if (line.startsWith("MemTotal:")) {
                    data[0] = Long.parseLong(line.split(SPACE_REGEX)[1]);
                } else if (line.startsWith("MemFree:")) {
                    data[2] = Long.parseLong(line.split(SPACE_REGEX)[1]);
                } else if (line.startsWith("Buffers:")) {
                    data[3] = Long.parseLong(line.split(SPACE_REGEX)[1]);
                } else if (line.startsWith("Cached:")) {
                    data[4] = Long.parseLong(line.split(SPACE_REGEX)[1]);
                } else if (line.startsWith("SwapTotal:")) {
                    data[5] = Long.parseLong(line.split(SPACE_REGEX)[1]);
                } else if (line.startsWith("SwapFree:")) {
                    data[7] = Long.parseLong(line.split(SPACE_REGEX)[1]);
                }
            }
            // calculate mem.used
            data[1] = data[0] - data[2] - data[3] - data[4];
            // calculate mem.swap.used
            data[6] = data[5] - data[7];
        } catch (IOException e) {
            logger.warn("Error during reading file {}", filePath, e);
        }
    }

    @Override
    public Map getMetrics() {
        return gauges;
    }

    private void populateGauges() {
        for (int i = 0; i < METRICS.length; i++) {
            gauges.put(MetricName.build(METRICS[i]), new MemGauge(i));
        }

        final RatioGauge usedRatio = new RatioGauge() {
            @Override
            @SuppressWarnings("unchecked")
            protected Ratio getRatio() {
                Gauge memUsed = (Gauge)gauges.get(MetricName.build("mem.used"));
                Gauge memTotal = (Gauge)gauges.get(MetricName.build("mem.total"));
                return Ratio.of(memUsed.getValue().doubleValue(), memTotal.getValue().doubleValue());
            }
        };

        gauges.put(MetricName.build("mem.used_ratio"), usedRatio);
    }

    private class MemGauge extends PersistentGauge {

        private int index;

        public MemGauge(int index) {
            this.index = index;
        }

        @Override
        public Long getValue() {
            try {
                refreshIfNecessary();
                return data[index];
            } catch (Exception e) {
                return 0L;
            }
        }
    }
}