com.ringcentral.platform.metrics.producers.labeled.LabeledOperatingSystemMetricsProducer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of metrics-facade-base Show documentation
The newest version!
package com.ringcentral.platform.metrics.producers.labeled;

import com.ringcentral.platform.metrics.MetricModBuilder;
import com.ringcentral.platform.metrics.MetricRegistry;
import com.ringcentral.platform.metrics.labels.Label;
import com.ringcentral.platform.metrics.labels.LabelValues;
import com.ringcentral.platform.metrics.names.MetricName;
import com.ringcentral.platform.metrics.producers.AbstractOperatingSystemMetricsProducer;
import com.ringcentral.platform.metrics.var.Var;
import com.sun.management.OperatingSystemMXBean;

import static com.ringcentral.platform.metrics.labels.LabelValues.labelValues;
import static java.lang.management.ManagementFactory.getOperatingSystemMXBean;
import static java.util.Objects.requireNonNull;

/**
 * Produces

 * 
 *     
 *         swapSpaceSize - the amount of swap memory in bytes.

 *         Labels:

 *         type = {"free", "total"}

 *     
 *     
 *         physicalMemorySize - the amount of physical memory in bytes.

 *         Labels:

 *         type = {"free", "total"}

 *     
 *     
 *         cpuLoad - the 'recent cpu usage' for the process of corresponding type.

 *         Labels:

 *         type = {"system", "process"}

 *     
 *     systemLoadAverage - the system load average for the last minute.

 *     processCpuTime - the CPU time used by the process on which the Java virtual machine is running in nanoseconds.

 *     committedVirtualMemorySize - the amount of virtual memory that is guaranteed to be available to the running process in bytes.

 *     availableProcessors - the number of processors available to the Java virtual machine.

 *     descriptor.file.open.total - the number of open file descriptors.

 *     descriptor.file.limit.total - the maximum number of file descriptors.

 *     descriptor.file.usage.ratio - the number of open file descriptors divided by the maximum number of file descriptors.

 * 
 *
 * All metrics have a name prefix. By default it is 'OperatingSystem'.

 * 

 * Example of usage:
 *  * MetricRegistry registry = new DefaultMetricRegistry();
 * new LabeledOperatingSystemMetricsProducer().produceMetrics(registry);
 * PrometheusMetricsExporter exporter = new PrometheusMetricsExporter(registry);
 * System.out.println(exporter.exportMetrics());
 * 
 * Corresponding output:
 *  * # HELP OperatingSystem_swapSpaceSize The amount of swap memory in bytes
 * # TYPE OperatingSystem_swapSpaceSize gauge
 * OperatingSystem_swapSpaceSize{type="free",} 8.59570176E8
 * OperatingSystem_swapSpaceSize{type="total",} 2.147483648E9
 * # HELP OperatingSystem_descriptor_file_open_total The number of open file descriptors
 * # TYPE OperatingSystem_descriptor_file_open_total gauge
 * OperatingSystem_descriptor_file_open_total 25.0
 * # HELP OperatingSystem_physicalMemorySize The amount of physical memory in bytes
 * # TYPE OperatingSystem_physicalMemorySize gauge
 * OperatingSystem_physicalMemorySize{type="free",} 3.9356416E8
 * OperatingSystem_physicalMemorySize{type="total",} 1.7179869184E10
 * # HELP OperatingSystem_systemLoadAverage The system load average for the last minute
 * # TYPE OperatingSystem_systemLoadAverage gauge
 * OperatingSystem_systemLoadAverage 2.8427734375
 * # HELP OperatingSystem_cpuLoad The 'recent cpu usage' for the process of corresponding type
 * # TYPE OperatingSystem_cpuLoad gauge
 * OperatingSystem_cpuLoad{type="system",} 0.0
 * OperatingSystem_cpuLoad{type="process",} 0.0
 * # HELP OperatingSystem_descriptor_file_limit_total The maximum number of file descriptors
 * # TYPE OperatingSystem_descriptor_file_limit_total gauge
 * OperatingSystem_descriptor_file_limit_total 10240.0
 * # HELP OperatingSystem_descriptor_file_usage_ratio The number of open file descriptors divided by the maximum number of file descriptors
 * # TYPE OperatingSystem_descriptor_file_usage_ratio gauge
 * OperatingSystem_descriptor_file_usage_ratio 0.00244140625
 * # HELP OperatingSystem_processCpuTime The CPU time used by the process on which the Java virtual machine is running in nanoseconds
 * # TYPE OperatingSystem_processCpuTime gauge
 * OperatingSystem_processCpuTime 5.24424E8
 * # HELP OperatingSystem_committedVirtualMemorySize The amount of virtual memory that is guaranteed to be available to the running process in bytes
 * # TYPE OperatingSystem_committedVirtualMemorySize gauge
 * OperatingSystem_committedVirtualMemorySize 1.0547204096E10
 * # HELP OperatingSystem_availableProcessors The number of processors available to the Java virtual machine
 * # TYPE OperatingSystem_availableProcessors gauge
 * OperatingSystem_availableProcessors 12.0
 * 
 */
