com.alibaba.metrics.FastCompass Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.alibaba.metrics;

import java.util.Map;

/**
 * 用于在高吞吐率环境下，快速统计方法的qps，rt，成功率和错误码。
 * 保证最多只进行一次 com.alibaba.metrics.LongAdder#add() 计数操作
 * 典型的应用场景，中间件的tair客户端
 */
public interface FastCompass extends Metric {

    /**
     * 记录一次方法调用的RT和子类别，子类别应当是正交的，不能有重叠
     * 例如 成功/失败
     * record a method invocation with execution time and sub-categories
     * @param duration must be milliseconds
     * @param subCategory all the sub-categories should be orthogonal,
     *                    which will be added up to the total number of method invocations
     */
    void record(long duration, String subCategory);

    /**
     * 对于每个子类别，返回每个统计间隔的方法调用总次数
     * return method count per bucket per category
     * @return
     */
    Map> getMethodCountPerCategory();


    /**
     * 对于每个子类别，返回每个统计间隔的方法调用总次数
     * return method count per bucket per category
     * @return
     */
    Map> getMethodCountPerCategory(long startTime);

    /**
     * 对于每个子类别，返回每个统计间隔的方法执行总时间
     * return method execution time per bucket per category
     * @return
     */
    Map> getMethodRtPerCategory();

    /**
     * 对于每个子类别，返回每个统计间隔的方法执行总时间
     * return method execution time per bucket per category
     * @return
     */
    Map> getMethodRtPerCategory(long startTime);

    /**
     * 对于每个子类别，返回每个统计间隔的执行总时间和次数，按位分离操作放到下一层进行
     * return method execution time and count per bucket per category
     * @return
     */
    Map> getCountAndRtPerCategory();

    /**
     * 对于每个子类别，返回每个统计间隔的执行总时间和次数，按位分离操作放到下一层进行
     * return method execution time and count per bucket per category
     * @return
     */
    Map> getCountAndRtPerCategory(long startTime);

    /**
     * 获取统计间隔
     * @return the bucket interval
     */
    int getBucketInterval();
}