Index

A B C D E F G H I K L M N O P R S T U V W Z 
All Classes and Interfaces|All Packages|Constant Field Values

A

addScopes(Map<? extends String, ? extends ScopeConfig>) - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
This method keeps existing values, then puts all new values into the map.
addTag(Tag) - Method in interface io.helidon.metrics.api.Meter.Builder
Adds a single tag to the builder's collection.
addTags(List<? extends Tag>) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Global tags.
APPLICATION - Static variable in class io.helidon.metrics.api.Meter.Scope
Application scope.
apply(MetricsConfig) - Method in interface io.helidon.metrics.spi.MetricsProgrammaticConfig
Creates a new MetricsConfig instance by applying overrides from this programmatic config instance.
apply(MetricsConfig.Builder) - Method in interface io.helidon.metrics.spi.MetricsProgrammaticConfig
Augments an existing MetricsConfig.Builder, presumably from actual config, with overrides provided by this programmatic config instance.
appName() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Value for the application tag to be added to each meter ID.
appName() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
appName() - Method in interface io.helidon.metrics.api.MetricsConfig
Value for the application tag to be added to each meter ID.
appName(String) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Value for the application tag to be added to each meter ID.
appTagName() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Name for the application tag to be added to each meter ID.
appTagName() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
appTagName() - Method in interface io.helidon.metrics.api.MetricsConfig
Name for the application tag to be added to each meter ID.
appTagName() - Method in interface io.helidon.metrics.spi.MetricsProgrammaticConfig
Name to use for a tag, added to each meter's identity, conveying the application it belongs to.
appTagName(String) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Name for the application tag to be added to each meter ID.
assignScope(String, Function<Tag, ?>) - Method in interface io.helidon.metrics.api.SystemTagsManager
Invokes the specified consumer with the scope tag name setting from the configuration (if present) and the provided scope value.

B

BASE - Static variable in class io.helidon.metrics.api.Meter.Scope
Base scope.
baseUnit() - Method in interface io.helidon.metrics.api.Meter
Returns the meter's base unit.
baseUnit() - Method in interface io.helidon.metrics.api.Meter.Builder
Returns the base unit the builder will use.
baseUnit(String) - Method in interface io.helidon.metrics.api.Meter.Builder
Sets the units.
BITS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
Represents bits.
boundary() - Method in interface io.helidon.metrics.api.Bucket
Returns the bucket boundary.
boundary(TimeUnit) - Method in interface io.helidon.metrics.api.Bucket
Returns the bucket boundary interpreted as a time in nanoseconds and expressed in the specified TimeUnit.
Bucket - Interface in io.helidon.metrics.api
Representation of a histogram bucket, including the boundary value and the count of observations in that bucket.
buckets() - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig
Returns the configured boundary boundaries.
buckets() - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig.Builder
Returns the buckets.
buckets() - Method in interface io.helidon.metrics.api.Timer.Builder
Returns the bucket boundary values set in the builder, if any.
buckets(double...) - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig.Builder
Sets the boundary boundaries.
buckets(Iterable<Double>) - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig.Builder
Sets the boundary boundaries.
buckets(Duration...) - Method in interface io.helidon.metrics.api.Timer.Builder
Sets the boundary boundaries.
build() - Method in interface io.helidon.metrics.api.ComponentMetricsSettings.Builder
Constructs a ComponentMetricsSettings object from the builder.
build() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.Builder
 
build() - Method in class io.helidon.metrics.api.MetricsConfig.Builder
 
build() - Method in class io.helidon.metrics.api.ScopeConfig.Builder
 
build() - Method in class io.helidon.metrics.api.ScopingConfig.Builder
 
builder() - Static method in interface io.helidon.metrics.api.ComponentMetricsSettings
Returns a builder for ComponentMetricsSettings.
builder() - Static method in interface io.helidon.metrics.api.DistributionStatisticsConfig
Creates a builder for a new DistributionStatisticsConfig instance.
builder() - Static method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig
Create a new fluent API builder to customize configuration.
builder() - Static method in interface io.helidon.metrics.api.MetricsConfig
Create a new fluent API builder to customize configuration.
builder() - Static method in interface io.helidon.metrics.api.ScopeConfig
Create a new fluent API builder to customize configuration.
builder() - Static method in interface io.helidon.metrics.api.ScopingConfig
Create a new fluent API builder to customize configuration.
builder(Config) - Static method in interface io.helidon.metrics.api.ComponentMetricsSettings
Returns a builder for ComponentMetricsSettings based on the provided component metric settings config node.
builder(KeyPerformanceIndicatorMetricsConfig) - Static method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig
Create a new fluent API builder from an existing instance.
builder(MetricsConfig) - Static method in interface io.helidon.metrics.api.MetricsConfig
Create a new fluent API builder from an existing instance.
builder(ScopeConfig) - Static method in interface io.helidon.metrics.api.ScopeConfig
Create a new fluent API builder from an existing instance.
builder(ScopingConfig) - Static method in interface io.helidon.metrics.api.ScopingConfig
Create a new fluent API builder from an existing instance.
builder(String) - Static method in interface io.helidon.metrics.api.Counter
Creates a new builder for a counter.
builder(String) - Static method in interface io.helidon.metrics.api.DistributionSummary
Creates a builder for a new DistributionSummary using default distribution statistics.
builder(String) - Static method in interface io.helidon.metrics.api.Timer
Creates a builder for a new Timer.
builder(String, DistributionStatisticsConfig.Builder) - Static method in interface io.helidon.metrics.api.DistributionSummary
Creates a builder for a new DistributionSummary using the specified statistics builder.
builder(String, Supplier<N>) - Static method in interface io.helidon.metrics.api.Gauge
Creates a builder for a supplier-based gauge.
builder(String, T, Function<T, Long>) - Static method in interface io.helidon.metrics.api.FunctionalCounter
Returns a builder for registering or locating a functional counter.
builder(String, T, ToDoubleFunction<T>) - Static method in interface io.helidon.metrics.api.Gauge
Creates a builder for creating a new gauge based on applying a function to a state object.
BuilderBase() - Constructor for class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
Protected to support extensibility.
BuilderBase() - Constructor for class io.helidon.metrics.api.MetricsConfig.BuilderBase
Protected to support extensibility.
BuilderBase() - Constructor for class io.helidon.metrics.api.ScopeConfig.BuilderBase
Protected to support extensibility.
BuilderBase() - Constructor for class io.helidon.metrics.api.ScopingConfig.BuilderBase
Protected to support extensibility.
buildPrototype() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.Builder
 
buildPrototype() - Method in class io.helidon.metrics.api.MetricsConfig.Builder
 
buildPrototype() - Method in class io.helidon.metrics.api.ScopeConfig.Builder
 
buildPrototype() - Method in class io.helidon.metrics.api.ScopingConfig.Builder
 
BUILT_IN_SCOPES - Static variable in class io.helidon.metrics.api.Meter.Scope
All the predefined scopes.
BYTES - Static variable in class io.helidon.metrics.api.Meter.BaseUnits

C

