Class MetricsControlPanel

java.lang.Object

io.micronaut.controlpanel.core.AbstractControlPanel<MetricsControlPanel.MetricsBody>

io.micronaut.controlpanel.panels.management.MetricsControlPanel

All Implemented Interfaces:

ConfigurableControlPanel, ControlPanel<MetricsControlPanel.MetricsBody>, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, io.micronaut.core.util.Toggleable

@Singleton
@Requires(beans=io.micronaut.configuration.metrics.management.endpoint.MetricsEndpoint.class) @Requires(property="micronaut.control-panel.panels.metrics.enabled",notEquals="false")
public class MetricsControlPanel
extends AbstractControlPanel<MetricsControlPanel.MetricsBody>

Control panel that displays Micrometer metric names and details.

Since:

2.0.0

Author:

Álvaro Sánchez-Mariscal

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MetricsControlPanel.MetricsBody	Body model for the metrics panel summary.

Nested classes/interfaces inherited from interface ControlPanel

ControlPanel.Category, ControlPanel.View

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENABLED_PROPERTY
static final String	NAME

Fields inherited from class AbstractControlPanel

configuration, controlPanelName

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
MetricsControlPanel(io.micronaut.configuration.metrics.management.endpoint.MetricsEndpoint endpoint, ControlPanelConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
String	getBadge()	Badge text to be displayed in the header of the card UI element.
MetricsControlPanel.MetricsBody	getBody()	Used to render the body of the control panel.

Methods inherited from class AbstractControlPanel

getIcon, getName, getOrder, getTitle, isEnabled

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ControlPanel

getBodyView, getCategory, getDetailedView, getDetailLinkName, hasDetails

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

ENABLED_PROPERTY

public static final String ENABLED_PROPERTY

See Also:

• Constant Field Values

Constructor Details

MetricsControlPanel

public MetricsControlPanel(io.micronaut.configuration.metrics.management.endpoint.MetricsEndpoint endpoint,
 @Named("metrics")
 ControlPanelConfiguration configuration)

Method Details

getBody

public MetricsControlPanel.MetricsBody getBody()

Description copied from interface: ControlPanel

Used to render the body of the control panel.

Returns:

the body of the control panel.

getBadge

public String getBadge()

Description copied from interface: ControlPanel

Badge text to be displayed in the header of the card UI element.

Returns:

the badge text of the control panel.