com.wavefront.internal.reporter.SdkReporter 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.reporter;

import java.util.concurrent.atomic.AtomicInteger;

import io.dropwizard.metrics5.MetricName;

/**
 * An interface to report metrics and histograms for your Tier3 SDK.
 *
 * @author Sushant Dewan ([email protected]).
 */
public interface SdkReporter {
  /**
   * Increment the counter metric.
   *
   * @param metricName         Name of the Counter to be reported.
   */
  void incrementCounter(MetricName metricName);

  /**
   * Increment the counter metric by {@code n}.
   *
   * @param metric            Name of the Counter to be reported.
   * @param n                 value by which to increment the counter.
   */
  void incrementCounter(MetricName metric, long n);

  /**
   * Increment the delta counter
   *
   * @param metricName         Name of the Delta Counter to be reported.
   */
  void incrementDeltaCounter(MetricName metricName);

  /**
   * Update the histogram metric with the input latency.
   *
   * @param metricName         Name of the histogram to be reported.
   * @param latencyMillis      API latency in millis.
   */
  void updateHistogram(MetricName metricName, long latencyMillis);

  /**
   * Register Integer Gauge so that it is reported to Wavefront.
   *
   * @param metricName         Name of the gauge to be reported.
   * @param value              Value of the gauge.
   */
  void registerGauge(MetricName metricName, AtomicInteger value);

  /**
   * Start the reporter.
   */
  void start();

  /**
   * Stop the reporter.
   */
  void stop();
}