fish.payara.microprofile.metrics

Class MetricsService

java.lang.Object

fish.payara.microprofile.metrics.MetricsService

All Implemented Interfaces:

EventListener

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

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
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<String,org.eclipse.microprofile.metrics.Metric>	getMetricsAsMap(String registryName)
Map<String,org.eclipse.microprofile.metrics.Metric>	getMetricsAsMap(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	isInsucreMetricEnabled()
Boolean	isMetricEnabled()
Boolean	isMetricEnabled(String applicationName)
Boolean	isMetricEnabled(String applicationName, org.eclipse.microprofile.config.Config config) Checks whether metric is enabled for a given application
org.eclipse.microprofile.metrics.MetricRegistry	removeRegistry(String registryName) Remove the Metrics registry

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()

event

public void event(EventListener.Event event)

Description copied from interface: EventListener

Process a Glassfish/Payara event

Specified by:

event in interface EventListener

isMetricEnabled

public Boolean isMetricEnabled()

isMetricEnabled

public Boolean isMetricEnabled(String applicationName)

isMetricEnabled

public Boolean isMetricEnabled(String applicationName,
                               org.eclipse.microprofile.config.Config config)

Checks whether metric is enabled for a given application

Parameters:

applicationName - The application to check if metric is enabled for.

config - The application config to check for any override values

Returns:

true if metric is enabled for the given application name

isInsucreMetricEnabled

public boolean isInsucreMetricEnabled()

getMetricsAsMap

public Map<String,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

getMetricsAsMap

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

Throws:

NoSuchRegistryException

NoSuchMetricException

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