Package org.hyperledger.besu.plugin.services.metrics

Interface MetricCategory

public interface MetricCategory

A MetricCategory is used to group related metrics. Every metric belongs to one and only one MetricCategory.

Categories must be registered with the MetricCategoryRegistry during plugin initialisation.

Method Summary

Modifier and Type	Method	Description
java.util.Optional<java.lang.String>	getApplicationPrefix()	Gets the application-specific MetricCategory prefix.
java.lang.String	getName()	Gets the name of this MetricCategory.

Method Detail

getName

java.lang.String getName()

Gets the name of this MetricCategory.

Returns:

The name of this MetricCategory.

getApplicationPrefix

java.util.Optional<java.lang.String> getApplicationPrefix()

Gets the application-specific MetricCategory prefix. An empty Optional may be returned if this category is not application specific.

The prefix, if present, is prepended to the category name when creating a single combined name for metrics.

Returns:

An optional application prefix.