A B C D E F G H I K L M P Q R S T U
All Classes All Packages

A

AbstractMetric - Class in io.helidon.metrics.api

Common reusable implementation for any category of metric implementation (full-featured, no-op).

AbstractMetric(String, Metadata) - Constructor for class io.helidon.metrics.api.AbstractMetric

AbstractRegistry<M extends HelidonMetric> - Class in io.helidon.metrics.api

Common behavior for any category (e.g., full-featured or no-op) metrics registry.

AbstractRegistry(MetricRegistry.Type, Class<M>) - Constructor for class io.helidon.metrics.api.AbstractRegistry

Create a registry of a certain type.

B

BASE_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.MetricsSettings.Builder

Config key within the config metrics section controlling the base registry.

BASE_METRICS_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.BaseMetricsSettings.Builder

Config key within the config metrics section controlling base metrics behavior.

baseMetricEnabledSettings() - Method in interface io.helidon.metrics.api.BaseMetricsSettings

baseMetricsSettings() - Method in interface io.helidon.metrics.api.MetricsSettings

baseMetricsSettings(BaseMetricsSettings.Builder) - Method in interface io.helidon.metrics.api.MetricsSettings.Builder

Set the base metrics settings.

BaseMetricsSettings - Interface in io.helidon.metrics.api

Settings which control base metrics.

BaseMetricsSettings.Builder - Interface in io.helidon.metrics.api

Builder for BaseMetricsSettings.

build() - Method in interface io.helidon.metrics.api.ComponentMetricsSettings.Builder

Constructs a ComponentMetricsSettings object from the builder.

build() - Method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

Builds a KeyPerformanceIndicatorMetricsSettings using the settings from the builder.

build() - Method in interface io.helidon.metrics.api.MetricsSettings.Builder

Constructs a MetricsSettings object from the builder.

build() - Method in interface io.helidon.metrics.api.RegistrySettings.Builder

Creates a new RegistrySettings instance from the builder.

builder() - Static method in interface io.helidon.metrics.api.BaseMetricsSettings

Creates a new instance of the builder for BaseMetricsSettings.

builder() - Static method in interface io.helidon.metrics.api.ComponentMetricsSettings

Returns a builder for ComponentMetricsSettings.

builder() - Static method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings

Creates a new builder for the settings.

builder() - Static method in interface io.helidon.metrics.api.MetricsSettings

Returns a builder for MetricsSettings.

builder() - Static method in interface io.helidon.metrics.api.RegistryFilterSettings

Creates a new default builder for RegistryFilterSettings.

builder() - Static method in interface io.helidon.metrics.api.RegistrySettings

Creates a new defaulted builder for RegistrySettings.

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(BaseMetricsSettings) - Static method in interface io.helidon.metrics.api.BaseMetricsSettings

Creates a new instance of the builder based on the current settings in a BaseMetricsSettings object.

builder(KeyPerformanceIndicatorMetricsSettings) - Static method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings

Creates a builder using the values from an existing KeyPerformanceIndicatorMetricsSettings instance.

builder(MetricsSettings) - Static method in interface io.helidon.metrics.api.MetricsSettings

Creates a builder based on the values in an existing MetricsSettings instance.

C

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.

concurrentGauge(String) - Method in class io.helidon.metrics.api.AbstractRegistry

