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
default Optional<MeterRegistryFormatter>	formatter(MediaType mediaType, MetricsConfig metricsConfig, MeterRegistry meterRegistry, Map<String, Collection<String>> tagSelections, Iterable<String> nameSelection)	Returns, if possible, a MeterRegistryFormatter capable of preparing output according to the specified MediaType and selections.
Optional<MeterRegistryFormatter>	formatter(MediaType mediaType, MetricsConfig metricsConfig, MeterRegistry meterRegistry, Optional<String> scopeTagName, Iterable<String> scopeSelection, Iterable<String> nameSelection)	Deprecated, for removal: This API element is subject to removal in a future version. Use formatter(MediaType, MetricsConfig, MeterRegistry, Map, Iterable).

Method Details

formatter

default Optional<MeterRegistryFormatter> formatter(MediaType mediaType,
 MetricsConfig metricsConfig,
 MeterRegistry meterRegistry,
 Map<String, Collection<String>> tagSelections,
 Iterable<String> nameSelection)

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

Parameters:

mediaType - media type of the desired output

metricsConfig - MetricsConfig to influence the formatting

meterRegistry - MeterRegistry from which to gather data

tagSelections - tag names and accepted values to format; empty means no tag-based restriction

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

Returns:

compatible formatter; empty if none

Since:

27.0.0

formatter

@Deprecated(forRemoval=true,
            since="27.0.0")
Optional<MeterRegistryFormatter> formatter(MediaType mediaType,
 MetricsConfig metricsConfig,
 MeterRegistry meterRegistry,
 Optional<String> scopeTagName,
 Iterable<String> scopeSelection,
 Iterable<String> nameSelection)

Deprecated, for removal: This API element is subject to removal in a future version.

Use formatter(MediaType, MetricsConfig, MeterRegistry, Map, Iterable). Scope-specific arguments are ignored and this method will be removed.

Returns a formatter, if possible, ignoring the scope-specific arguments.

Parameters:

mediaType - media type of the desired output

metricsConfig - MetricsConfig to influence the formatting

meterRegistry - MeterRegistry from which to gather data

scopeTagName - ignored; must not be null

scopeSelection - ignored; must not be null

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

Returns:

compatible formatter; empty if none