com.alibaba.metrics.annotation.EnableCompass Maven / Gradle / Ivy
package com.alibaba.metrics.annotation;
import com.alibaba.metrics.MetricLevel;
import com.alibaba.metrics.ReservoirType;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Compass类型对应的方法注解
*
* 等价执行逻辑：
* Compass.Context context = compass.time();
*
* try {
* // 执行业务逻辑
* doCreateOrder();
* // 标记该次调用是成功的
* context.success();
* } catch (Throwable t) {
* // 标记Throwable出现了1次
* context.error("exception");
* } finally {
* // 停止上下文，会自动记录当前的运行时间，和调用次数，成功次数，成功率，每个错误码的次数
* // 从而算出qps，rt的分布情况等信息，如最大rt，最小rt，平均rt，
* // 90%, 95%, 99%的rt落在哪个范围内
* context.stop();
* }
*
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface EnableCompass {
/**
* Metric的group
*
* @return
*/
String group();
/**
* MetricName中的key，请参考Metrics的命名规范进行命名
*
* @return
*/
String key();
/**
* MetricName中的tag，请参考Metrics的命名规范进行命名
*
* 注意：以该注解方式使用Metrics，只能使用静态tag，无法实现根据参数或者返回值进行区别的动态参数，请直接使用Metrics的API实现
*
* @return
*/
String tags() default "";
/**
* Metric的等级,默认为{@link MetricLevel#NORMAL},请参考Metrics的命名规范
*
* @return
*/
MetricLevel level() default MetricLevel.NORMAL;
/**
* Metrics的ReservoirType，默认为指数衰减随机采样
*
* @return
*/
ReservoirType reservoir() default ReservoirType.EXPONENTIALLY_DECAYING;
}