Module io.helidon.metrics.api

Package io.helidon.metrics.spi

Interface MeterRegistryFormatterProvider

All Known Implementing Classes:

JsonMeterRegistryFormatterProvider, MicrometerPrometheusFormatterProvider

public interface MeterRegistryFormatterProvider

Behavior for providers of meter registry formatters, which (if then can) furnish a formatter given a MediaType.

We use a provider approach so code can obtain and run formatters that might depend heavily on particular implementations without the calling code having to share that heavy dependency.

Method Summary

Modifier and Type	Method	Description
Optional<MeterRegistryFormatter>	formatter(MediaType mediaType, MetricsConfig metricsConfig, MeterRegistry meterRegistry, Optional<String> scopeTagName, Iterable<String> scopeSelection, Iterable<String> nameSelection)	Returns, if possible, a MeterRegistryFormatter capable of preparing output according to the specified MediaType.

Method Details

formatter

Optional<MeterRegistryFormatter> formatter(MediaType mediaType,
 MetricsConfig metricsConfig,
 MeterRegistry meterRegistry,
 Optional<String> scopeTagName,
 Iterable<String> scopeSelection,
 Iterable<String> nameSelection)

Returns, if possible, a MeterRegistryFormatter capable of preparing output according to the specified MediaType.

Parameters:

mediaType - media type of the desired output

metricsConfig - MetricsConfig to influence the formatting

meterRegistry - MeterRegistry from which to gather data

scopeTagName - tag name used to record scope

scopeSelection - scope names to format; empty means no scope-based restriction

nameSelection - meter names to format; empty means no name-based restriction

Returns:

compatible formatter; empty if none