clearAppName() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Clear existing value of this property.
clearAppTagName() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Clear existing value of this property.
clearDefaultValue() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Clear existing value of this property.
clearExclude() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Clear existing value of this property.
clearInclude() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Clear existing value of this property.
clearTagName() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Clear existing value of this property.
clock() - Method in interface io.helidon.metrics.api.MeterRegistry
Returns the default Clock in use by the registry.
clock(Clock) - Method in interface io.helidon.metrics.api.MeterRegistry.Builder
Assigns the clock to be used within the meter registry (e.g., in timers), defaulting to a system clock.
Clock - Interface in io.helidon.metrics.api
Reports absolute time (and, therefore, is also useful in computing elapsed times).
clockSystem() - Method in interface io.helidon.metrics.api.MetricsFactory
Returns the system Clock from the underlying metrics implementation.
close() - Method in interface io.helidon.metrics.api.MeterRegistry
Closes the meter registry.
close() - Method in interface io.helidon.metrics.api.MetricsFactory
Closes this metrics factory.
close() - Method in interface io.helidon.metrics.spi.MetricsFactoryProvider
Closes all metrics factories created by this provider.
closeAll() - Static method in interface io.helidon.metrics.api.MetricsFactory
Closes all MetricsFactory instances.
ComponentMetricsSettings - Interface in io.helidon.metrics.api
Settings which control metrics behavior for a metrics-capable component.
ComponentMetricsSettings.Builder - Interface in io.helidon.metrics.api
Builder for ComponentMetricsSettings.
config() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
If this instance was configured, this would be the config instance used.
config() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
If this instance was configured, this would be the config instance used.
config() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
config() - Method in interface io.helidon.metrics.api.MetricsConfig
Metrics configuration node.
config() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
If this instance was configured, this would be the config instance used.
config() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
If this instance was configured, this would be the config instance used.
config(Config) - Method in interface io.helidon.metrics.api.ComponentMetricsSettings.Builder
Updates the builder using the provided metrics config.
config(Config) - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
Update builder from configuration (node of this type).
config(Config) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Update builder from configuration (node of this type).
config(Config) - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Update builder from configuration (node of this type).
config(Config) - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Update builder from configuration (node of this type).
count() - Method in interface io.helidon.metrics.api.Bucket
Returns the number of observations in the bucket.
count() - Method in interface io.helidon.metrics.api.Counter
Returns the cumulative count since this counter was registered.
count() - Method in interface io.helidon.metrics.api.DistributionSummary
Returns the current count of observations in the distribution summary.
count() - Method in interface io.helidon.metrics.api.FunctionalCounter
Returns the counter value.
count() - Method in interface io.helidon.metrics.api.HistogramSnapshot
Returns the count of observations in the snapshot.
count() - Method in interface io.helidon.metrics.api.Timer
Returns the current count of completed events measured by the timer.
counter(String, Iterable<Tag>) - Method in interface io.helidon.metrics.api.MeterRegistry
Locates a previously-registered counter.
Counter - Interface in io.helidon.metrics.api
Records a monotonically increasing value.
COUNTER - Enum constant in enum class io.helidon.metrics.api.Meter.Type
Counter (monotonically increasing value).
Counter.Builder - Interface in io.helidon.metrics.api
Builder for a new counter.
counterBuilder(String) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a builder for a Counter.
create() - Static method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig
Create a new instance with default values.
create() - Static method in interface io.helidon.metrics.api.MetricsConfig
Create a new instance with default values.
create() - Static method in interface io.helidon.metrics.api.ScopeConfig
Create a new instance with default values.
create() - Static method in interface io.helidon.metrics.api.ScopingConfig
Create a new instance with default values.
create(Config) - Static method in interface io.helidon.metrics.api.ComponentMetricsSettings
Returns component metrics settings created from a Config node, by convention the metrics config section within the component's own config section.
create(Config) - Static method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig
Create a new instance from configuration.
create(Config) - Static method in interface io.helidon.metrics.api.MetricsConfig
Create a new instance from configuration.
create(Config) - Static method in interface io.helidon.metrics.api.ScopeConfig
Create a new instance from configuration.
create(Config) - Static method in interface io.helidon.metrics.api.ScopingConfig
Create a new instance from configuration.
create(Config, MetricsConfig, Collection<MetersProvider>) - Method in interface io.helidon.metrics.spi.MetricsFactoryProvider
Creates a new MetricsFactory from which the caller can obtain MeterRegistry and Meter.Builder instances.
create(MetricsConfig) - Static method in interface io.helidon.metrics.api.SystemTagsManager
Creates a new system tags manager using the provided metrics settings.
create(String, String) - Static method in interface io.helidon.metrics.api.Tag
Creates a new tag using the specified key and value.
createMeterRegistry() - Static method in interface io.helidon.metrics.api.Metrics
Creates a meter registry, not saved as the global registry, using default metrics config information based on global config.
createMeterRegistry(Clock, MetricsConfig) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a new MeterRegistry using the provided Clock and MetricsConfig.
createMeterRegistry(Clock, MetricsConfig, Consumer<Meter>, Consumer<Meter>) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a new MeterRegistry using the provided Clock and MetricsConfig and enrolling the specified listners with the new meter registry.
createMeterRegistry(MetricsConfig) - Static method in interface io.helidon.metrics.api.Metrics
Creates a meter registry, not saved as the global registry, based on the provided metrics config.
createMeterRegistry(MetricsConfig) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a new MeterRegistry using the provided metrics config.
createMeterRegistry(MetricsConfig, Consumer<Meter>, Consumer<Meter>) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a new MeterRegistry using the provided metrics config and enrolling the specified listeners with the returned meter registry.

D

DAYS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
DEFAULT - Static variable in class io.helidon.metrics.api.Meter.Scope
Default scope if none is specified for a given meter.
defaultValue() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Default scope value to associate with meters that are registered without an explicit setting; no setting means meters receive no default scope value.
defaultValue() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase.ScopingConfigImpl
 
defaultValue() - Method in interface io.helidon.metrics.api.ScopingConfig
Default scope value to associate with meters that are registered without an explicit setting; no setting means meters receive no default scope value.
defaultValue(String) - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Default scope value to associate with meters that are registered without an explicit setting; no setting means meters receive no default scope value.
derived(double) - Static method in interface io.helidon.metrics.api.Sample
Create a new derived value without a reference.
derived(double, Sample.Labeled) - Static method in interface io.helidon.metrics.api.Sample
Create a new derived value with a reference.
description() - Method in interface io.helidon.metrics.api.Meter.Builder
Returns the description the builder will use.
description() - Method in interface io.helidon.metrics.api.Meter
Returns the meter's description.
description(String) - Method in interface io.helidon.metrics.api.Meter.Builder
Sets the description.
displayTags() - Method in interface io.helidon.metrics.api.SystemTagsManager
Returns an Iterable of Tag representing the any system tags configured for display (for example, an app tag or global tags set through configuration).
DISTRIBUTION_SUMMARY - Enum constant in enum class io.helidon.metrics.api.Meter.Type
Distribution summary (measures distribution of samples).
distributionStatisticsConfig() - Method in interface io.helidon.metrics.api.DistributionSummary.Builder
Returns the statistics config set on the builder, if any.
distributionStatisticsConfig(DistributionStatisticsConfig.Builder) - Method in interface io.helidon.metrics.api.DistributionSummary.Builder
Sets the config for distribution statistics for the distribution summary.
DistributionStatisticsConfig - Interface in io.helidon.metrics.api
Configuration which controls the behavior of distribution statistics from meters that support them (for example, timers and distribution summaries).
DistributionStatisticsConfig.Builder - Interface in io.helidon.metrics.api
Builder for a new DistributionStatisticsConfig instance.
distributionStatisticsConfigBuilder() - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a builder for a DistributionStatisticsConfig.
DistributionSummary - Interface in io.helidon.metrics.api
Records a distribution of values (e.g., sizes of responses returned by a server).
DistributionSummary.Builder - Interface in io.helidon.metrics.api
Builder for a DistributionSummary.
distributionSummaryBuilder(String, DistributionStatisticsConfig.Builder) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a builder for a DistributionSummary.
doubleValue() - Method in class io.helidon.metrics.api.LabeledSample
 
