fish.payara.microprofile.metrics

Class MetricsService

java.lang.Object

fish.payara.microprofile.metrics.MetricsService

All Implemented Interfaces:

MonitoringDataSource, EventListener, ConfigListener

@Service(name="microprofile-metrics-service")
 @RunLevel(value=10)
public class MetricsService
extends Object
implements EventListener, ConfigListener, MonitoringDataSource

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.api.event.EventListener

EventListener.Event<T>

Constructor Summary

Constructors

Constructor and Description
MetricsService()

Method Summary

Modifier and Type	Method and Description
UnprocessedChangeEvents	changed(PropertyChangeEvent[] events) Notification that @Configured objects that were injected have changed
void	collect(MonitoringDataCollector rootCollector) Collects all the data points of this at the current moment.
void	event(EventListener.Event event) Process a Glassfish/Payara event
Set<String>	getAllRegistryNames()
String	getApplicationName() Gets the application name from the invocation manager.
Set<String>	getApplicationRegistryNames()
Map<String,org.eclipse.microprofile.metrics.Metadata>	getMetadataAsMap(String registryName)
Map<String,org.eclipse.microprofile.metrics.Metadata>	getMetadataAsMap(String registryName, String metricName)
Map<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Metric>	getMetricsAsMap(String registryName)
Map<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Metric>	getMetricsAsMap(String registryName, String metricName)
Set<org.eclipse.microprofile.metrics.MetricID>	getMetricsIDs(String registryName, String metricName)
org.eclipse.microprofile.metrics.MetricRegistry	getOrAddRegistry(String registryName) Returns the Metrics registry based on respective registry name, if not available then add the new MetricRegistry instance
org.eclipse.microprofile.metrics.MetricRegistry	getRegistry(String registryName) Returns the Metrics registry based on respective registry name
void	init()
Boolean	isEnabled()
Boolean	isMetricsSecure()
boolean	isSecurityEnabled()
org.eclipse.microprofile.metrics.MetricRegistry	removeRegistry(String registryName) Remove the Metrics registry
void	reregisterMetadataConfig() Registers unresolved MBeans if they have been started after the metrics service.
void	resetMetricsEnabledProperty()
void	resetMetricsSecureProperty()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsService

public MetricsService()

Method Detail

init

@PostConstruct
public void init()

collect

public void collect(MonitoringDataCollector rootCollector)

Description copied from interface: MonitoringDataSource

Collects all the data points of this at the current moment.

Specified by:

collect in interface MonitoringDataSource

Parameters:

rootCollector - the MonitoringDataCollector instance to use to collect the data points of this source

event

public void event(EventListener.Event event)

Description copied from interface: EventListener

Process a Glassfish/Payara event

Specified by:

event in interface EventListener

reregisterMetadataConfig

public void reregisterMetadataConfig()

Registers unresolved MBeans if they have been started after the metrics service.

isEnabled

public Boolean isEnabled()

resetMetricsEnabledProperty

public void resetMetricsEnabledProperty()

isMetricsSecure

public Boolean isMetricsSecure()

resetMetricsSecureProperty

public void resetMetricsSecureProperty()

isSecurityEnabled

public boolean isSecurityEnabled()

getMetricsAsMap

public Map<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Metric> getMetricsAsMap(String registryName)
                                                                                                       throws NoSuchRegistryException

Throws:

NoSuchRegistryException

getMetadataAsMap

public Map<String,org.eclipse.microprofile.metrics.Metadata> getMetadataAsMap(String registryName)
                                                                       throws NoSuchRegistryException

Throws:

NoSuchRegistryException

getMetricsIDs

public Set<org.eclipse.microprofile.metrics.MetricID> getMetricsIDs(String registryName,
                                                                    String metricName)
                                                             throws NoSuchRegistryException

Throws:

NoSuchRegistryException

getMetricsAsMap

public Map<org.eclipse.microprofile.metrics.MetricID,org.eclipse.microprofile.metrics.Metric> getMetricsAsMap(String registryName,
                                                                                                              String metricName)
                                                                                                       throws NoSuchRegistryException

Throws:

NoSuchRegistryException

getMetadataAsMap

public Map<String,org.eclipse.microprofile.metrics.Metadata> getMetadataAsMap(String registryName,
                                                                              String metricName)
                                                                       throws NoSuchRegistryException,
                                                                              NoSuchMetricException

Throws:

NoSuchRegistryException

NoSuchMetricException

getRegistry

public org.eclipse.microprofile.metrics.MetricRegistry getRegistry(String registryName)
                                                            throws NoSuchRegistryException

Returns the Metrics registry based on respective registry name

Parameters:

registryName -

Returns:

Throws:

NoSuchRegistryException

getApplicationRegistryNames

public Set<String> getApplicationRegistryNames()

getAllRegistryNames

public Set<String> getAllRegistryNames()

getOrAddRegistry

public org.eclipse.microprofile.metrics.MetricRegistry getOrAddRegistry(String registryName)

Returns the Metrics registry based on respective registry name, if not available then add the new MetricRegistry instance

Parameters:

registryName -

Returns:

removeRegistry

public org.eclipse.microprofile.metrics.MetricRegistry removeRegistry(String registryName)

Remove the Metrics registry

Parameters:

registryName -

Returns:

getApplicationName

public String getApplicationName()

Gets the application name from the invocation manager.

Returns:

The application name

changed

public UnprocessedChangeEvents changed(PropertyChangeEvent[] events)

Description copied from interface: ConfigListener

Notification that @Configured objects that were injected have changed

Specified by:

changed in interface ConfigListener

Parameters:

events - list of changes

Returns:

the list of unprocessed events (requiring a restart) or null if all reconfiguration was processed successfully