concurrentGauge(String, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

concurrentGauge(Metadata) - Method in class io.helidon.metrics.api.AbstractRegistry

concurrentGauge(Metadata, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

config(Config) - Method in interface io.helidon.metrics.api.BaseMetricsSettings.Builder

Sets values in the builder based on the provided Config node.

config(Config) - Method in interface io.helidon.metrics.api.ComponentMetricsSettings.Builder

Updates the builder using the provided metrics config.

config(Config) - Method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

Updates the KPI metrics settings in the builder based on the provided Config object.

config(Config) - Method in interface io.helidon.metrics.api.MetricsSettings.Builder

Updates the builder using the provided metrics config.

config(Config) - Method in interface io.helidon.metrics.api.RegistryFilterSettings.Builder

Sets whichever values are specified by the provided filter config node.

config(Config) - Method in interface io.helidon.metrics.api.RegistrySettings.Builder

Sets values in the builder based on the provided Config node.

CONFIG_KEY_PREFIX - Static variable in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

counter(String) - Method in class io.helidon.metrics.api.AbstractRegistry

counter(String, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

counter(Metadata) - Method in class io.helidon.metrics.api.AbstractRegistry

counter(Metadata, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

create() - Static method in interface io.helidon.metrics.api.BaseMetricsSettings

Creates a new instance of BaseMetricsSettings with defaults.

create() - Static method in interface io.helidon.metrics.api.MetricsSettings

Returns default metrics settings based on default config.

create() - Static method in interface io.helidon.metrics.api.RegistryFactory

Returns a RegistryFactory according to the default metrics settings.

create() - Static method in interface io.helidon.metrics.api.RegistryFilterSettings

Creates a new default instance of RegistryFilterSettings.

create() - Static method in interface io.helidon.metrics.api.RegistrySettings

Creates a new default RegistrySettings instance.

create(Config) - Static method in interface io.helidon.metrics.api.BaseMetricsSettings

Creates a new instance of BaseMetricsSettings based on the specified Config node containing base metrics settings.

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.KeyPerformanceIndicatorMetricsSettings

Creates a new KeyPerformanceIndicatorMetricsSettings instance from the specified config node containing KPI metrics settings.

create(Config) - Static method in interface io.helidon.metrics.api.MetricsSettings

Returns metrics settings based on a Config node, by convention the metrics config section within the overall metrics config.

create(Config) - Static method in interface io.helidon.metrics.api.RegistryFactory

Deprecated.

Use create(MetricsSettings) instead

create(Config) - Static method in interface io.helidon.metrics.api.RegistryFilterSettings.Builder

Returns a new builder initialized according to the specific configuration.

create(Config) - Static method in interface io.helidon.metrics.api.RegistrySettings

Creates a new RegistrySettings instance using the provided config.

create(MetricsSettings) - Static method in interface io.helidon.metrics.api.RegistryFactory

Returns a RegistryFactory according to the specified MetricsSettings.

create(MetricsSettings) - Method in interface io.helidon.metrics.api.spi.RegistryFactoryProvider

Creates a new RegistryFactory according to the specified metrics settings.

D

DEFAULT_CONTEXT - Static variable in interface io.helidon.metrics.api.MetricsSettings.Builder

Default web context for the metrics endpoint.

deriveType(MetricType, Metric) - Static method in class io.helidon.metrics.api.AbstractRegistry

E

empty() - Method in class io.helidon.metrics.api.AbstractRegistry

Determines if registry is empty.

enableBaseMetric(String, boolean) - Method in interface io.helidon.metrics.api.BaseMetricsSettings.Builder

Sets whether a specific base metric should be enabled.

enabled(boolean) - Method in interface io.helidon.metrics.api.BaseMetricsSettings.Builder

Sets whether base metrics should be 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 interface io.helidon.metrics.api.MetricsSettings.Builder

Sets whether metrics should be enabled.

enabled(boolean) - Method in interface io.helidon.metrics.api.RegistrySettings.Builder

Sets whether the metric type should be enabled.

ENABLED_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.BaseMetricsSettings.Builder

Config key within the config {code metrics.base} section controlling whether base metrics should be 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.

ENABLED_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.MetricsSettings.Builder

Config key within the config metrics section controlling whether metrics are enabled.

ENABLED_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.RegistrySettings.Builder

Config key within the registry's config section controlling whether the current type of metrics should be enabled.

exclude(String) - Method in interface io.helidon.metrics.api.RegistryFilterSettings.Builder

Sets the regex for names to exclude.

EXCLUDE_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.RegistryFilterSettings.Builder

Config key within the filter section for the regex for names to exclude.

extended(boolean) - Method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

Sets whether exntended KPI metrics should be enabled in the settings.

F

FILTER_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.RegistrySettings.Builder

Config key within the registry's config section specifying a filter.

filterSettings(RegistryFilterSettings.Builder) - Method in interface io.helidon.metrics.api.RegistrySettings.Builder

Sets the filter to use for identifying specific metrics to enable.

G

getConcurrentGauges() - Method in class io.helidon.metrics.api.AbstractRegistry

getConcurrentGauges(MetricFilter) - Method in class io.helidon.metrics.api.AbstractRegistry

getCounters() - Method in class io.helidon.metrics.api.AbstractRegistry

getCounters(MetricFilter) - Method in class io.helidon.metrics.api.AbstractRegistry

getGauges() - Method in class io.helidon.metrics.api.AbstractRegistry

getGauges(MetricFilter) - Method in class io.helidon.metrics.api.AbstractRegistry

getHistograms() - Method in class io.helidon.metrics.api.AbstractRegistry

getHistograms(MetricFilter) - Method in class io.helidon.metrics.api.AbstractRegistry

getInstance() - Static method in interface io.helidon.metrics.api.RegistryFactory

Returns the singleton instance of the RegistryFactory, either the initial default value or the one resulting from the most recent prior use of getInstance(MetricsSettings) or getInstance(Config).

getInstance(Config) - Static method in interface io.helidon.metrics.api.RegistryFactory

Deprecated.

Use getInstance(MetricsSettings) instead

getInstance(ComponentMetricsSettings) - Static method in interface io.helidon.metrics.api.RegistryFactory

Returns a RegistryFactory according to the ComponentMetricsSettings provided and the underlying overall metrics settings.

getInstance(MetricsSettings) - Static method in interface io.helidon.metrics.api.RegistryFactory

Returns a RegistryFactory according to the MetricsSettings provided and makes the instance the new value of the singleton.

getMetadata() - Method in class io.helidon.metrics.api.AbstractRegistry

getMeters() - Method in class io.helidon.metrics.api.AbstractRegistry

getMeters(MetricFilter) - Method in class io.helidon.metrics.api.AbstractRegistry

getMetric(String) - Method in class io.helidon.metrics.api.AbstractRegistry

Access a metric by name.

getMetricIDs() - Method in class io.helidon.metrics.api.AbstractRegistry

getMetrics() - Method in class io.helidon.metrics.api.AbstractRegistry

getMetricsByName(String) - Method in class io.helidon.metrics.api.AbstractRegistry

getNames() - Method in class io.helidon.metrics.api.AbstractRegistry

getOptionalMetricEntry(String) - Method in class io.helidon.metrics.api.AbstractRegistry

getOptionalMetricWithIDsEntry(String) - Method in class io.helidon.metrics.api.AbstractRegistry

Get internal map entry given a metric name.

getRegistry(MetricRegistry.Type) - Method in interface io.helidon.metrics.api.RegistryFactory

Returns a MetricRegistry instance of the requested type.

getSimpleTimers() - Method in class io.helidon.metrics.api.AbstractRegistry

getSimpleTimers(MetricFilter) - Method in class io.helidon.metrics.api.AbstractRegistry

getTimers() - Method in class io.helidon.metrics.api.AbstractRegistry

getTimers(MetricFilter) - Method in class io.helidon.metrics.api.AbstractRegistry

H

HelidonMetric - Interface in io.helidon.metrics.api

Helidon-required behavior for each type (e.g., full-featured or no-op) of metric implementation.

histogram(String) - Method in class io.helidon.metrics.api.AbstractRegistry

histogram(String, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

histogram(Metadata) - Method in class io.helidon.metrics.api.AbstractRegistry

histogram(Metadata, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

I

include(String) - Method in interface io.helidon.metrics.api.RegistryFilterSettings.Builder

Sets the refex for names to include.

INCLUDE_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.RegistryFilterSettings.Builder

Config key within the filter section for the regex for names to include.

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.api.spi - package io.helidon.metrics.api.spi

SPI for the metrics API.

isBaseMetricEnabled(String) - Method in interface io.helidon.metrics.api.BaseMetricsSettings

isDeleted() - Method in class io.helidon.metrics.api.AbstractMetric

isDeleted() - Method in interface io.helidon.metrics.api.HelidonMetric

isEnabled() - Method in interface io.helidon.metrics.api.BaseMetricsSettings.Builder

isEnabled() - Method in interface io.helidon.metrics.api.BaseMetricsSettings

isEnabled() - Method in interface io.helidon.metrics.api.ComponentMetricsSettings

isEnabled() - Method in interface io.helidon.metrics.api.MetricsSettings

isEnabled() - Method in interface io.helidon.metrics.api.RegistrySettings.Builder

isEnabled() - Method in interface io.helidon.metrics.api.RegistrySettings

Returns whether metrics of this type are enabled.

isExtended() - Method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

isExtended() - Method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings

isMarkedAsDeleted(Metric) - Static method in class io.helidon.metrics.api.AbstractRegistry

Indicates whether the specific metrics has been marked as deleted.

isMarkedAsDeleted(Metric) - Static method in interface io.helidon.metrics.api.HelidonMetric

Indicates if the specified metric is known to have been marked as deleted.

isMetricEnabled(String) - Method in class io.helidon.metrics.api.AbstractRegistry

isMetricEnabled(String) - Method in interface io.helidon.metrics.api.RegistrySettings

Returns whether the specified metric name is enabled or not, factoring in the enabled setting for this type as a whole with the regex pattern.

isMetricEnabled(MetricRegistry.Type, String) - Method in interface io.helidon.metrics.api.MetricsSettings

Reports whether the specified metric is enabled in the indicated registry type.

K

KEY_PERFORMANCE_INDICATORS_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

Config key for extended key performance indicator metrics settings.

KEY_PERFORMANCE_INDICATORS_EXTENDED_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

Config key for enabled setting of the extended KPI metrics.

KEY_PERFORMANCE_INDICATORS_EXTENDED_DEFAULT - Static variable in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

Default enabled setting for extended KPI metrics.

KeyPerformanceIndicatorMetricsSettings - Interface in io.helidon.metrics.api

Settings for key performance indicator (KPI) metrics.

KeyPerformanceIndicatorMetricsSettings.Builder - Interface in io.helidon.metrics.api

Override default settings.

keyPerformanceIndicatorSettings() - Method in interface io.helidon.metrics.api.MetricsSettings

keyPerformanceIndicatorSettings(KeyPerformanceIndicatorMetricsSettings.Builder) - Method in interface io.helidon.metrics.api.MetricsSettings.Builder

Set the KPI metrics settings.

L

LONG_RUNNING_REQUESTS_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

Config key for long-running requests settings.

LONG_RUNNING_REQUESTS_THRESHOLD_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

Config key for long-running requests threshold setting (in milliseconds).

LONG_RUNNING_REQUESTS_THRESHOLD_MS_DEFAULT - Static variable in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

Default long-running requests threshold.

longRunningRequestThresholdMs() - Method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

longRunningRequestThresholdMs() - Method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings

longRunningRequestThresholdMs(long) - Method in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

Sets the long-running request threshold (in ms).

M

markAsDeleted() - Method in class io.helidon.metrics.api.AbstractMetric

markAsDeleted() - Method in interface io.helidon.metrics.api.HelidonMetric

Record that a previously-registered metric has been removed from the registry.

metadata() - Method in class io.helidon.metrics.api.AbstractMetric

metadata() - Method in interface io.helidon.metrics.api.HelidonMetric

meter(String) - Method in class io.helidon.metrics.api.AbstractRegistry

meter(String, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

meter(Metadata) - Method in class io.helidon.metrics.api.AbstractRegistry

meter(Metadata, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

metricFactories() - Method in class io.helidon.metrics.api.AbstractRegistry

metricIDsForName(String) - Method in class io.helidon.metrics.api.AbstractRegistry

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.MetricsSettings.Builder

The config key containing settings for all of metrics.

MetricsSettings - Interface in io.helidon.metrics.api

Settings which control behavior for metrics overall.

MetricsSettings.Builder - Interface in io.helidon.metrics.api

Builder for MetricsSettings.

P

passes(String) - Method in interface io.helidon.metrics.api.RegistryFilterSettings

Reports whether a given metric name passes the filter.

prepareMetricFactories() - Method in class io.helidon.metrics.api.AbstractRegistry

prepareMetricToTypeMap() - Method in class io.helidon.metrics.api.AbstractRegistry

Q

QUALIFIED_LONG_RUNNING_REQUESTS_THRESHOLD_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.KeyPerformanceIndicatorMetricsSettings.Builder

R

register(String, T) - Method in class io.helidon.metrics.api.AbstractRegistry

register(Metadata, T) - Method in class io.helidon.metrics.api.AbstractRegistry

register(Metadata, T, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

REGISTRIES_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.MetricsSettings.Builder

Config key within the config metrics section containing settings for individual registries.

RegistryFactory - Interface in io.helidon.metrics.api

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 getInstance() method).

RegistryFactoryProvider - Interface in io.helidon.metrics.api.spi

Provides RegistryFactory instances.

RegistryFilterSettings - Interface in io.helidon.metrics.api

Filter settings for registries.

RegistryFilterSettings.Builder - Interface in io.helidon.metrics.api

Builder for a new RegistryFilterSettings instance.

registrySettings() - Method in class io.helidon.metrics.api.AbstractRegistry

registrySettings(MetricRegistry.Type) - Method in interface io.helidon.metrics.api.MetricsSettings

Returns the RegistrySettings for the indicated registry type.

registrySettings(MetricRegistry.Type, RegistrySettings) - Method in interface io.helidon.metrics.api.MetricsSettings.Builder

Sets the registry settings for the specified registry type.

RegistrySettings - Interface in io.helidon.metrics.api

Settings which control metrics within registries (application, vendor, base) as a group or individually.

RegistrySettings.Builder - Interface in io.helidon.metrics.api

Builder for RegistrySettings.

registryType() - Method in class io.helidon.metrics.api.AbstractMetric

registryType() - Method in class io.helidon.metrics.api.AbstractRegistry

registryType() - Method in interface io.helidon.metrics.api.HelidonMetric

remove(String) - Method in class io.helidon.metrics.api.AbstractRegistry

Removes a metric by name.

remove(MetricID) - Method in class io.helidon.metrics.api.AbstractRegistry

Removes a metric by ID.

removeMatching(MetricFilter) - Method in class io.helidon.metrics.api.AbstractRegistry

S

simpleTimer(String) - Method in class io.helidon.metrics.api.AbstractRegistry

simpleTimer(String, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

simpleTimer(Metadata) - Method in class io.helidon.metrics.api.AbstractRegistry

simpleTimer(Metadata, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

stream() - Method in class io.helidon.metrics.api.AbstractRegistry

Returns a stream of Map.Entry for this registry for enabled metrics.

T

timer(String) - Method in class io.helidon.metrics.api.AbstractRegistry

timer(String, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

timer(Metadata) - Method in class io.helidon.metrics.api.AbstractRegistry

timer(Metadata, Tag...) - Method in class io.helidon.metrics.api.AbstractRegistry

toImpl(Metadata, T) - Method in class io.helidon.metrics.api.AbstractRegistry

Creates a new instance of an implementation wrapper around the indicated metric.

toString() - Method in class io.helidon.metrics.api.AbstractRegistry

type() - Method in class io.helidon.metrics.api.AbstractRegistry

Returns type of this registry.

TYPE_CONFIG_KEY - Static variable in interface io.helidon.metrics.api.RegistrySettings.Builder

Config key within the registry's config section identifying which registry type the settings apply to.

U

update(MetricsSettings) - Method in interface io.helidon.metrics.api.RegistryFactory

Updates the metrics settings for the RegistryFactory.

A B C D E F G H I K L M P Q R S T U
All Classes All Packages