doubleValue() - Method in interface io.helidon.metrics.api.Sample
Returns the value as a double.

E

effectiveScope(Optional<String>) - Method in interface io.helidon.metrics.api.SystemTagsManager
Returns the effective scope, given the provided candidate scope combined with any default scope value in the configuration which initialized this manager.
effectiveScope(Optional<String>, Iterable<Tag>) - Method in interface io.helidon.metrics.api.SystemTagsManager
Returns the effective scope, given the provided explicit setting and tags (which might specify the scope) combined with any default scope value in the configuration which was used to initialize this system tags manager.
empty(long, double, double) - Static method in interface io.helidon.metrics.api.HistogramSnapshot
Returns an "empty" snapshot which has summary values but no data points.
enabled() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Whether metrics functionality is enabled.
enabled() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
enabled() - Method in interface io.helidon.metrics.api.MetricsConfig
Whether metrics functionality is enabled.
enabled() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Whether the scope is enabled.
enabled() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase.ScopeConfigImpl
 
enabled() - Method in interface io.helidon.metrics.api.ScopeConfig
Whether the scope is enabled.
enabled(boolean) - Method in interface io.helidon.metrics.api.ComponentMetricsSettings.Builder
Sets whether metrics should be enabled for the component.
enabled(boolean) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Whether metrics functionality is enabled.
enabled(boolean) - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Whether the scope is enabled.
ENABLED_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.ComponentMetricsSettings.Builder
Config key within the component's metrics config section controlling whether metrics are enabled for that component.
equals(Object) - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase.KeyPerformanceIndicatorMetricsConfigImpl
 
equals(Object) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
equals(Object) - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase.ScopeConfigImpl
 
equals(Object) - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase.ScopingConfigImpl
 
exclude() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Regular expression for meter names to exclude.
exclude() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase.ScopeConfigImpl
 
exclude() - Method in interface io.helidon.metrics.api.ScopeConfig
Regular expression for meter names to exclude.
exclude(String) - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Regular expression for meter names to exclude.
ExemplarService - Interface in io.helidon.metrics.spi
Behavior for supporting exemplars in metrics histograms.
extended() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
Whether KPI extended metrics are enabled.
extended() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase.KeyPerformanceIndicatorMetricsConfigImpl
 
extended() - Method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig
Whether KPI extended metrics are enabled.
extended(boolean) - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
Whether KPI extended metrics are enabled.

F

fn() - Method in interface io.helidon.metrics.api.FunctionalCounter.Builder
Returns the function which, when applied to the state object, returns the counter value.
format() - Method in interface io.helidon.metrics.api.MeterRegistryFormatter
Formats the meter registry's data.
formatMetadata() - Method in interface io.helidon.metrics.api.MeterRegistryFormatter
Formats the meter registry's metadata.
formatter(MediaType, MetricsConfig, MeterRegistry, Optional<String>, Iterable<String>, Iterable<String>) - Method in interface io.helidon.metrics.spi.MeterRegistryFormatterProvider
Returns, if possible, a MeterRegistryFormatter capable of preparing output according to the specified MediaType.
from(KeyPerformanceIndicatorMetricsConfig) - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
Update this builder from an existing prototype instance.
from(KeyPerformanceIndicatorMetricsConfig.BuilderBase<?, ?>) - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
Update this builder from an existing prototype builder instance.
from(MetricsConfig) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Update this builder from an existing prototype instance.
from(MetricsConfig.BuilderBase<?, ?>) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Update this builder from an existing prototype builder instance.
from(ScopeConfig) - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Update this builder from an existing prototype instance.
from(ScopeConfig.BuilderBase<?, ?>) - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Update this builder from an existing prototype builder instance.
from(ScopingConfig) - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Update this builder from an existing prototype instance.
from(ScopingConfig.BuilderBase<?, ?>) - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Update this builder from an existing prototype builder instance.
FunctionalCounter - Interface in io.helidon.metrics.api
A read-only counter which wraps some other object that provides the counter value via a function.
FunctionalCounter.Builder<T> - Interface in io.helidon.metrics.api
Builder for a FunctionalCounter.
functionalCounterBuilder(String, T, Function<T, Long>) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a builder for a functional Counter, essentially a counter-style wrapper around an external object.

G

gauge(String, Iterable<Tag>) - Method in interface io.helidon.metrics.api.MeterRegistry
Locates a previously-registered gauge.
Gauge<N> - Interface in io.helidon.metrics.api
Measures a value that can increase or decrease and is updated by external logic, not by explicit invocations of methods on this type.
GAUGE - Enum constant in enum class io.helidon.metrics.api.Meter.Type
Gauge (can increase or decrease).
Gauge.Builder<N> - Interface in io.helidon.metrics.api
Builder for a new gauge.
gaugeBuilder(String, Supplier<N>) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a builder for a Gauge based on a supplier of a subtype of Number.
gaugeBuilder(String, T, ToDoubleFunction<T>) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a builder for a state-based Gauge.
get(Class<M>, String, Iterable<Tag>) - Static method in interface io.helidon.metrics.api.Metrics
Locates a previously-registered meter of the specified type, matching the name and tags.
getCounter(String) - Static method in interface io.helidon.metrics.api.Metrics
Locates a previously-registerec counter.
getCounter(String, Iterable<Tag>) - Static method in interface io.helidon.metrics.api.Metrics
Locates a previously-registered counter.
getGauge(String) - Static method in interface io.helidon.metrics.api.Metrics
Locates a previously-registered gauge.
getGauge(String, Iterable<Tag>) - Static method in interface io.helidon.metrics.api.Metrics
Locates a previously-registered gauge.
getInstance() - Static method in interface io.helidon.metrics.api.MetricsFactory
Returns the most-recently created implementation or, if none, a new one from a highest-weight provider available at runtime and using the "metrics" section from the GlobalConfig.
getInstance(Config) - Static method in interface io.helidon.metrics.api.MetricsFactory
Returns a new metrics factory instance from a highest-weight provider using the provided Config to set up the metrics factory and saving the resulting metrics factory as the current one, returned by MetricsFactory.getInstance()}.
getOrCreate(B) - Method in interface io.helidon.metrics.api.MeterRegistry
Locates a previously-registered meter using the name and tags in the provided builder or, if not found, registers a new one using the provided builder.
getOrCreate(B) - Static method in interface io.helidon.metrics.api.Metrics
Locates a previously-registered meter using the name and tags in the provided builder or, if not found, registers a new one using the provided builder, both using the metrics factory's global registry.
getSummary(String) - Static method in interface io.helidon.metrics.api.Metrics
Locates a previously-registered distribution summary.
getSummary(String, Iterable<Tag>) - Static method in interface io.helidon.metrics.api.Metrics
Locates a previously-registered distribution summary.
getTimer(String) - Static method in interface io.helidon.metrics.api.Metrics
Locates a previously-registered timer.
getTimer(String, Iterable<Tag>) - Static method in interface io.helidon.metrics.api.Metrics
Locates a previously-registered timer.
GIBIBITS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
GIGABITS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
GIGABYTES - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
globalRegistry() - Static method in interface io.helidon.metrics.api.Metrics
Returns the global meter registry.
globalRegistry() - Method in interface io.helidon.metrics.api.MetricsFactory
Returns the global MeterRegistry for this metrics factory.
globalRegistry(MetricsConfig) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a new global registry according to the configuration and returns it.
globalRegistry(Consumer<Meter>, Consumer<Meter>, boolean) - Method in interface io.helidon.metrics.api.MetricsFactory
Returns the global MeterRegistry enrolling the specified listeners to the meter registry.

