Module io.helidon.metrics.api

Package io.helidon.metrics.api

Interface Meter

All Superinterfaces:

Wrapper

All Known Subinterfaces:

Counter, DistributionSummary, FunctionalCounter, Gauge<N>, Timer

public interface Meter
extends Wrapper

Common behavior of all meters.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Meter.BaseUnits	Common unit declarations (inspired by the list from MicroProfile metrics).
static interface	Meter.Builder<B extends Meter.Builder<B,M>,M extends Meter>	Common behavior of specific meter builders.
static interface	Meter.Id	Unique idenfier for a meter.
static class	Meter.Scope	Constants for the pre-defined scopes.
static enum	Meter.Type	Type of meter.

Method Summary

Modifier and Type	Method	Description
Optional<String>	baseUnit()	Returns the meter's base unit.
Optional<String>	description()	Returns the meter's description.
Meter.Id	id()	Returns the meter ID.
Optional<String>	scope()	Returns the scope associated with the meter.
Meter.Type	type()	Returns the meter type.

Methods inherited from interface io.helidon.metrics.api.Wrapper

unwrap

Method Details

id

Meter.Id id()

Returns the meter ID.

Returns:

meter ID

baseUnit

Optional<String> baseUnit()

Returns the meter's base unit.

Returns:

base unit

description

Optional<String> description()

Returns the meter's description.

Returns:

description

type

Meter.Type type()

Returns the meter type.

Returns:

meter type

scope

Optional<String> scope()

Returns the scope associated with the meter.

Returns:

scope