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.

The registry factories created and used at runtime are managed by a RegistryFactoryProvider. This module provides one implementation (NoOpRegistryFactory which returns RegistryFactory instances which create no-op metrics. If the regular metrics implementation component is on the path at runtime, then the RegistryFactoryProvider furnished by that component will create fully functional registry factories.

Related Packages

Module	Package	Description
io.helidon.metrics	io.helidon.metrics	Metrics support for Java SE, uses the Microprofile metrics APIs and formats.
io.helidon.metrics.api	io.helidon.metrics.api.spi	SPI for the metrics API.
io.helidon.metrics.traceexemplar	io.helidon.metrics.exemplartrace	Provides exemplar support in metrics using tracing identifiers.
io.helidon.metrics.prometheus	io.helidon.metrics.prometheus	Support for Prometheus client endpoint.
io.helidon.metrics.serviceapi	io.helidon.metrics.serviceapi	API and minimal implementation for metrics support service.

Class	Description
AbstractMetric	Common reusable implementation for any category of metric implementation (full-featured, no-op).
AbstractRegistry<M extends HelidonMetric>	Common behavior for any category (e.g., full-featured or no-op) metrics registry.
AbstractRegistry.GaugeFactory	Gauge factories based on either functions or suppliers.
AbstractRegistry.GaugeFactory.FunctionBased	Gauge factory based on a function which provides the gauge value when passed an object of a declared type.
AbstractRegistry.GaugeFactory.SupplierBased	Gauge factory based on a supplier which provides the gauge value.
BaseMetricsSettings	Settings which control base metrics.
BaseMetricsSettings.Builder	Builder for BaseMetricsSettings.
ComponentMetricsSettings	Settings which control metrics behavior for a metrics-capable component.
ComponentMetricsSettings.Builder	Builder for ComponentMetricsSettings.
HelidonMetric	Helidon-required behavior for each type (e.g., full-featured or no-op) of metric implementation.
KeyPerformanceIndicatorMetricsSettings	Settings for key performance indicator (KPI) metrics.
KeyPerformanceIndicatorMetricsSettings.Builder	Override default settings.
MetricsSettings	Settings which control behavior for metrics overall.
MetricsSettings.Builder	Builder for MetricsSettings.
RegistryFactory	Behavior of a RegistryFactory, capable of providing metrics registries of various types (application, base, vendor) plus static methods for: creating "free-standing" registry factories according to MetricsSettings or Config (see the create methods), retrieving the singleton registry factory or updating it according to MetricsSettings or Config (see the getInstance methods), and retrieving the appropriate registry factory for a metrics-capable component, based on the component's own metrics settings combined with the overall metrics settings and whether full-featured metrics are available on the path (see the RegistryFactory.getInstance() method).
RegistryFilterSettings	Filter settings for registries.
RegistryFilterSettings.Builder	Builder for a new RegistryFilterSettings instance.
RegistrySettings	Settings which control metrics within registries (application, vendor, base) as a group or individually.
RegistrySettings.Builder	Builder for RegistrySettings.
SystemTagsManager	Deals with global and app-level tags to be included in output for all metrics.