H

hashCode() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase.KeyPerformanceIndicatorMetricsConfigImpl
 
hashCode() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
hashCode() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase.ScopeConfigImpl
 
hashCode() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase.ScopingConfigImpl
 
histogramCounts() - Method in interface io.helidon.metrics.api.HistogramSnapshot
Returns information about each of the configured buckets for the histogram.
HistogramSnapshot - Interface in io.helidon.metrics.api
Snapshot in time of a histogram.
histogramSnapshotEmpty(long, double, double) - Method in interface io.helidon.metrics.api.MetricsFactory
Returns an empty histogram snapshot with the specified aggregate values.
HistogramSupport - Interface in io.helidon.metrics.api
Common behavior among meters which support histograms.
HOURS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits

I

id() - Method in interface io.helidon.metrics.api.Meter
Returns the meter ID.
identity() - Method in interface io.helidon.metrics.api.Meter.Builder
Returns the type-correct "this".
include() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Regular expression for meter names to include.
include() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase.ScopeConfigImpl
 
include() - Method in interface io.helidon.metrics.api.ScopeConfig
Regular expression for meter names to include.
include(String) - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Regular expression for meter names to include.
increment() - Method in interface io.helidon.metrics.api.Counter
Updates the counter by one.
increment(long) - Method in interface io.helidon.metrics.api.Counter
Updates the counter by the specified amount which should be non-negative.
instance() - Static method in interface io.helidon.metrics.api.SystemTagsManager
Returns the initialized instance of the tags manager.
instance() - Static method in interface io.helidon.metrics.spi.MetricsProgrammaticConfig
Returns the singleton instance of the metrics programmatic settings.
instance(MetricsConfig) - Static method in interface io.helidon.metrics.api.SystemTagsManager
Creates a new system tags manager using the provide metrics settings, saving the new instance as the initialized singleton which will be returned to subsequent invocations of SystemTagsManager.instance().
io.helidon.metrics.api - module io.helidon.metrics.api
Helidon metrics API.
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.
io.helidon.metrics.spi - package io.helidon.metrics.spi
SPI for Helidon metrics.
isDeleted(Meter) - Method in interface io.helidon.metrics.api.MeterRegistry
Indicates if the meter has been deleted.
isEnabled() - Method in interface io.helidon.metrics.api.ComponentMetricsSettings
Returns whether the component settings indicate that metrics are enabled for the component.
isMeterEnabled(String) - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase.ScopeConfigImpl
 
isMeterEnabled(String) - Method in interface io.helidon.metrics.api.ScopeConfig
Indicates whether the specified meter is enabled according to the scope configuration.
isMeterEnabled(String, String) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
isMeterEnabled(String, String) - Method in interface io.helidon.metrics.api.MetricsConfig
Reports whether the specified meter within the indicated scope is enabled, according to the metrics configuration.
isMeterEnabled(String, Map<String, String>, Optional<String>) - Method in interface io.helidon.metrics.api.MeterRegistry
Returns whether the specified meter is enabled or not, based on whether the meter registry as a whole is enabled and also whether the config settings for filtering include and exclude indicate the specific meter is enabled.
isScopeEnabled(String) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
isScopeEnabled(String) - Method in interface io.helidon.metrics.api.MetricsConfig
Reports whether the specified scope is enabled, according to any scope configuration that is part of this metrics configuration.

K

key() - Method in interface io.helidon.metrics.api.Tag
Returns the tag's key.
KEY_PERFORMANCE_INDICATORS_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.MetricsConfig
Config key for KPI metrics settings.
KEY_PERFORMANCE_INDICATORS_CONFIG_KEY - Static variable in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
Config key for KPI metrics settings.
keyPerformanceIndicatorMetricsConfig() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Key performance indicator metrics settings.
keyPerformanceIndicatorMetricsConfig() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
keyPerformanceIndicatorMetricsConfig() - Method in interface io.helidon.metrics.api.MetricsConfig
Key performance indicator metrics settings.
keyPerformanceIndicatorMetricsConfig(KeyPerformanceIndicatorMetricsConfig) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Key performance indicator metrics settings.
keyPerformanceIndicatorMetricsConfig(Consumer<KeyPerformanceIndicatorMetricsConfig.Builder>) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Key performance indicator metrics settings.
keyPerformanceIndicatorMetricsConfig(Supplier<? extends KeyPerformanceIndicatorMetricsConfig>) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Key performance indicator metrics settings.
KeyPerformanceIndicatorMetricsConfig - Interface in io.helidon.metrics.api
Config bean for KPI metrics configuration.
KeyPerformanceIndicatorMetricsConfig.Builder - Class in io.helidon.metrics.api
Fluent API builder for KeyPerformanceIndicatorMetricsConfig.
KeyPerformanceIndicatorMetricsConfig.BuilderBase<BUILDER,PROTOTYPE> - Class in io.helidon.metrics.api
Fluent API builder base for KeyPerformanceIndicatorMetricsConfig.
KeyPerformanceIndicatorMetricsConfig.BuilderBase.KeyPerformanceIndicatorMetricsConfigImpl - Class in io.helidon.metrics.api
Generated implementation of the prototype, can be extended by descendant prototype implementations.
KeyPerformanceIndicatorMetricsConfigImpl(KeyPerformanceIndicatorMetricsConfig.BuilderBase<?, ?>) - Constructor for class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase.KeyPerformanceIndicatorMetricsConfigImpl
Create an instance providing a builder.
KIBIBITS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
KILOBITS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
KILOBYTES - Static variable in class io.helidon.metrics.api.Meter.BaseUnits

L

label() - Method in class io.helidon.metrics.api.LabeledSample
 
