org.smallmind.claxon.registry.meter.Histogram Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of claxon-registry Show documentation
Code Instrumentation Framework
The newest version!
/*
 * Copyright (c) 2007 through 2024 David Berkman
 *
 * This file is part of the SmallMind Code Project.
 *
 * The SmallMind Code Project is free software, you can redistribute
 * it and/or modify it under either, at your discretion...
 *
 * 1) The terms of GNU Affero General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 *
 * ...or...
 *
 * 2) The terms of the Apache License, Version 2.0.
 *
 * The SmallMind Code Project is distributed in the hope that it will
 * be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License or Apache License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * and the Apache License along with the SmallMind Code Project. If not, see
 *  or .
 *
 * Additional permission under the GNU Affero GPL version 3 section 7
 * ------------------------------------------------------------------
 * If you modify this Program, or any covered work, by linking or
 * combining it with other code, such other code is not for that reason
 * alone subject to any of the requirements of the GNU Affero GPL
 * version 3.
 */
package org.smallmind.claxon.registry.meter;

import org.smallmind.claxon.registry.Clock;
import org.smallmind.claxon.registry.Percentile;
import org.smallmind.claxon.registry.Quantity;
import org.smallmind.claxon.registry.QuantityType;
import org.smallmind.claxon.registry.aggregate.HistogramTime;
import org.smallmind.claxon.registry.aggregate.Stratified;
import org.smallmind.nutsnbolts.time.Stint;

public class Histogram implements Meter {

  private final Stratified stratified;
  private final Percentile[] percentiles;

  public Histogram (Clock clock, long lowestDiscernibleValue, long highestTrackableValue, int numberOfSignificantValueDigits, Stint resolutionStint, Percentile... percentiles) {

    this.percentiles = percentiles;

    stratified = new Stratified(clock, lowestDiscernibleValue, highestTrackableValue, numberOfSignificantValueDigits, resolutionStint);
  }

  @Override
  public void update (long value) {

    stratified.update(value);
  }

  @Override
  public Quantity[] record () {

    HistogramTime snapshot = stratified.get();
    Quantity[] basicQuantities = new Quantity[] {
      new Quantity("count", snapshot.getHistogram().getTotalCount(), QuantityType.COUNT),
      new Quantity("rate", snapshot.getHistogram().getTotalCount() * snapshot.getTimeFactor()),
      new Quantity("minimum", snapshot.getHistogram().getMinValue()),
      new Quantity("maximum", snapshot.getHistogram().getMaxValue()),
      new Quantity("mean", snapshot.getHistogram().getMean())};
    Quantity[] allQuantities = new Quantity[basicQuantities.length + ((percentiles == null) ? 0 : percentiles.length)];
    int index = 0;

    System.arraycopy(basicQuantities, 0, allQuantities, 0, basicQuantities.length);
    if ((percentiles != null) && (percentiles.length > 0)) {
      for (Percentile percentile : percentiles) {
        allQuantities[basicQuantities.length + (index++)] = new Quantity(percentile.getName(), snapshot.getHistogram().getValueAtPercentile(percentile.getValue()));
      }
    }

    return allQuantities;
  }
}