com.wavefront.internal.EntitiesInstantiator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wavefront-internal-reporter-java Show documentation
Internal reporter for reporting metrics and histograms to Wavefront
The newest version!
package com.wavefront.internal;

import java.util.function.Supplier;

import io.dropwizard.metrics5.Counter;
import io.dropwizard.metrics5.DeltaCounter;
import io.dropwizard.metrics5.Gauge;
import io.dropwizard.metrics5.Histogram;
import io.dropwizard.metrics5.Meter;
import io.dropwizard.metrics5.MetricName;
import io.dropwizard.metrics5.MetricRegistry;
import io.dropwizard.metrics5.SlidingTimeWindowArrayReservoir;
import io.dropwizard.metrics5.Timer;
import io.dropwizard.metrics5.WavefrontHistogram;

/**
 * Entities instantiator that is responsible for instantiating various entities composed of
 * metrics and histograms.
 *
 * @author Sushant Dewan ([email protected]).
 */
public interface EntitiesInstantiator {

  /**
   * Returns a new counter
   *
   * @param metricName  entity composed of name and optional point tags
   * @return Raw Counter
   */
  Counter newCounter(MetricName metricName);

  /**
   * Returns a new Wavefront DeltaCounter
   *
   * @param metricName  entity composed of name and optional point tags
   * @return Wavefront DeltaCounter
   */
  DeltaCounter newDeltaCounter(MetricName metricName);

  /**
   * Returns a new Gauge in idempotent manner.
   *
   * @param metricName  entity composed of name and optional point tags
   * @param supplier
   * @return Gauge
   */
  Gauge newGauge(MetricName metricName, MetricRegistry.MetricSupplier supplier);

  /**
   * Returns a histogram
   *
   * @param metricName  entity composed of name and optional point tags
   * @return Histogram
   */
  Histogram newHistogram(MetricName metricName);

  /**
   * Returns a new timer
   *
   * @param metricName  entity composed of name and optional point tags
   * @return Timer
   */
  Timer newTimer(MetricName metricName);

  /**
   +   * Returns a new timer
   +   *
   +   * @param metricName  entity composed of name and optional point tags
   +   * @param slidingTimeWindowArrayReservoir optional SlidingTimeWindowArrayReservoir
   +   * @return Timer
   +   */
  Timer newTimer(MetricName metricName, SlidingTimeWindowArrayReservoir slidingTimeWindowArrayReservoir);

  /**
   * Returns a new meter
   *
   * @param metricName  entity composed of name and optional point tags
   * @return Meter
   */
  Meter newMeter(MetricName metricName);

  /**
   * Returns a new WavefrontHistogram
   *
   * @param metricName  entity composed of name and optional point tags
   * @return WavefrontHistogram
   */
  WavefrontHistogram newWavefrontHistogram(MetricName metricName);

  /**
   * Returns a new WavefrontHistogram
   *
   * @param metricName  entity composed of name and optional point tags
   * @param clock       optional clock to change time manually
   * @return WavefrontHistogram
   */
  WavefrontHistogram newWavefrontHistogram(MetricName metricName, Supplier clock);
}