label() - Method in interface io.helidon.metrics.api.Sample.Labeled
Value label.
label() - Method in interface io.helidon.metrics.spi.ExemplarService
Returns a label using whatever current context is available.
labeled(double) - Static method in interface io.helidon.metrics.api.Sample
Create a labeled value.
LabeledSample - Class in io.helidon.metrics.api
Base implementation of Sample.Labeled.
LabeledSample(double, String, long) - Constructor for class io.helidon.metrics.api.LabeledSample
Create a sample.
LabeledSnapshot - Interface in io.helidon.metrics.api
Internal interface prescribing minimum behavior of a snapshot needed to produce output.
LONG_RUNNING_REQUESTS_THRESHOLD_DEFAULT - Static variable in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig
Default long-running requests threshold.
LONG_RUNNING_REQUESTS_THRESHOLD_DEFAULT - Static variable in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase.KeyPerformanceIndicatorMetricsConfigImpl
Default long-running requests threshold.
longRunningRequestThreshold() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase.KeyPerformanceIndicatorMetricsConfigImpl
 
longRunningRequestThreshold() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
Threshold in ms that characterizes whether a request is long running.
longRunningRequestThreshold() - Method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig
Threshold in ms that characterizes whether a request is long running.
longRunningRequestThreshold(Duration) - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
Threshold in ms that characterizes whether a request is long running.
lookupConfig(String) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
lookupConfig(String) - Method in interface io.helidon.metrics.api.MetricsConfig
Looks up a single config value within the metrics configuration by config key.

M

max() - Method in interface io.helidon.metrics.api.DistributionSummary
Returns the maximum value among the observations recorded by the distribution summary.
max() - Method in interface io.helidon.metrics.api.HistogramSnapshot
Returns the maximum value over all observations.
max() - Method in interface io.helidon.metrics.api.LabeledSnapshot
Maximal value.
max(TimeUnit) - Method in interface io.helidon.metrics.api.Timer
Returns the maximum value, expressed in the specified units, consumed by a completed event measured by the timer.
maximumExpectedValue() - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig.Builder
Returns the maximum expected value setting.
maximumExpectedValue() - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig
Returns the maximum value that the meter is expected to observe.
maximumExpectedValue() - Method in interface io.helidon.metrics.api.Timer.Builder
Returns the maximum expected value set in the builder, if any.
maximumExpectedValue(Double) - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig.Builder
Sets the maximum value that the meter is expected to observe.
maximumExpectedValue(Duration) - Method in interface io.helidon.metrics.api.Timer.Builder
Sets the maximum expected value the timer is expected to record.
mean() - Method in interface io.helidon.metrics.api.DistributionSummary
Returns the mean of the observations recorded by the distribution summary.
mean() - Method in interface io.helidon.metrics.api.HistogramSnapshot
Returns the average value overall observations.
mean() - Method in interface io.helidon.metrics.api.LabeledSnapshot
Mean value.
mean(TimeUnit) - Method in interface io.helidon.metrics.api.HistogramSnapshot
Returns the average value over all observations, interpreting the values as times in nanoseconds and expressing the average in the specified TimeUnit.
mean(TimeUnit) - Method in interface io.helidon.metrics.api.Timer
Returns the average time, expressed in the specified units, consumed by completed events measured by the timer.
MEBIBITS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
MEGABITS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
MEGABYTES - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
meter(Class<M>, String, Iterable<Tag>) - Method in interface io.helidon.metrics.api.MeterRegistry
Locates a previously-registered meter of the specified type, matching the name and tags.
Meter - Interface in io.helidon.metrics.api
Common behavior of all meters.
Meter.BaseUnits - Class in io.helidon.metrics.api
Common unit declarations (inspired by the list from MicroProfile metrics).
Meter.Builder<B,M> - Interface in io.helidon.metrics.api
Common behavior of specific meter builders.
Meter.Id - Interface in io.helidon.metrics.api
Unique idenfier for a meter.
Meter.Scope - Class in io.helidon.metrics.api
Constants for the pre-defined scopes.
Meter.Type - Enum Class in io.helidon.metrics.api
Type of meter.
meterBuilders(MetricsFactory) - Method in interface io.helidon.metrics.spi.MetersProvider
Returns meter builders created using the specified MetricsFactory.
MeterRegistry - Interface in io.helidon.metrics.api
Manages the look-up and registration of meters.
MeterRegistry.Builder<B,R> - Interface in io.helidon.metrics.api
Builder for creating a new meter registry.
meterRegistryBuilder() - Method in interface io.helidon.metrics.api.MetricsFactory
Returns a builder for creating a new MeterRegistry.
MeterRegistryFormatter - Interface in io.helidon.metrics.api
Formatter of a MeterRegistry according to a given media type.
MeterRegistryFormatterProvider - Interface in io.helidon.metrics.spi
Behavior for providers of meter registry formatters, which (if then can) furnish a formatter given a MediaType.
MeterRegistryLifeCycleListener - Interface in io.helidon.metrics.spi
Receives notifications of events related to meter registries.
meters() - Method in interface io.helidon.metrics.api.MeterRegistry
Returns all previously-registered meters.
meters(Iterable<String>) - Method in interface io.helidon.metrics.api.MeterRegistry
Returns previously-registered meters which match one of the specified scopes.
meters(Predicate<Meter>) - Method in interface io.helidon.metrics.api.MeterRegistry
Returns previously-registered meters which match the specified Predicate.
MetersProvider - Interface in io.helidon.metrics.spi
Furnishes Meter.Builder instances which are supplied to each MetricsFactory when it is created and, in turn, are passed to each MeterRegistry that factory creates.
Metrics - Interface in io.helidon.metrics.api
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.
METRICS_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.ComponentMetricsSettings.Builder
By convention, the config key within the component's config section containing metrics settings for the component.
METRICS_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.MetricsConfig
The config key containing settings for all of metrics.
METRICS_CONFIG_KEY - Static variable in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
The config key containing settings for all of metrics.
metricsConfig() - Method in interface io.helidon.metrics.api.MetricsFactory
Returns the MetricsConfig instance used to initialize the metrics factory.
metricsConfig(MetricsConfig) - Method in interface io.helidon.metrics.api.MeterRegistry.Builder
Sets the MetricsConfig for the meter registry, defaulting to the metrics config with which the MetricsFactory was created.
MetricsConfig - Interface in io.helidon.metrics.api
Configuration settings for metrics.
MetricsConfig.Builder - Class in io.helidon.metrics.api
Fluent API builder for MetricsConfig.
MetricsConfig.BuilderBase<BUILDER,PROTOTYPE> - Class in io.helidon.metrics.api
Fluent API builder base for MetricsConfig.
MetricsConfig.BuilderBase.MetricsConfigImpl - Class in io.helidon.metrics.api
Generated implementation of the prototype, can be extended by descendant prototype implementations.
MetricsConfigImpl(MetricsConfig.BuilderBase<?, ?>) - Constructor for class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
Create an instance providing a builder.
MetricsFactory - Interface in io.helidon.metrics.api
The basic contract for implementations of the Helidon metrics API, mostly acting as a factory for meter builders rather than for meters themselves.
MetricsFactoryProvider - Interface in io.helidon.metrics.spi
Creates new instances of MetricsFactory.
MetricsProgrammaticConfig - Interface in io.helidon.metrics.spi
Programmatic (rather than user-configurable) settings that govern certain metrics behavior.
MetricsProgrammaticConfig.Instance - Class in io.helidon.metrics.spi
Internal use class to hold a reference to the singleton.
MICROSECONDS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
MILLISECONDS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
minimumExpectedValue() - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig.Builder
Returns the minimum expected value setting.
minimumExpectedValue() - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig
Returns the minimum expected value that the meter is expected to observe.
minimumExpectedValue() - Method in interface io.helidon.metrics.api.Timer.Builder
Returns the minimum expected value set in the builder, if any.
minimumExpectedValue(Double) - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig.Builder
Sets the minimum value that the meter is expected to observe.
minimumExpectedValue(Duration) - Method in interface io.helidon.metrics.api.Timer.Builder
Sets the minimum expected value the timer is expected to record.
MINUTES - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
monotonicTime() - Method in interface io.helidon.metrics.api.Clock
Returns the current time in nanoseconds from a monotonic clock source.

