com.palantir.util.jmx.OperationStats Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-api Show documentation

Palantir open source project

There is a newer version: 0.1152.0

/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed 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.palantir.util.jmx;

import com.palantir.annotations.PgNotExtendableApi;
import com.palantir.annotations.PgPublicApi;

@PgPublicApi
@PgNotExtendableApi
public interface OperationStats {

    /**
     * This returns the percentage of calls that were returned in {@code millis} milliseconds.
     *
     * These are often referred to as understats u2000 is the percentage of calls finished in 2ms
     * {@code percentCallsFinishedInMillis(2000)} is also known as u2000
     *
     * @param millis the time bound we want to retrieve percentages for
     * @return the percentage of calls finishing in the specified number of milliseconds
     */
    double getPercentCallsFinishedInMillis(int millis);

    /**
     * This returns the approximate number of milliseconds for a given percentile.
     *
     * {@code getPercentileMillis(90)} is also known as tp90
     * {@code getPercentileMillis(50)} is the median
     */
    double getPercentileMillis(double perc);

    void clearStats();

    long getTotalTime();

    long getTotalCalls();

    long getTimePerCallInMillis();

    double getStandardDeviationInMillis();

    long getMaxCallTime();

    long getMinCallTime();

    double getMedianTimeRequestInMillis();
}