io.prometheus.metrics.model.snapshots.Unit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of prometheus-metrics-model Show documentation

Data model for read-only immutable Prometheus metrics snapshots.

There is a newer version: 1.3.1

Show newest version

package io.prometheus.metrics.model.snapshots;

import java.util.Objects;

/**
 * Some pre-defined units for convenience. You can create your own units with
 *  *     new Unit("myUnit");
 * 
 * Note that in Prometheus, units are largely based on SI base units
 * (seconds, bytes, joules, grams, meters, ratio, volts, amperes, and celsius).
 */
public class Unit {

    private final String name;

    public static final Unit RATIO = new Unit("ratio");
    public static final Unit SECONDS = new Unit("seconds");
    public static final Unit BYTES = new Unit("bytes");
    public static final Unit CELSIUS = new Unit("celsius");
    public static final Unit JOULES = new Unit("joules");
    public static final Unit GRAMS = new Unit("grams");
    public static final Unit METERS = new Unit("meters");
    public static final Unit VOLTS = new Unit("volts");
    public static final Unit AMPERES = new Unit("amperes");

    public Unit(String name) {
        if (name == null) {
            throw new NullPointerException("Unit name cannot be null.");
        }
        if (name.trim().isEmpty()) {
            throw new IllegalArgumentException("Unit name cannot be empty.");
        }
        this.name = name.trim();
    }

    @Override
    public String toString() {
        return name;
    }

    public static double nanosToSeconds(long nanos) {
        return nanos / 1E9;
    }

    public static double millisToSeconds(long millis) {
        return millis / 1E3;
    }

    public static double secondsToMillis(double seconds) {
        return seconds * 1E3;
    }

    public static double kiloBytesToBytes(double kilobytes) {
        return kilobytes * 1024;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Unit unit = (Unit) o;
        return Objects.equals(name, unit.name);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name);
    }
}