N

name() - Method in interface io.helidon.metrics.api.Meter.Builder
Returns the name the builder will use.
name() - Method in interface io.helidon.metrics.api.Meter.Id
Returns the meter name.
name() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Name of the scope to which the configuration applies.
name() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase.ScopeConfigImpl
 
name() - Method in interface io.helidon.metrics.api.ScopeConfig
Name of the scope to which the configuration applies.
name(String) - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Name of the scope to which the configuration applies.
NANOSECONDS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
NONE - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
No unit.
noOpMeter(Meter.Builder<?, ?>) - Method in interface io.helidon.metrics.api.MetricsFactory
Returns a no-op Meter of the type implied by the builder's runtime type, initialized with the builder's name and other required parameters.

O

onChange(Consumer<SystemTagsManager>) - Static method in interface io.helidon.metrics.api.SystemTagsManager
Allows subscription to notification when a new system tags manager is created with a new configuration.
onCreate(MeterRegistry, MetricsConfig) - Method in interface io.helidon.metrics.spi.MeterRegistryLifeCycleListener
Receives notification when a new MeterRegistry is created.
onMeterAdded(Consumer<Meter>) - Method in interface io.helidon.metrics.api.MeterRegistry.Builder
Records a subscriber to meter-added events.
onMeterAdded(Consumer<Meter>) - Method in interface io.helidon.metrics.api.MeterRegistry
Enroll a listener to be notified when a Meter is added.
onMeterRemoved(Consumer<Meter>) - Method in interface io.helidon.metrics.api.MeterRegistry.Builder
Records a subscriber to meter-removed events.
onMeterRemoved(Consumer<Meter>) - Method in interface io.helidon.metrics.api.MeterRegistry
Enroll a listener to be notified when a Meter is removed.
OTHER - Enum constant in enum class io.helidon.metrics.api.Meter.Type
Other.
outputSummary(PrintStream, double) - Method in interface io.helidon.metrics.api.HistogramSnapshot
Dumps a summary of the snapshot to the specified PrintStream using the indicated scaling factor for observations.

P

PER_SECOND - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
Represent per second.
PERCENT - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
Represents percentage.
percentile() - Method in interface io.helidon.metrics.api.ValueAtPercentile
Returns the percentile.
percentiles() - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig.Builder
Returns the percentiles.
percentiles() - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig
Returns the settings for non-aggregable percentiles.
percentiles() - Method in interface io.helidon.metrics.api.Timer.Builder
Returns the percentiles set in the builder, if any.
percentiles(double...) - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig.Builder
Specifies time series percentiles.
percentiles(double...) - Method in interface io.helidon.metrics.api.Timer.Builder
Sets the percentiles to compute and publish (expressing, for example, the 95th percentile as 0.95).
percentiles(Iterable<Double>) - Method in interface io.helidon.metrics.api.DistributionStatisticsConfig.Builder
Specifies time series percentiles.
percentileValues() - Method in interface io.helidon.metrics.api.HistogramSnapshot
Returns the values at the configured percentiles for the histogram.
preBuildPrototype() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
Handles providers and decorators.
preBuildPrototype() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Handles providers and decorators.
preBuildPrototype() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Handles providers and decorators.
preBuildPrototype() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Handles providers and decorators.
putScope(String, ScopeConfig) - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
This method adds a new value to the map, or replaces it if the key already exists.
putScope(String, Consumer<ScopeConfig.Builder>) - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
This method adds a new value to the map, or replaces it if the key already exists.

R

record(double) - Method in interface io.helidon.metrics.api.DistributionSummary
Updates the statistics kept by the summary with the specified amount.
record(long, TimeUnit) - Method in interface io.helidon.metrics.api.Timer
Updates the statistics kept by the timer with the specified amount.
record(Runnable) - Method in interface io.helidon.metrics.api.Timer
Executes the Runnable f and records the time it takes.
record(Duration) - Method in interface io.helidon.metrics.api.Timer
Updates the statistics kept by the timer with the specified amount.
record(Callable<T>) - Method in interface io.helidon.metrics.api.Timer
Executes the Callable f and records the time spent it, returning the callable's result.
record(Supplier<T>) - Method in interface io.helidon.metrics.api.Timer
Executes the Supplier f and records the time spent invoking the function.
remove(Meter) - Method in interface io.helidon.metrics.api.MeterRegistry
Removes a previously-registered meter.
remove(Meter.Id) - Method in interface io.helidon.metrics.api.MeterRegistry
Removes a previously-registered meter with the specified ID.
remove(Meter.Id, String) - Method in interface io.helidon.metrics.api.MeterRegistry
Removes a previously-registered meter with the specified ID and scope.
remove(String, Iterable<Tag>) - Method in interface io.helidon.metrics.api.MeterRegistry
Removes a previously-registered meter with the specified name and tags.
remove(String, Iterable<Tag>, String) - Method in interface io.helidon.metrics.api.MeterRegistry
Removes a previously-registered meter with the specified name, tags, and scope.
reservedTagNames() - Method in interface io.helidon.metrics.spi.MetricsProgrammaticConfig
Returns the reserved tag names (for scope and app).
reservedTagNamesUsed(Collection<String>) - Method in interface io.helidon.metrics.api.SystemTagsManager
Scans the provided tag names and throws an exception if any is a reserved tag name.
restRequestEnabled() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
restRequestEnabled() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Whether automatic REST request metrics should be measured.
restRequestEnabled() - Method in interface io.helidon.metrics.api.MetricsConfig
Whether automatic REST request metrics should be measured.
restRequestEnabled(boolean) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Whether automatic REST request metrics should be measured.

S

