org.elasticsearch.common.network.HandlingTimeTracker Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation

Elasticsearch subproject :server

There is a newer version: 8.13.4

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.common.network;

import java.util.concurrent.atomic.LongAdder;

/**
 * Tracks how long message handling takes on a transport thread as a histogram with fixed buckets.
 */
public class HandlingTimeTracker {

    public static int[] getBucketUpperBounds() {
        int[] bounds = new int[17];
        for (int i = 0; i < bounds.length; i++) {
            bounds[i] = 1 << i;
        }
        return bounds;
    }

    private static int getBucket(long handlingTimeMillis) {
        if (handlingTimeMillis <= 0) {
            return 0;
        } else if (LAST_BUCKET_LOWER_BOUND <= handlingTimeMillis) {
            return BUCKET_COUNT - 1;
        } else {
            return Long.SIZE - Long.numberOfLeadingZeros(handlingTimeMillis);
        }
    }

    public static final int BUCKET_COUNT = getBucketUpperBounds().length + 1;

    private static final long LAST_BUCKET_LOWER_BOUND = getBucketUpperBounds()[BUCKET_COUNT - 2];

    private final LongAdder[] buckets;

    public HandlingTimeTracker() {
        buckets = new LongAdder[BUCKET_COUNT];
        for (int i = 0; i < BUCKET_COUNT; i++) {
            buckets[i] = new LongAdder();
        }
    }

    public void addHandlingTime(long handlingTimeMillis) {
        buckets[getBucket(handlingTimeMillis)].increment();
    }

    /**
     * @return An array of frequencies of handling times in buckets with upper bounds as returned by {@link #getBucketUpperBounds()}, plus
     *         an extra bucket for handling times longer than the longest upper bound.
     */
    public long[] getHistogram() {
        final long[] histogram = new long[BUCKET_COUNT];
        for (int i = 0; i < BUCKET_COUNT; i++) {
            histogram[i] = buckets[i].longValue();
        }
        return histogram;
    }

}