Module io.helidon.metrics.api

Package io.helidon.metrics.api

package io.helidon.metrics.api

Defines the Helidon metrics API so Helidon metrics-capable components can implement metrics simply and without regard for whether metrics is actually on the runtime path or not or is enabled or not.

Class	Description
Bucket	Representation of a histogram bucket, including the boundary value and the count of observations in that bucket.
BuiltInMeterNameFormat	Choices for the output format for built-in meter names.
Clock	Reports absolute time (and, therefore, is also useful in computing elapsed times).
ComponentMetricsSettings	Settings which control metrics behavior for a metrics-capable component.
ComponentMetricsSettings.Builder	Builder for ComponentMetricsSettings.
Counter	Records a monotonically increasing value.
Counter.Builder	Builder for a new counter.
DistributionStatisticsConfig	Configuration which controls the behavior of distribution statistics from meters that support them (for example, timers and distribution summaries).
DistributionStatisticsConfig.Builder	Builder for a new DistributionStatisticsConfig instance.
DistributionSummary	Records a distribution of values (e.g., sizes of responses returned by a server).
DistributionSummary.Builder	Builder for a DistributionSummary.
FunctionalCounter	A read-only counter which wraps some other object that provides the counter value via a function.
FunctionalCounter.Builder<T>	Builder for a FunctionalCounter.
Gauge<N extends Number>	Measures a value that can increase or decrease and is updated by external logic, not by explicit invocations of methods on this type.
Gauge.Builder<N extends Number>	Builder for a new gauge.
GcTimeType	Deprecated, for removal: This API element is subject to removal in a future version.
HistogramSnapshot	Snapshot in time of a histogram.
HistogramSupport	Common behavior among meters which support histograms.
KeyPerformanceIndicatorMetricsConfig	Config bean for KPI metrics configuration.
KeyPerformanceIndicatorMetricsConfig.Builder	Fluent API builder for KeyPerformanceIndicatorMetricsConfig.
KeyPerformanceIndicatorMetricsConfig.BuilderBase<BUILDER extends KeyPerformanceIndicatorMetricsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends KeyPerformanceIndicatorMetricsConfig>	Fluent API builder base for KeyPerformanceIndicatorMetricsConfig.
KeyPerformanceIndicatorMetricsConfig.BuilderBase.KeyPerformanceIndicatorMetricsConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.
LabeledSample	Base implementation of Sample.Labeled.
LabeledSnapshot	Internal interface prescribing minimum behavior of a snapshot needed to produce output.
Meter	Common behavior of all meters.
Meter.BaseUnits	Common unit declarations (inspired by the list from MicroProfile metrics).
Meter.Builder<B extends Meter.Builder<B,M>,M extends Meter>	Common behavior of specific meter builders.
Meter.Id	Unique idenfier for a meter.
Meter.Scope	Constants for the pre-defined scopes.
Meter.Type	Type of meter.
MeterRegistry	Manages the look-up and registration of meters.
MeterRegistry.Builder<B extends MeterRegistry.Builder<B,R>,R extends MeterRegistry>	Builder for creating a new meter registry.
MeterRegistryFormatter	Formatter of a MeterRegistry according to a given media type.
Metrics	A main entry point for developers to the Helidon metrics system, allowing access to the global meter registry and providing shortcut methods to register and locate meters in the global registry and remove meters from it.
MetricsConfig	Configuration settings for metrics.
MetricsConfig.Builder	Fluent API builder for MetricsConfig.
MetricsConfig.BuilderBase<BUILDER extends MetricsConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends MetricsConfig>	Fluent API builder base for MetricsConfig.
MetricsConfig.BuilderBase.MetricsConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.
MetricsFactory	The basic contract for implementations of the Helidon metrics API, mostly acting as a factory for meter builders rather than for meters themselves.
Sample	Common behavior to all types of samples.
Sample.Derived	Sample that does not exist as an actual observation but is derived from actual observations.
Sample.Labeled	A sample with a label and a timestamp, typically representing actual observations (rather than derived values).
SampledMetric	A metric capable of providing samples.
ScopeConfig	Configuration settings for a scope within the "metrics" config section.
ScopeConfig.Builder	Fluent API builder for ScopeConfig.
ScopeConfig.BuilderBase<BUILDER extends ScopeConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ScopeConfig>	Fluent API builder base for ScopeConfig.
ScopeConfig.BuilderBase.ScopeConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.
ScopingConfig	Interface generated from definition.
ScopingConfig.Builder	Fluent API builder for ScopingConfig.
ScopingConfig.BuilderBase<BUILDER extends ScopingConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ScopingConfig>	Fluent API builder base for ScopingConfig.
ScopingConfig.BuilderBase.ScopingConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.
SnapshotMetric	A metric that is capable of providing snapshots.
SystemTagsManager	Deals with global, app-level, and scope to be included in the external representation (output and IDs in delegate meter registries) for all metrics.
Tag	Behavior of a tag for further identifying meters.
Timer	Records timing information about large numbers of short-running events (e.g., HTTP requests).
Timer.Builder	Builder for a new Timer.
Timer.Sample	Measures an interval of time from instantiation to an explicit invocation of Timer.Sample.stop(io.helidon.metrics.api.Timer).
ValueAtPercentile	Percentile and value at that percentile within a distribution.
Wrapper	Behavior of a type that wraps a related type, typically through delegation.