Package org.apache.dubbo.metrics.service

Interface MetricsService

@SPI(value="default",
     scope=APPLICATION)
public interface MetricsService

Metrics Service. Provide an interface to get metrics from MetricsCollector

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_EXTENSION_NAME	Default MetricsService extension name.
static final String	VERSION	The contract version of MetricsService, the future update must make sure compatible.

Method Summary

Modifier and Type	Method	Description
Map<MetricsCategory,List<MetricsEntity>>	getMetricsByCategories(String serviceUniqueName, String methodName, Class<?>[] parameterTypes, List<MetricsCategory> categories)	Get metrics by interface、method and prefixes
Map<MetricsCategory,List<MetricsEntity>>	getMetricsByCategories(String serviceUniqueName, List<MetricsCategory> categories)	Get metrics by interface and prefixes
Map<MetricsCategory,List<MetricsEntity>>	getMetricsByCategories(List<MetricsCategory> categories)	Get metrics by prefixes

Field Details

DEFAULT_EXTENSION_NAME

static final String DEFAULT_EXTENSION_NAME

Default MetricsService extension name.

See Also:

• Constant Field Values

VERSION

static final String VERSION

The contract version of MetricsService, the future update must make sure compatible.

See Also:

• Constant Field Values

Method Details

getMetricsByCategories

Map<MetricsCategory,List<MetricsEntity>> getMetricsByCategories(List<MetricsCategory> categories)

Get metrics by prefixes

Parameters:

categories - categories

Returns:

metrics - key=MetricCategory value=MetricsEntityList

getMetricsByCategories

Map<MetricsCategory,List<MetricsEntity>> getMetricsByCategories(String serviceUniqueName,
 List<MetricsCategory> categories)

Get metrics by interface and prefixes

Parameters:

serviceUniqueName - serviceUniqueName (eg.group/interfaceName:version)

categories - categories

Returns:

metrics - key=MetricCategory value=MetricsEntityList

getMetricsByCategories

Map<MetricsCategory,List<MetricsEntity>> getMetricsByCategories(String serviceUniqueName,
 String methodName,
 Class<?>[] parameterTypes,
 List<MetricsCategory> categories)

Get metrics by interface、method and prefixes

Parameters:

serviceUniqueName - serviceUniqueName (eg.group/interfaceName:version)

methodName - methodName

parameterTypes - method parameter types

categories - categories

Returns:

metrics - key=MetricCategory value=MetricsEntityList