sample() - Method in interface io.helidon.metrics.api.Sample.Derived
Sample.
sample() - Method in interface io.helidon.metrics.api.SampledMetric
Sample (if available).
Sample - Interface in io.helidon.metrics.api
Common behavior to all types of samples.
Sample.Derived - Interface in io.helidon.metrics.api
Sample that does not exist as an actual observation but is derived from actual observations.
Sample.Labeled - Interface in io.helidon.metrics.api
A sample with a label and a timestamp, typically representing actual observations (rather than derived values).
SampledMetric - Interface in io.helidon.metrics.api
A metric capable of providing samples.
scale() - Method in interface io.helidon.metrics.api.DistributionSummary.Builder
Returns the scale set on the builder.
scale(double) - Method in interface io.helidon.metrics.api.DistributionSummary.Builder
Sets the scale factor for observations recorded by the summary.
scope() - Method in interface io.helidon.metrics.api.Meter.Builder
Returns the scope set in the builder, if any.
scope() - Method in interface io.helidon.metrics.api.Meter
Returns the scope associated with the meter.
scope(String) - Method in interface io.helidon.metrics.api.Meter.Builder
Sets the scope to be associated with this meter.
SCOPE_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.MetricsConfig
Config key for scope-related settings.
SCOPE_CONFIG_KEY - Static variable in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
Config key for scope-related settings.
SCOPE_TAG_NAME_DEFAULT - Static variable in interface io.helidon.metrics.api.ScopingConfig
Default tag name for recording a meter's scope as a tag.
SCOPE_TAG_NAME_DEFAULT - Static variable in class io.helidon.metrics.api.ScopingConfig.BuilderBase.ScopingConfigImpl
Default tag name for recording a meter's scope as a tag.
ScopeConfig - Interface in io.helidon.metrics.api
Configuration settings for a scope within the "metrics" config section.
ScopeConfig.Builder - Class in io.helidon.metrics.api
Fluent API builder for ScopeConfig.
ScopeConfig.BuilderBase<BUILDER,PROTOTYPE> - Class in io.helidon.metrics.api
Fluent API builder base for ScopeConfig.
ScopeConfig.BuilderBase.ScopeConfigImpl - Class in io.helidon.metrics.api
Generated implementation of the prototype, can be extended by descendant prototype implementations.
ScopeConfigImpl(ScopeConfig.BuilderBase<?, ?>) - Constructor for class io.helidon.metrics.api.ScopeConfig.BuilderBase.ScopeConfigImpl
Create an instance providing a builder.
scopeDefaultValue() - Method in interface io.helidon.metrics.spi.MetricsProgrammaticConfig
Default tag value to use for the scope tag if none is specified when the meter ID is created.
Scope handling configuration - Search tag in interface io.helidon.metrics.api.MetricsConfig
Section
scopes() - Method in interface io.helidon.metrics.api.MeterRegistry
Returns the scopes (if any) as represented by tags on meter IDs.
scopes() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Settings for individual scopes.
scopes() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase.ScopingConfigImpl
 
scopes() - Method in interface io.helidon.metrics.api.ScopingConfig
Settings for individual scopes.
scopes(Map<? extends String, ? extends ScopeConfig>) - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
This method replaces all values with the new ones.
scopeTag(Optional<String>) - Method in interface io.helidon.metrics.api.SystemTagsManager
Returns a scope tag so long as the candidate scope or configured default scope are present and the scope tag name is configured.
scopeTagName() - Method in interface io.helidon.metrics.api.SystemTagsManager
Returns the scope tag name derived from configuration.
scopeTagName() - Method in interface io.helidon.metrics.spi.MetricsProgrammaticConfig
Name to use for a tag, added to each meter's identity, conveying its scope in output.
scoping() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
scoping() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Settings related to scoping management.
scoping() - Method in interface io.helidon.metrics.api.MetricsConfig
Settings related to scoping management.
scoping(ScopingConfig) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Settings related to scoping management.
scoping(Consumer<ScopingConfig.Builder>) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Settings related to scoping management.
scoping(Supplier<? extends ScopingConfig>) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Settings related to scoping management.
ScopingConfig - Interface in io.helidon.metrics.api
Interface generated from definition.
ScopingConfig.Builder - Class in io.helidon.metrics.api
Fluent API builder for ScopingConfig.
ScopingConfig.BuilderBase<BUILDER,PROTOTYPE> - Class in io.helidon.metrics.api
Fluent API builder base for ScopingConfig.
ScopingConfig.BuilderBase.ScopingConfigImpl - Class in io.helidon.metrics.api
Generated implementation of the prototype, can be extended by descendant prototype implementations.
ScopingConfigImpl(ScopingConfig.BuilderBase<?, ?>) - Constructor for class io.helidon.metrics.api.ScopingConfig.BuilderBase.ScopingConfigImpl
Create an instance providing a builder.
SECONDS - Static variable in class io.helidon.metrics.api.Meter.BaseUnits
Represents seconds.
size() - Method in interface io.helidon.metrics.api.LabeledSnapshot
Number of values represented by the snapshot.
snapshot() - Method in interface io.helidon.metrics.api.DistributionSummary
Returns a HistogramSnapshot of the current state of the distribution summary.
snapshot() - Method in interface io.helidon.metrics.api.HistogramSupport
Returns a snapshot of the data in a histogram.
snapshot() - Method in interface io.helidon.metrics.api.SnapshotMetric
Snapshot of the metric.
SnapshotMetric - Interface in io.helidon.metrics.api
A metric that is capable of providing snapshots.
start() - Static method in interface io.helidon.metrics.api.Timer
Starts a timing sample using the default system clock.
start(Clock) - Static method in interface io.helidon.metrics.api.Timer
Starts a timing sample using the specified clock.
start(MeterRegistry) - Static method in interface io.helidon.metrics.api.Timer
Starts a timing sample using the clock associated with the specified MeterRegistry.
stateObject() - Method in interface io.helidon.metrics.api.FunctionalCounter.Builder
Returns the state object which would supply the counter value.
stop(Timer) - Method in interface io.helidon.metrics.api.Timer.Sample
Ends the interval, recording the current time as the end time of the interval and applying the elapsed time to the specified Timer.
summary(String, Iterable<Tag>) - Method in interface io.helidon.metrics.api.MeterRegistry
Locates a previously-registered distribution summary.
supplier() - Method in interface io.helidon.metrics.api.Gauge.Builder
Returns a Supplier for the values the gauge will produce.
system() - Static method in interface io.helidon.metrics.api.Clock
Returns the system clock for the Helidon metrics implementation.
SystemTagsManager - Interface in io.helidon.metrics.api
Deals with global, app-level, and scope to be included in the external representation (output and IDs in delegate meter registries) for all metrics.

T

tag(String, String) - Static method in interface io.helidon.metrics.api.Metrics
Creates a Tag for the specified key and value.
Tag - Interface in io.helidon.metrics.api
Behavior of a tag for further identifying meters.
tagCreate(String, String) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a Tag from the specified key and value.
tagName() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase.ScopingConfigImpl
 