public class LabeledOperatingSystemMetricsProducer extends AbstractOperatingSystemMetricsProducer {

    private static final Label TYPE_LABEL = new Label("type");
    private static final LabelValues SYSTEM_TYPE_LABEL_VALUES = labelValues(TYPE_LABEL.value("system"));
    private static final LabelValues PROCESS_TYPE_LABEL_VALUES = labelValues(TYPE_LABEL.value("process"));
    private static final LabelValues TOTAL_TYPE_LABEL_VALUES = labelValues(TYPE_LABEL.value("total"));
    private static final LabelValues FREE_TYPE_LABEL_VALUES = labelValues(TYPE_LABEL.value("free"));

    public LabeledOperatingSystemMetricsProducer() {
        this(DEFAULT_NAME_PREFIX);
    }

    public LabeledOperatingSystemMetricsProducer(MetricName namePrefix) {
        this(namePrefix, null);
    }

    public LabeledOperatingSystemMetricsProducer(MetricName namePrefix, MetricModBuilder metricModBuilder) {
        this(namePrefix, metricModBuilder, (OperatingSystemMXBean) getOperatingSystemMXBean());
    }

    public LabeledOperatingSystemMetricsProducer(MetricName namePrefix, MetricModBuilder metricModBuilder, OperatingSystemMXBean osMxBean) {
        super(namePrefix, metricModBuilder, osMxBean);
    }

    @Override
    public void produceMetrics(MetricRegistry registry) {
        requireNonNull(registry);
        produceUnlabeled(registry);

        final var cpuLoad = registry.doubleVar(
            nameWithSuffix("cpuLoad"),
            Var.noTotal(),
            doubleVarConfigBuilderSupplier(CPU_USAGE_DESCRIPTION, TYPE_LABEL));

        cpuLoad.register(osMxBean::getProcessCpuLoad, PROCESS_TYPE_LABEL_VALUES);
        cpuLoad.register(osMxBean::getSystemCpuLoad, SYSTEM_TYPE_LABEL_VALUES);

        final var physicalMemorySize = registry.longVar(
            nameWithSuffix("physicalMemorySize"),
            Var.noTotal(),
            longVarConfigBuilderSupplier(AMOUNT_OF_PHYSICAL_MEMORY_IN_BYTES_DESCRIPTION, TYPE_LABEL));

        physicalMemorySize.register(osMxBean::getTotalPhysicalMemorySize, TOTAL_TYPE_LABEL_VALUES);
        physicalMemorySize.register(osMxBean::getFreePhysicalMemorySize, FREE_TYPE_LABEL_VALUES);

        final var swapSpaceSize = registry.longVar(
            nameWithSuffix("swapSpaceSize"),
            Var.noTotal(),
            longVarConfigBuilderSupplier(AMOUNT_OF_SWAP_MEMORY_IN_BYTES_DESCRIPTION, TYPE_LABEL));

        swapSpaceSize.register(osMxBean::getTotalSwapSpaceSize, TOTAL_TYPE_LABEL_VALUES);
        swapSpaceSize.register(osMxBean::getFreeSwapSpaceSize, FREE_TYPE_LABEL_VALUES);
    }
}