cn.shellming.metrics.api.client

接口 MetricsClient

所有已知实现类:

DefaultMetricsClient, SpringMetricsClient

public interface MetricsClient

通用埋点接口，为了隔离不同的metrics埋点实现

方法概要

限定符和类型	方法和说明
MetricCounter	counter(String metricsName, String description, SortedMap<String,String> tagMap) 注册并返回一个MetricCounter对象，累加器。
void	gauge(String metricsName, String description, SortedMap<String,String> tagMap, Callable<Double> callable) 注册一个gauge类型的埋点，瞬时值
MetricTimer	timer(String metricsName, String description, SortedMap<String,String> tagMap) 注册并返回一个MetricTimer，计时器。

方法详细资料

counter

MetricCounter counter(String metricsName,
                      String description,
                      SortedMap<String,String> tagMap)

注册并返回一个MetricCounter对象，累加器。 针对同种类型的埋点只需调用本方法一次，保存返回的counter重复使用即可。

参数:

metricsName - 埋点名

description - 埋点描述

tagMap - 定义埋点的相关标签，一般会添加到tsdb中用于区分记录

返回:

timer

MetricTimer timer(String metricsName,
                  String description,
                  SortedMap<String,String> tagMap)

注册并返回一个MetricTimer，计时器。用法建议可参考counter。

参数:

metricsName - 埋点名

description - 埋点描述

tagMap - 定义埋点的相关标签，一般会添加到tsdb中用于区分记录

返回:

gauge

void gauge(String metricsName,
           String description,
           SortedMap<String,String> tagMap,
           Callable<Double> callable)

注册一个gauge类型的埋点，瞬时值

参数:

metricsName - 埋点名

description - 埋点描述

tagMap - 定义埋点的相关标签，一般会添加到tsdb中用于区分记录

callable - 封装如何计算值的逻辑闭包