tagName() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Tag name for storing meter scope values in the underlying implementation meter registry.
tagName() - Method in interface io.helidon.metrics.api.ScopingConfig
Tag name for storing meter scope values in the underlying implementation meter registry.
tagName(String) - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Tag name for storing meter scope values in the underlying implementation meter registry.
tags() - Method in interface io.helidon.metrics.api.Meter.Builder
Returns the tags the builder will use.
tags() - Method in interface io.helidon.metrics.api.Meter.Id
Returns the tags which further identify the meter.
tags() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
tags() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Global tags.
tags() - Method in interface io.helidon.metrics.api.MetricsConfig
Global tags.
tags(Config) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Global tags.
tags(Iterable<Tag>) - Method in interface io.helidon.metrics.api.Meter.Builder
Sets the tags to use in identifying the build meter.
tags(String...) - Static method in interface io.helidon.metrics.api.Metrics
Returns an Iterable of Tag by interpreting the provided strings as tag name/tag value pairs.
tags(List<? extends Tag>) - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Global tags.
tagsMap() - Method in interface io.helidon.metrics.api.Meter.Id
Return the tags as a map.
timer(String, Iterable<Tag>) - Method in interface io.helidon.metrics.api.MeterRegistry
Locates a previously-registered timer.
Timer - Interface in io.helidon.metrics.api
Records timing information about large numbers of short-running events (e.g., HTTP requests).
TIMER - Enum constant in enum class io.helidon.metrics.api.Meter.Type
Timer (measures count and distribution of completed events).
Timer.Builder - Interface in io.helidon.metrics.api
Builder for a new Timer.
Timer.Sample - Interface in io.helidon.metrics.api
Measures an interval of time from instantiation to an explicit invocation of Timer.Sample.stop(io.helidon.metrics.api.Timer).
timerBuilder(String) - Method in interface io.helidon.metrics.api.MetricsFactory
Creates a builder for a Timer.
timerStart() - Method in interface io.helidon.metrics.api.MetricsFactory
Returns a Timer.Sample for measuring a duration using the system default Clock.
timerStart(Clock) - Method in interface io.helidon.metrics.api.MetricsFactory
Returns a Timer.Sample for measuring a duration using the specified Clock.
timerStart(MeterRegistry) - Method in interface io.helidon.metrics.api.MetricsFactory
Returns a Timer.Sample for measuring a duration, using the clock associated with the specified MeterRegistry.
timestamp() - Method in class io.helidon.metrics.api.LabeledSample
 
timestamp() - Method in interface io.helidon.metrics.api.Sample.Labeled
Timestamp the value was recorded.
toString() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase.KeyPerformanceIndicatorMetricsConfigImpl
 
toString() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
 
toString() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase.MetricsConfigImpl
 
toString() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
 
toString() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase.ScopeConfigImpl
 
toString() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
 
toString() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase.ScopingConfigImpl
 
toString() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
 
total() - Method in interface io.helidon.metrics.api.HistogramSnapshot
Returns the total value over all observations in the snapshot.
total(TimeUnit) - Method in interface io.helidon.metrics.api.HistogramSnapshot
Returns the total value over all observations, interpreting the values as times in nanoseconds and expressing the time in the specified TimeUnit.
totalAmount() - Method in interface io.helidon.metrics.api.DistributionSummary
Returns the total of the observations recorded by the distribution summary.
totalTime(TimeUnit) - Method in interface io.helidon.metrics.api.Timer
Returns the total time, expressed in the specified units, consumed by completed events measured by the timer.
type() - Method in interface io.helidon.metrics.api.Meter
Returns the meter type.

U

unwrap(Class<? extends R>) - Method in interface io.helidon.metrics.api.Clock
Unwraps the clock to the specified type (typically not needed for custom clocks).
unwrap(Class<? extends R>) - Method in interface io.helidon.metrics.api.Meter.Id
Unwraps the ID as the specified type.
unwrap(Class<? extends R>) - Method in interface io.helidon.metrics.api.Wrapper
Unwraps the delegate as the specified type.

V

validatePrototype() - Method in class io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.BuilderBase
Validates required properties.
validatePrototype() - Method in class io.helidon.metrics.api.MetricsConfig.BuilderBase
Validates required properties.
validatePrototype() - Method in class io.helidon.metrics.api.ScopeConfig.BuilderBase
Validates required properties.
validatePrototype() - Method in class io.helidon.metrics.api.ScopingConfig.BuilderBase
Validates required properties.
value() - Method in interface io.helidon.metrics.api.Gauge
Returns the value of the gauge.
value() - Method in class io.helidon.metrics.api.LabeledSample
 
value() - Method in interface io.helidon.metrics.api.Sample.Derived
Derived value (usually computed).
value() - Method in interface io.helidon.metrics.api.Sample.Labeled
The value.
value() - Method in interface io.helidon.metrics.api.Tag
Returns the tag's value.
value() - Method in interface io.helidon.metrics.api.ValueAtPercentile
Returns the value at this percentile.
value(double) - Method in interface io.helidon.metrics.api.LabeledSnapshot
Value of a specific quantile.
value(TimeUnit) - Method in interface io.helidon.metrics.api.ValueAtPercentile
Returns the value of this percentile interpreted as time in nanoseconds converted to the specified TimeUnit.
ValueAtPercentile - Interface in io.helidon.metrics.api
Percentile and value at that percentile within a distribution.
valueOf(String) - Static method in enum class io.helidon.metrics.api.Meter.Type
Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.helidon.metrics.api.Meter.Type
Returns an array containing the constants of this enum class, in the order they are declared.
VENDOR - Static variable in class io.helidon.metrics.api.Meter.Scope
Vendor scope.

W

wallTime() - Method in interface io.helidon.metrics.api.Clock
Returns the current wall time in milliseconds since the epoch.
withoutSystemOrScopeTags(Iterable<Tag>) - Method in interface io.helidon.metrics.api.SystemTagsManager
Returns an Iterable of Tag omitting system and scope tags.
withoutSystemTags(Iterable<Tag>) - Method in interface io.helidon.metrics.api.SystemTagsManager
Returns an Iterable of Tag omitting any system tags but including the scope tag, if these appear in the provided tags.
withScopeTag(Iterable<Tag>, Optional<String>) - Method in interface io.helidon.metrics.api.SystemTagsManager
Augments, if necessary, the provided tags with an additional tag with the scope tag name and value from the explicit scope provided, an existing tag, or the default scope value, if configured.
withScopeTag(Iterable<Map.Entry<String, String>>, String) - Method in interface io.helidon.metrics.api.SystemTagsManager
Augments map entries (tag names and values) with, possibly, one more for the scope (if configured that way).
wrap(Runnable) - Method in interface io.helidon.metrics.api.Timer
Wraps a Runnable so that it will be timed every time it is invoked via the return value from this method.
wrap(Callable<T>) - Method in interface io.helidon.metrics.api.Timer
Wraps a Callable so that it is will be timed every time it is invoked via the return value from this method.
wrap(Supplier<T>) - Method in interface io.helidon.metrics.api.Timer
Wraps a Supplier so that it will be timed every time it is invoked via the return value from this method.
Wrapper - Interface in io.helidon.metrics.api
Behavior of a type that wraps a related type, typically through delegation.

Z

ZERO - Static variable in interface io.helidon.metrics.api.Sample.Derived
A derived sample with zero value and no reference.
A B C D E F G H I K L M N O P R S T U V W Z 
All Classes and Interfaces|All Packages|Constant Field Values