io.pcp.parfait.dropwizard.MetricDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of parfait-dropwizard Show documentation

Reporter for Dropwizard (ex Codahale) metrics that publishes to Parfait

There is a newer version: 1.2.1

package io.pcp.parfait.dropwizard;

import javax.measure.Unit;

import io.pcp.parfait.ValueSemantics;

/**
 * The metadata published with a metric in Parfait
 */
public interface MetricDescriptor {

    /**
     * The unit of the metric
     *
     * @return The JSR-363 unit
     */
    Unit getUnit();

    /**
     * The human-readable description of the metric
     *
     * @return The description
     */
    String getDescription();

    /**
     * The ValueSemantics of the metric
     *
     * @return the ValueSemantics
     * @see io.pcp.parfait.ValueSemantics
     */
    ValueSemantics getSemantics();
}